From e3dfeb5260a6916fd92f416297f7b6d4a8e25803 Mon Sep 17 00:00:00 2001 From: awssdkgo Date: Wed, 1 Dec 2021 23:48:57 +0000 Subject: [PATCH] Release v1.42.17 (2021-12-01) === ### Service Client Updates * `service/devops-guru`: Updates service API, documentation, and paginators * `service/directconnect`: Updates service API and documentation * Adds SiteLink support to private and transit virtual interfaces. SiteLink is a new Direct Connect feature that allows routing between Direct Connect points of presence. * `service/dynamodb`: Updates service API, documentation, waiters, paginators, and examples * Add support for Table Classes and introduce the Standard Infrequent Access table class. * `service/ec2`: Updates service API, documentation, and paginators * This release adds support for Amazon VPC IP Address Manager (IPAM), which enables you to plan, track, and monitor IP addresses for your workloads. This release also adds support for VPC Network Access Analyzer, which enables you to analyze network access to resources in your Virtual Private Clouds. * `service/kendra`: Updates service API, documentation, and paginators * Experience Builder allows customers to build search applications without writing code. Analytics Dashboard provides quality and usability metrics for Kendra indexes. Custom Document Enrichment allows customers to build a custom ingestion pipeline to pre-process documents and generate metadata. * `service/models.lex.v2`: Updates service API, documentation, and paginators * `service/runtime.sagemaker`: Updates service API and documentation * `service/sagemaker`: Updates service API, documentation, and paginators * This release enables - 1/ Inference endpoint configuration recommendations and ability to run custom load tests to meet performance needs. 2/ Deploy serverless inference endpoints. 3/ Query, filter and retrieve end-to-end ML lineage graph, and incorporate model quality/bias detection in ML workflow. * `service/shield`: Updates service API and documentation * This release adds API support for Automatic Application Layer DDoS Mitigation for AWS Shield Advanced. Customers can now enable automatic DDoS mitigation in count or block mode for layer 7 protected resources. --- CHANGELOG.md | 20 + aws/endpoints/defaults.go | 13 + aws/version.go | 2 +- models/apis/devops-guru/2020-12-01/api-2.json | 283 +- .../apis/devops-guru/2020-12-01/docs-2.json | 369 +- .../devops-guru/2020-12-01/paginators-1.json | 6 +- .../apis/directconnect/2012-10-25/api-2.json | 15 +- .../apis/directconnect/2012-10-25/docs-2.json | 17 +- models/apis/dynamodb/2012-08-10/api-2.json | 38 +- models/apis/dynamodb/2012-08-10/docs-2.json | 20 + models/apis/ec2/2016-11-15/api-2.json | 2254 ++- models/apis/ec2/2016-11-15/docs-2.json | 1251 +- models/apis/ec2/2016-11-15/paginators-1.json | 54 + models/apis/kendra/2019-02-03/api-2.json | 810 +- models/apis/kendra/2019-02-03/docs-2.json | 585 +- .../apis/kendra/2019-02-03/paginators-1.json | 14 + .../apis/models.lex.v2/2020-08-07/api-2.json | 583 +- .../apis/models.lex.v2/2020-08-07/docs-2.json | 340 +- .../2020-08-07/paginators-1.json | 10 + .../runtime.sagemaker/2017-05-13/api-2.json | 23 +- .../runtime.sagemaker/2017-05-13/docs-2.json | 22 +- models/apis/sagemaker/2017-07-24/api-2.json | 957 +- models/apis/sagemaker/2017-07-24/docs-2.json | 766 +- .../sagemaker/2017-07-24/paginators-1.json | 23 + models/apis/shield/2016-06-02/api-2.json | 143 +- models/apis/shield/2016-06-02/docs-2.json | 148 +- models/endpoints/endpoints.json | 7 + service/devopsguru/api.go | 1917 +- service/directconnect/api.go | 56 +- service/dynamodb/api.go | 133 + service/ec2/api.go | 10243 +++++++++- service/ec2/ec2iface/interface.go | 171 + service/kendra/api.go | 15618 ++++++++++------ service/kendra/errors.go | 7 + service/kendra/kendraiface/interface.go | 61 +- service/lexmodelsv2/api.go | 3563 +++- .../lexmodelsv2/lexmodelsv2iface/interface.go | 30 + service/sagemaker/api.go | 5333 +++++- service/sagemaker/sagemakeriface/interface.go | 48 + service/sagemakerruntime/api.go | 164 +- service/sagemakerruntime/errors.go | 25 +- service/shield/api.go | 1110 +- service/shield/errors.go | 3 +- service/shield/shieldiface/interface.go | 12 + 44 files changed, 40667 insertions(+), 6600 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2dd12178c6d..c76ce08b3af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,23 @@ +Release v1.42.17 (2021-12-01) +=== + +### Service Client Updates +* `service/devops-guru`: Updates service API, documentation, and paginators +* `service/directconnect`: Updates service API and documentation + * Adds SiteLink support to private and transit virtual interfaces. SiteLink is a new Direct Connect feature that allows routing between Direct Connect points of presence. +* `service/dynamodb`: Updates service API, documentation, waiters, paginators, and examples + * Add support for Table Classes and introduce the Standard Infrequent Access table class. +* `service/ec2`: Updates service API, documentation, and paginators + * This release adds support for Amazon VPC IP Address Manager (IPAM), which enables you to plan, track, and monitor IP addresses for your workloads. This release also adds support for VPC Network Access Analyzer, which enables you to analyze network access to resources in your Virtual Private Clouds. +* `service/kendra`: Updates service API, documentation, and paginators + * Experience Builder allows customers to build search applications without writing code. Analytics Dashboard provides quality and usability metrics for Kendra indexes. Custom Document Enrichment allows customers to build a custom ingestion pipeline to pre-process documents and generate metadata. +* `service/models.lex.v2`: Updates service API, documentation, and paginators +* `service/runtime.sagemaker`: Updates service API and documentation +* `service/sagemaker`: Updates service API, documentation, and paginators + * This release enables - 1/ Inference endpoint configuration recommendations and ability to run custom load tests to meet performance needs. 2/ Deploy serverless inference endpoints. 3/ Query, filter and retrieve end-to-end ML lineage graph, and incorporate model quality/bias detection in ML workflow. +* `service/shield`: Updates service API and documentation + * This release adds API support for Automatic Application Layer DDoS Mitigation for AWS Shield Advanced. Customers can now enable automatic DDoS mitigation in count or block mode for layer 7 protected resources. + Release v1.42.16 (2021-11-30) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index d8be7b641bd..64435c7bddb 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -21031,6 +21031,19 @@ var awsPartition = partition{ }, }, }, + "workspaces-web": service{ + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "eu-west-1", + }: endpoint{}, + endpointKey{ + Region: "us-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-west-2", + }: endpoint{}, + }, + }, "xray": service{ Endpoints: serviceEndpoints{ endpointKey{ diff --git a/aws/version.go b/aws/version.go index bac037f1b7c..47e3c8066da 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.42.16" +const SDKVersion = "1.42.17" diff --git a/models/apis/devops-guru/2020-12-01/api-2.json b/models/apis/devops-guru/2020-12-01/api-2.json index 9c90819cf6b..628ffd05b14 100644 --- a/models/apis/devops-guru/2020-12-01/api-2.json +++ b/models/apis/devops-guru/2020-12-01/api-2.json @@ -150,7 +150,7 @@ "name":"DescribeOrganizationResourceCollectionHealth", "http":{ "method":"POST", - "requestUri":"/organization/health/resource-collection/", + "requestUri":"/organization/health/resource-collection", "responseCode":200 }, "input":{"shape":"DescribeOrganizationResourceCollectionHealthRequest"}, @@ -496,16 +496,18 @@ "Id":{"shape":"NotificationChannelId"} } }, + "AnomalyDescription":{"type":"string"}, "AnomalyId":{ "type":"string", "max":100, "min":1, - "pattern":"^[\\w-]*$" + "pattern":"^[\\w~.-]*$" }, "AnomalyLimit":{ "type":"double", "box":true }, + "AnomalyName":{"type":"string"}, "AnomalyReportedTimeRange":{ "type":"structure", "required":["OpenTime"], @@ -514,6 +516,17 @@ "CloseTime":{"shape":"Timestamp"} } }, + "AnomalyResource":{ + "type":"structure", + "members":{ + "Name":{"shape":"ResourceName"}, + "Type":{"shape":"ResourceType"} + } + }, + "AnomalyResources":{ + "type":"list", + "member":{"shape":"AnomalyResource"} + }, "AnomalySeverity":{ "type":"string", "enum":[ @@ -525,7 +538,8 @@ "AnomalySourceDetails":{ "type":"structure", "members":{ - "CloudWatchMetrics":{"shape":"CloudWatchMetricsDetails"} + "CloudWatchMetrics":{"shape":"CloudWatchMetricsDetails"}, + "PerformanceInsightsMetrics":{"shape":"PerformanceInsightsMetricsDetails"} } }, "AnomalyStatus":{ @@ -543,6 +557,23 @@ "EndTime":{"shape":"Timestamp"} } }, + "AnomalyType":{ + "type":"string", + "enum":[ + "CAUSAL", + "CONTEXTUAL" + ] + }, + "AppBoundaryKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "AssociatedResourceArns":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, "AwsAccountId":{ "type":"string", "max":12, @@ -668,7 +699,8 @@ "CostEstimationResourceCollectionFilter":{ "type":"structure", "members":{ - "CloudFormation":{"shape":"CloudFormationCostEstimationResourceCollectionFilter"} + "CloudFormation":{"shape":"CloudFormationCostEstimationResourceCollectionFilter"}, + "Tags":{"shape":"TagCostEstimationResourceCollectionFilters"} } }, "CostEstimationServiceResourceCount":{"type":"integer"}, @@ -692,6 +724,12 @@ "COMPLETED" ] }, + "CostEstimationTagValues":{ + "type":"list", + "member":{"shape":"TagValue"}, + "max":1, + "min":1 + }, "CostEstimationTimeRange":{ "type":"structure", "members":{ @@ -879,11 +917,11 @@ }, "DescribeResourceCollectionHealthResponse":{ "type":"structure", - "required":["CloudFormation"], "members":{ "CloudFormation":{"shape":"CloudFormationHealths"}, "Service":{"shape":"ServiceHealths"}, - "NextToken":{"shape":"UuidNextToken"} + "NextToken":{"shape":"UuidNextToken"}, + "Tags":{"shape":"TagHealths"} } }, "DescribeServiceIntegrationRequest":{ @@ -1401,6 +1439,106 @@ "max":5, "min":0 }, + "PerformanceInsightsMetricDimension":{"type":"string"}, + "PerformanceInsightsMetricDimensionGroup":{ + "type":"structure", + "members":{ + "Group":{"shape":"PerformanceInsightsMetricGroup"}, + "Dimensions":{"shape":"PerformanceInsightsMetricDimensions"}, + "Limit":{"shape":"PerformanceInsightsMetricLimitInteger"} + } + }, + "PerformanceInsightsMetricDimensions":{ + "type":"list", + "member":{"shape":"PerformanceInsightsMetricDimension"} + }, + "PerformanceInsightsMetricDisplayName":{"type":"string"}, + "PerformanceInsightsMetricFilterKey":{"type":"string"}, + "PerformanceInsightsMetricFilterMap":{ + "type":"map", + "key":{"shape":"PerformanceInsightsMetricFilterKey"}, + "value":{"shape":"PerformanceInsightsMetricFilterValue"} + }, + "PerformanceInsightsMetricFilterValue":{"type":"string"}, + "PerformanceInsightsMetricGroup":{"type":"string"}, + "PerformanceInsightsMetricLimitInteger":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "PerformanceInsightsMetricName":{"type":"string"}, + "PerformanceInsightsMetricQuery":{ + "type":"structure", + "members":{ + "Metric":{"shape":"PerformanceInsightsMetricName"}, + "GroupBy":{"shape":"PerformanceInsightsMetricDimensionGroup"}, + "Filter":{"shape":"PerformanceInsightsMetricFilterMap"} + } + }, + "PerformanceInsightsMetricUnit":{"type":"string"}, + "PerformanceInsightsMetricsDetail":{ + "type":"structure", + "members":{ + "MetricDisplayName":{"shape":"PerformanceInsightsMetricDisplayName"}, + "Unit":{"shape":"PerformanceInsightsMetricUnit"}, + "MetricQuery":{"shape":"PerformanceInsightsMetricQuery"}, + "ReferenceData":{"shape":"PerformanceInsightsReferenceDataList"}, + "StatsAtAnomaly":{"shape":"PerformanceInsightsStats"}, + "StatsAtBaseline":{"shape":"PerformanceInsightsStats"} + } + }, + "PerformanceInsightsMetricsDetails":{ + "type":"list", + "member":{"shape":"PerformanceInsightsMetricsDetail"} + }, + "PerformanceInsightsReferenceComparisonValues":{ + "type":"structure", + "members":{ + "ReferenceScalar":{"shape":"PerformanceInsightsReferenceScalar"}, + "ReferenceMetric":{"shape":"PerformanceInsightsReferenceMetric"} + } + }, + "PerformanceInsightsReferenceData":{ + "type":"structure", + "members":{ + "Name":{"shape":"PerformanceInsightsReferenceName"}, + "ComparisonValues":{"shape":"PerformanceInsightsReferenceComparisonValues"} + } + }, + "PerformanceInsightsReferenceDataList":{ + "type":"list", + "member":{"shape":"PerformanceInsightsReferenceData"} + }, + "PerformanceInsightsReferenceMetric":{ + "type":"structure", + "members":{ + "MetricQuery":{"shape":"PerformanceInsightsMetricQuery"} + } + }, + "PerformanceInsightsReferenceName":{"type":"string"}, + "PerformanceInsightsReferenceScalar":{ + "type":"structure", + "members":{ + "Value":{"shape":"PerformanceInsightsValueDouble"} + } + }, + "PerformanceInsightsStat":{ + "type":"structure", + "members":{ + "Type":{"shape":"PerformanceInsightsStatType"}, + "Value":{"shape":"PerformanceInsightsValueDouble"} + } + }, + "PerformanceInsightsStatType":{"type":"string"}, + "PerformanceInsightsStats":{ + "type":"list", + "member":{"shape":"PerformanceInsightsStat"} + }, + "PerformanceInsightsValueDouble":{ + "type":"double", + "box":true + }, "PredictionTimeRange":{ "type":"structure", "required":["StartTime"], @@ -1468,7 +1606,8 @@ "InsightTimeRange":{"shape":"InsightTimeRange"}, "PredictionTimeRange":{"shape":"PredictionTimeRange"}, "ResourceCollection":{"shape":"ResourceCollection"}, - "ServiceCollection":{"shape":"ServiceCollection"} + "ServiceCollection":{"shape":"ServiceCollection"}, + "AssociatedResourceArns":{"shape":"AssociatedResourceArns"} } }, "ProactiveInsights":{ @@ -1519,7 +1658,12 @@ "AnomalyReportedTimeRange":{"shape":"AnomalyReportedTimeRange"}, "SourceDetails":{"shape":"AnomalySourceDetails"}, "AssociatedInsightId":{"shape":"InsightId"}, - "ResourceCollection":{"shape":"ResourceCollection"} + "ResourceCollection":{"shape":"ResourceCollection"}, + "Type":{"shape":"AnomalyType"}, + "Name":{"shape":"AnomalyName"}, + "Description":{"shape":"AnomalyDescription"}, + "CausalAnomalyId":{"shape":"AnomalyId"}, + "AnomalyResources":{"shape":"AnomalyResources"} } }, "ReactiveAnomalySummary":{ @@ -1532,7 +1676,12 @@ "AnomalyReportedTimeRange":{"shape":"AnomalyReportedTimeRange"}, "SourceDetails":{"shape":"AnomalySourceDetails"}, "AssociatedInsightId":{"shape":"InsightId"}, - "ResourceCollection":{"shape":"ResourceCollection"} + "ResourceCollection":{"shape":"ResourceCollection"}, + "Type":{"shape":"AnomalyType"}, + "Name":{"shape":"AnomalyName"}, + "Description":{"shape":"AnomalyDescription"}, + "CausalAnomalyId":{"shape":"AnomalyId"}, + "AnomalyResources":{"shape":"AnomalyResources"} } }, "ReactiveInsight":{ @@ -1556,7 +1705,8 @@ "Status":{"shape":"InsightStatus"}, "InsightTimeRange":{"shape":"InsightTimeRange"}, "ResourceCollection":{"shape":"ResourceCollection"}, - "ServiceCollection":{"shape":"ServiceCollection"} + "ServiceCollection":{"shape":"ServiceCollection"}, + "AssociatedResourceArns":{"shape":"AssociatedResourceArns"} } }, "ReactiveInsights":{ @@ -1604,7 +1754,8 @@ "type":"structure", "members":{ "Resources":{"shape":"RecommendationRelatedAnomalyResources"}, - "SourceDetails":{"shape":"RelatedAnomalySourceDetails"} + "SourceDetails":{"shape":"RelatedAnomalySourceDetails"}, + "AnomalyId":{"shape":"AnomalyId"} } }, "RecommendationRelatedAnomalyResource":{ @@ -1690,28 +1841,37 @@ "members":{ } }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":20 + }, "ResourceCollection":{ "type":"structure", "members":{ - "CloudFormation":{"shape":"CloudFormationCollection"} + "CloudFormation":{"shape":"CloudFormationCollection"}, + "Tags":{"shape":"TagCollections"} } }, "ResourceCollectionFilter":{ "type":"structure", "members":{ - "CloudFormation":{"shape":"CloudFormationCollectionFilter"} + "CloudFormation":{"shape":"CloudFormationCollectionFilter"}, + "Tags":{"shape":"TagCollectionFilters"} } }, "ResourceCollectionType":{ "type":"string", "enum":[ "AWS_CLOUD_FORMATION", - "AWS_SERVICE" + "AWS_SERVICE", + "AWS_TAGS" ] }, "ResourceHours":{"type":"long"}, "ResourceIdString":{"type":"string"}, "ResourceIdType":{"type":"string"}, + "ResourceName":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -1945,6 +2105,73 @@ "ToTime":{"shape":"Timestamp"} } }, + "TagCollection":{ + "type":"structure", + "required":[ + "AppBoundaryKey", + "TagValues" + ], + "members":{ + "AppBoundaryKey":{"shape":"AppBoundaryKey"}, + "TagValues":{"shape":"TagValues"} + } + }, + "TagCollectionFilter":{ + "type":"structure", + "required":[ + "AppBoundaryKey", + "TagValues" + ], + "members":{ + "AppBoundaryKey":{"shape":"AppBoundaryKey"}, + "TagValues":{"shape":"TagValues"} + } + }, + "TagCollectionFilters":{ + "type":"list", + "member":{"shape":"TagCollectionFilter"} + }, + "TagCollections":{ + "type":"list", + "member":{"shape":"TagCollection"} + }, + "TagCostEstimationResourceCollectionFilter":{ + "type":"structure", + "required":[ + "AppBoundaryKey", + "TagValues" + ], + "members":{ + "AppBoundaryKey":{"shape":"AppBoundaryKey"}, + "TagValues":{"shape":"CostEstimationTagValues"} + } + }, + "TagCostEstimationResourceCollectionFilters":{ + "type":"list", + "member":{"shape":"TagCostEstimationResourceCollectionFilter"} + }, + "TagHealth":{ + "type":"structure", + "members":{ + "AppBoundaryKey":{"shape":"AppBoundaryKey"}, + "TagValue":{"shape":"TagValue"}, + "Insight":{"shape":"InsightHealth"} + } + }, + "TagHealths":{ + "type":"list", + "member":{"shape":"TagHealth"} + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*|\\*)$" + }, + "TagValues":{ + "type":"list", + "member":{"shape":"TagValue"} + }, "ThrottlingException":{ "type":"structure", "required":["Message"], @@ -1995,7 +2222,8 @@ "UpdateResourceCollectionFilter":{ "type":"structure", "members":{ - "CloudFormation":{"shape":"UpdateCloudFormationCollectionFilter"} + "CloudFormation":{"shape":"UpdateCloudFormationCollectionFilter"}, + "Tags":{"shape":"UpdateTagCollectionFilters"} } }, "UpdateResourceCollectionRequest":{ @@ -2038,6 +2266,27 @@ "max":100, "min":0 }, + "UpdateTagCollectionFilter":{ + "type":"structure", + "required":[ + "AppBoundaryKey", + "TagValues" + ], + "members":{ + "AppBoundaryKey":{"shape":"AppBoundaryKey"}, + "TagValues":{"shape":"UpdateTagValues"} + } + }, + "UpdateTagCollectionFilters":{ + "type":"list", + "member":{"shape":"UpdateTagCollectionFilter"} + }, + "UpdateTagValues":{ + "type":"list", + "member":{"shape":"TagValue"}, + "max":100, + "min":0 + }, "UuidNextToken":{ "type":"string", "max":36, @@ -2076,7 +2325,9 @@ "UNKNOWN_OPERATION", "CANNOT_PARSE", "FIELD_VALIDATION_FAILED", - "OTHER" + "OTHER", + "INVALID_PARAMETER_COMBINATION", + "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE" ] } } diff --git a/models/apis/devops-guru/2020-12-01/docs-2.json b/models/apis/devops-guru/2020-12-01/docs-2.json index c1f97735a74..06742e53dd7 100644 --- a/models/apis/devops-guru/2020-12-01/docs-2.json +++ b/models/apis/devops-guru/2020-12-01/docs-2.json @@ -11,10 +11,10 @@ "DescribeOrganizationHealth": "

Returns active insights, predictive insights, and resource hours analyzed in last hour.

", "DescribeOrganizationOverview": "

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

", "DescribeOrganizationResourceCollectionHealth": "

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

", - "DescribeResourceCollectionHealth": "

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", + "DescribeResourceCollectionHealth": "

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "DescribeServiceIntegration": "

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

", "GetCostEstimation": "

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

", - "GetResourceCollection": "

Returns lists Amazon Web Services resources that are of the specified resource collection type. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", + "GetResourceCollection": "

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "ListAnomaliesForInsight": "

Returns a list of the anomalies that belong to an insight that you specify using its ID.

", "ListEvents": "

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

", "ListInsights": "

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

", @@ -26,7 +26,7 @@ "SearchInsights": "

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

", "SearchOrganizationInsights": "

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

", "StartCostEstimation": "

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.

", - "UpdateResourceCollection": "

Updates the collection of resources that DevOps Guru analyzes. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

", + "UpdateResourceCollection": "

Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

", "UpdateServiceIntegration": "

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

" }, "shapes": { @@ -71,6 +71,13 @@ "refs": { } }, + "AnomalyDescription": { + "base": null, + "refs": { + "ReactiveAnomaly$Description": "

A description of the reactive anomaly.

", + "ReactiveAnomalySummary$Description": "

A description of the reactive anomaly.

" + } + }, "AnomalyId": { "base": null, "refs": { @@ -78,7 +85,10 @@ "ProactiveAnomaly$Id": "

The ID of a proactive anomaly.

", "ProactiveAnomalySummary$Id": "

The ID of the anomaly.

", "ReactiveAnomaly$Id": "

The ID of the reactive anomaly.

", - "ReactiveAnomalySummary$Id": "

The ID of the reactive anomaly.

" + "ReactiveAnomaly$CausalAnomalyId": "

The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.

", + "ReactiveAnomalySummary$Id": "

The ID of the reactive anomaly.

", + "ReactiveAnomalySummary$CausalAnomalyId": "

The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.

", + "RecommendationRelatedAnomaly$AnomalyId": "

The ID of an anomaly that generated the insight with this recommendation.

" } }, "AnomalyLimit": { @@ -88,26 +98,46 @@ "ProactiveAnomalySummary$Limit": "

A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.

" } }, + "AnomalyName": { + "base": null, + "refs": { + "ReactiveAnomaly$Name": "

The name of the reactive anomaly.

", + "ReactiveAnomalySummary$Name": "

The name of the reactive anomaly.

" + } + }, "AnomalyReportedTimeRange": { "base": "

A time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from AnomalyTimeRange, which specifies the time range when DevOps Guru actually observes the anomalous behavior.

", "refs": { - "ProactiveAnomaly$AnomalyReportedTimeRange": "

A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", - "ProactiveAnomalySummary$AnomalyReportedTimeRange": "

A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", - "ReactiveAnomaly$AnomalyReportedTimeRange": "

A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", - "ReactiveAnomalySummary$AnomalyReportedTimeRange": "

A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

" + "ProactiveAnomaly$AnomalyReportedTimeRange": "

An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", + "ProactiveAnomalySummary$AnomalyReportedTimeRange": "

An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", + "ReactiveAnomaly$AnomalyReportedTimeRange": "

An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

", + "ReactiveAnomalySummary$AnomalyReportedTimeRange": "

An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

" + } + }, + "AnomalyResource": { + "base": "

The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.

", + "refs": { + "AnomalyResources$member": null + } + }, + "AnomalyResources": { + "base": null, + "refs": { + "ReactiveAnomaly$AnomalyResources": "

The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.

", + "ReactiveAnomalySummary$AnomalyResources": "

The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.

" } }, "AnomalySeverity": { "base": null, "refs": { - "ProactiveAnomaly$Severity": "

The severity of a proactive anomaly.

", - "ProactiveAnomalySummary$Severity": "

The severity of the anomaly.

", - "ReactiveAnomaly$Severity": "

The severity of the anomaly.

", - "ReactiveAnomalySummary$Severity": "

The severity of the reactive anomaly.

" + "ProactiveAnomaly$Severity": "

The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ProactiveAnomalySummary$Severity": "

The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ReactiveAnomaly$Severity": "

The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ReactiveAnomalySummary$Severity": "

The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

" } }, "AnomalySourceDetails": { - "base": "

Details about the source of the anomalous operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

", + "base": "

Details about the source of the anomalous operational data that triggered the anomaly.

", "refs": { "ProactiveAnomaly$SourceDetails": "

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

", "ProactiveAnomalySummary$SourceDetails": "

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

", @@ -133,6 +163,30 @@ "ReactiveAnomalySummary$AnomalyTimeRange": null } }, + "AnomalyType": { + "base": null, + "refs": { + "ReactiveAnomaly$Type": "

The type of the reactive anomaly. It can be one of the following types.

", + "ReactiveAnomalySummary$Type": "

The type of the reactive anomaly. It can be one of the following types.

" + } + }, + "AppBoundaryKey": { + "base": null, + "refs": { + "TagCollection$AppBoundaryKey": "

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

", + "TagCollectionFilter$AppBoundaryKey": "

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

", + "TagCostEstimationResourceCollectionFilter$AppBoundaryKey": "

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

", + "TagHealth$AppBoundaryKey": "

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

", + "UpdateTagCollectionFilter$AppBoundaryKey": "

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "AssociatedResourceArns": { + "base": null, + "refs": { + "ProactiveInsightSummary$AssociatedResourceArns": "

The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.

", + "ReactiveInsightSummary$AssociatedResourceArns": "

The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.

" + } + }, "AwsAccountId": { "base": null, "refs": { @@ -145,7 +199,7 @@ "ListInsightsAccountIdList$member": null, "ListRecommendationsRequest$AccountId": "

The ID of the Amazon Web Services account.

", "ProactiveOrganizationInsightSummary$AccountId": "

The ID of the Amazon Web Services account.

", - "ReactiveOrganizationInsightSummary$AccountId": "

The ID of the Amazon Web Services account.

", + "ReactiveOrganizationInsightSummary$AccountId": "

The ID of the Amazon Web Services account.

", "SearchInsightsAccountIdList$member": null } }, @@ -195,7 +249,7 @@ "CloudWatchMetricDataStatusCode": { "base": null, "refs": { - "CloudWatchMetricsDataSummary$StatusCode": "

This is enum of the status showing whether the metric value pair list has Partial or Complete data or there was an error.

" + "CloudWatchMetricsDataSummary$StatusCode": "

This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.

" } }, "CloudWatchMetricsDataSummary": { @@ -213,11 +267,11 @@ "CloudWatchMetricsDetails": { "base": null, "refs": { - "AnomalySourceDetails$CloudWatchMetrics": "

An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

" + "AnomalySourceDetails$CloudWatchMetrics": "

An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.

" } }, "CloudWatchMetricsDimension": { - "base": "

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.

", + "base": "

The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.

", "refs": { "CloudWatchMetricsDimensions$member": null } @@ -314,6 +368,12 @@ "GetCostEstimationResponse$Status": "

The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.

" } }, + "CostEstimationTagValues": { + "base": null, + "refs": { + "TagCostEstimationResourceCollectionFilter$TagValues": "

The values in an Amazon Web Services tag collection.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

" + } + }, "CostEstimationTimeRange": { "base": "

The time range of a cost estimation.

", "refs": { @@ -574,7 +634,8 @@ "InsightHealth": { "base": "

Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.

", "refs": { - "CloudFormationHealth$Insight": "

Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

" + "CloudFormationHealth$Insight": "

Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

", + "TagHealth$Insight": "

Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

" } }, "InsightId": { @@ -620,12 +681,12 @@ "base": null, "refs": { "InsightSeverities$member": null, - "ProactiveInsight$Severity": "

The severity of the proactive insight.

", - "ProactiveInsightSummary$Severity": "

The severity of the proactive insight.

", - "ProactiveOrganizationInsightSummary$Severity": "

An array of severity values used to search for insights.

", - "ReactiveInsight$Severity": "

The severity of a reactive insight.

", - "ReactiveInsightSummary$Severity": "

The severity of a reactive insight.

", - "ReactiveOrganizationInsightSummary$Severity": "

An array of severity values used to search for insights.

" + "ProactiveInsight$Severity": "

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ProactiveInsightSummary$Severity": "

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ProactiveOrganizationInsightSummary$Severity": "

An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ReactiveInsight$Severity": "

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ReactiveInsightSummary$Severity": "

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

", + "ReactiveOrganizationInsightSummary$Severity": "

An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

" } }, "InsightStatus": { @@ -904,7 +965,7 @@ "OrganizationResourceCollectionType": { "base": null, "refs": { - "DescribeOrganizationResourceCollectionHealthRequest$OrganizationResourceCollectionType": "

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" + "DescribeOrganizationResourceCollectionHealthRequest$OrganizationResourceCollectionType": "

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "OrganizationalUnitId": { @@ -924,6 +985,153 @@ "DescribeOrganizationResourceCollectionHealthRequest$OrganizationalUnitIds": "

The ID of the organizational unit.

" } }, + "PerformanceInsightsMetricDimension": { + "base": null, + "refs": { + "PerformanceInsightsMetricDimensions$member": null + } + }, + "PerformanceInsightsMetricDimensionGroup": { + "base": "

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

", + "refs": { + "PerformanceInsightsMetricQuery$GroupBy": "

The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

" + } + }, + "PerformanceInsightsMetricDimensions": { + "base": null, + "refs": { + "PerformanceInsightsMetricDimensionGroup$Dimensions": "

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

Valid values for elements in the Dimensions array are:

" + } + }, + "PerformanceInsightsMetricDisplayName": { + "base": null, + "refs": { + "PerformanceInsightsMetricsDetail$MetricDisplayName": "

The name used for a specific Performance Insights metric.

" + } + }, + "PerformanceInsightsMetricFilterKey": { + "base": null, + "refs": { + "PerformanceInsightsMetricFilterMap$key": null + } + }, + "PerformanceInsightsMetricFilterMap": { + "base": null, + "refs": { + "PerformanceInsightsMetricQuery$Filter": "

One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

" + } + }, + "PerformanceInsightsMetricFilterValue": { + "base": null, + "refs": { + "PerformanceInsightsMetricFilterMap$value": null + } + }, + "PerformanceInsightsMetricGroup": { + "base": null, + "refs": { + "PerformanceInsightsMetricDimensionGroup$Group": "

The name of the dimension group. Its valid values are:

" + } + }, + "PerformanceInsightsMetricLimitInteger": { + "base": null, + "refs": { + "PerformanceInsightsMetricDimensionGroup$Limit": "

The maximum number of items to fetch for this dimension group.

" + } + }, + "PerformanceInsightsMetricName": { + "base": null, + "refs": { + "PerformanceInsightsMetricQuery$Metric": "

The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

Valid values for Metric are:

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

" + } + }, + "PerformanceInsightsMetricQuery": { + "base": "

A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

", + "refs": { + "PerformanceInsightsMetricsDetail$MetricQuery": "

A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

", + "PerformanceInsightsReferenceMetric$MetricQuery": "

A query to be processed on the metric.

" + } + }, + "PerformanceInsightsMetricUnit": { + "base": null, + "refs": { + "PerformanceInsightsMetricsDetail$Unit": "

The unit of measure for a metric. For example, a session or a process.

" + } + }, + "PerformanceInsightsMetricsDetail": { + "base": "

Details about Performance Insights metrics.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

", + "refs": { + "PerformanceInsightsMetricsDetails$member": null + } + }, + "PerformanceInsightsMetricsDetails": { + "base": null, + "refs": { + "AnomalySourceDetails$PerformanceInsightsMetrics": "

An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.

" + } + }, + "PerformanceInsightsReferenceComparisonValues": { + "base": "

Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.

", + "refs": { + "PerformanceInsightsReferenceData$ComparisonValues": "

The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .

" + } + }, + "PerformanceInsightsReferenceData": { + "base": "

Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.

", + "refs": { + "PerformanceInsightsReferenceDataList$member": null + } + }, + "PerformanceInsightsReferenceDataList": { + "base": null, + "refs": { + "PerformanceInsightsMetricsDetail$ReferenceData": "

For more information, see PerformanceInsightsReferenceData .

" + } + }, + "PerformanceInsightsReferenceMetric": { + "base": "

Information about a reference metric used to evaluate Performance Insights.

", + "refs": { + "PerformanceInsightsReferenceComparisonValues$ReferenceMetric": "

A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.

" + } + }, + "PerformanceInsightsReferenceName": { + "base": null, + "refs": { + "PerformanceInsightsReferenceData$Name": "

The name of the reference data.

" + } + }, + "PerformanceInsightsReferenceScalar": { + "base": "

A reference value to compare Performance Insights metrics against to determine if the metrics demonstrate anomalous behavior.

", + "refs": { + "PerformanceInsightsReferenceComparisonValues$ReferenceScalar": "

A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.

" + } + }, + "PerformanceInsightsStat": { + "base": "

A statistic in a Performance Insights collection.

", + "refs": { + "PerformanceInsightsStats$member": null + } + }, + "PerformanceInsightsStatType": { + "base": null, + "refs": { + "PerformanceInsightsStat$Type": "

The statistic type.

" + } + }, + "PerformanceInsightsStats": { + "base": null, + "refs": { + "PerformanceInsightsMetricsDetail$StatsAtAnomaly": "

The metric statistics during the anomalous period detected by DevOps Guru;

", + "PerformanceInsightsMetricsDetail$StatsAtBaseline": "

Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

" + } + }, + "PerformanceInsightsValueDouble": { + "base": null, + "refs": { + "PerformanceInsightsReferenceScalar$Value": "

The reference value.

", + "PerformanceInsightsStat$Value": "

The value of the statistic.

" + } + }, "PredictionTimeRange": { "base": "

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

", "refs": { @@ -943,7 +1151,7 @@ "ProactiveAnomaly": { "base": "

Information about an anomaly. This object is returned by ListAnomalies.

", "refs": { - "DescribeAnomalyResponse$ProactiveAnomaly": "

A ReactiveAnomaly object that represents the requested anomaly.

" + "DescribeAnomalyResponse$ProactiveAnomaly": "

A ProactiveAnomaly object that represents the requested anomaly.

" } }, "ProactiveAnomalySummary": { @@ -1003,7 +1211,7 @@ "ReactiveAnomaly": { "base": "

Details about a reactive anomaly. This object is returned by ListAnomalies.

", "refs": { - "DescribeAnomalyResponse$ReactiveAnomaly": "

A ProactiveAnomaly object that represents the requested anomaly.

" + "DescribeAnomalyResponse$ReactiveAnomaly": "

A ReactiveAnomaly object that represents the requested anomaly.

" } }, "ReactiveAnomalySummary": { @@ -1101,7 +1309,7 @@ "RecommendationRelatedAnomalyResourceType": { "base": null, "refs": { - "RecommendationRelatedAnomalyResource$Type": "

The type of the resource.

" + "RecommendationRelatedAnomalyResource$Type": "

The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name. For example, AWS::RDS::DBCluster. For more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation User Guide.

" } }, "RecommendationRelatedAnomalyResources": { @@ -1204,8 +1412,14 @@ "refs": { } }, + "ResourceArn": { + "base": null, + "refs": { + "AssociatedResourceArns$member": null + } + }, "ResourceCollection": { - "base": "

A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", + "base": "

A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "refs": { "Event$ResourceCollection": null, "ListEventsFilters$ResourceCollection": null, @@ -1226,13 +1440,13 @@ "ResourceCollectionFilter": { "base": "

Information about a filter used to specify which Amazon Web Services resources are analyzed for anomalous behavior by DevOps Guru.

", "refs": { - "GetResourceCollectionResponse$ResourceCollection": "

The requested list of Amazon Web Services resource collections. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" + "GetResourceCollectionResponse$ResourceCollection": "

The requested list of Amazon Web Services resource collections. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "ResourceCollectionType": { "base": null, "refs": { - "DescribeResourceCollectionHealthRequest$ResourceCollectionType": "

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", + "DescribeResourceCollectionHealthRequest$ResourceCollectionType": "

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "GetResourceCollectionRequest$ResourceCollectionType": "

The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.

" } }, @@ -1257,6 +1471,12 @@ "ResourceNotFoundException$ResourceType": "

The type of the Amazon Web Services resource that could not be found.

" } }, + "ResourceName": { + "base": null, + "refs": { + "AnomalyResource$Name": "

The name of the Amazon Web Services resource.

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

A requested resource could not be found

", "refs": { @@ -1265,6 +1485,7 @@ "ResourceType": { "base": null, "refs": { + "AnomalyResource$Type": "

The type of the Amazon Web Services resource.

", "ServiceResourceCost$Type": "

The type of the Amazon Web Services resource.

" } }, @@ -1439,6 +1660,70 @@ "SearchOrganizationInsightsRequest$StartTimeRange": null } }, + "TagCollection": { + "base": "

A collection of Amazon Web Services stags.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

", + "refs": { + "TagCollections$member": null + } + }, + "TagCollectionFilter": { + "base": "

A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from only resources that contain the tags in the tag collection.

", + "refs": { + "TagCollectionFilters$member": null + } + }, + "TagCollectionFilters": { + "base": null, + "refs": { + "ResourceCollectionFilter$Tags": "

The Amazon Web Services tags used to filter the resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "TagCollections": { + "base": null, + "refs": { + "ResourceCollection$Tags": "

The Amazon Web Services tags that are used by resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "TagCostEstimationResourceCollectionFilter": { + "base": "

Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

", + "refs": { + "TagCostEstimationResourceCollectionFilters$member": null + } + }, + "TagCostEstimationResourceCollectionFilters": { + "base": null, + "refs": { + "CostEstimationResourceCollectionFilter$Tags": "

The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "TagHealth": { + "base": "

Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.

", + "refs": { + "TagHealths$member": null + } + }, + "TagHealths": { + "base": null, + "refs": { + "DescribeResourceCollectionHealthResponse$Tags": "

The Amazon Web Services tags that are used by resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "TagValue": { + "base": null, + "refs": { + "CostEstimationTagValues$member": null, + "TagHealth$TagValue": "

The value in an Amazon Web Services tag.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

", + "TagValues$member": null, + "UpdateTagValues$member": null + } + }, + "TagValues": { + "base": null, + "refs": { + "TagCollection$TagValues": "

The values in an Amazon Web Services tag collection.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

", + "TagCollectionFilter$TagValues": "

The values in an Amazon Web Services tag collection.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

" + } + }, "ThrottlingException": { "base": "

The request was denied due to a request throttling.

", "refs": { @@ -1482,7 +1767,7 @@ "TimestampMetricValuePairList": { "base": null, "refs": { - "CloudWatchMetricsDataSummary$TimestampMetricValuePairList": "

This is a list of cloudwatch metric values at given timestamp.

" + "CloudWatchMetricsDataSummary$TimestampMetricValuePairList": "

This is a list of Amazon CloudWatch metric values at given timestamp.

" } }, "TopicArn": { @@ -1494,7 +1779,7 @@ "UpdateCloudFormationCollectionFilter": { "base": "

Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "refs": { - "UpdateResourceCollectionFilter$CloudFormation": "

An collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" + "UpdateResourceCollectionFilter$CloudFormation": "

A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "UpdateResourceCollectionAction": { @@ -1541,6 +1826,24 @@ "UpdateCloudFormationCollectionFilter$StackNames": "

An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, + "UpdateTagCollectionFilter": { + "base": "

A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag key/value pair.

", + "refs": { + "UpdateTagCollectionFilters$member": null + } + }, + "UpdateTagCollectionFilters": { + "base": null, + "refs": { + "UpdateResourceCollectionFilter$Tags": "

The updated Amazon Web Services tags used to filter the resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

" + } + }, + "UpdateTagValues": { + "base": null, + "refs": { + "UpdateTagCollectionFilter$TagValues": "

The values in an Amazon Web Services tag collection.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

" + } + }, "UuidNextToken": { "base": null, "refs": { diff --git a/models/apis/devops-guru/2020-12-01/paginators-1.json b/models/apis/devops-guru/2020-12-01/paginators-1.json index 4e2621d9338..b2d039de086 100644 --- a/models/apis/devops-guru/2020-12-01/paginators-1.json +++ b/models/apis/devops-guru/2020-12-01/paginators-1.json @@ -14,7 +14,8 @@ "output_token": "NextToken", "result_key": [ "CloudFormation", - "Service" + "Service", + "Tags" ] }, "GetCostEstimation": { @@ -37,7 +38,8 @@ ], "output_token": "NextToken", "result_key": [ - "ResourceCollection.CloudFormation.StackNames" + "ResourceCollection.CloudFormation.StackNames", + "ResourceCollection.Tags" ] }, "ListAnomaliesForInsight": { diff --git a/models/apis/directconnect/2012-10-25/api-2.json b/models/apis/directconnect/2012-10-25/api-2.json index 943d1ca96b8..64bd806c368 100644 --- a/models/apis/directconnect/2012-10-25/api-2.json +++ b/models/apis/directconnect/2012-10-25/api-2.json @@ -1821,6 +1821,7 @@ }, "exception":true }, + "EnableSiteLink":{"type":"boolean"}, "EncryptionMode":{"type":"string"}, "EndTime":{"type":"timestamp"}, "ErrorMessage":{"type":"string"}, @@ -2039,7 +2040,8 @@ "addressFamily":{"shape":"AddressFamily"}, "virtualGatewayId":{"shape":"VirtualGatewayId"}, "directConnectGatewayId":{"shape":"DirectConnectGatewayId"}, - "tags":{"shape":"TagList"} + "tags":{"shape":"TagList"}, + "enableSiteLink":{"shape":"EnableSiteLink"} } }, "NewPrivateVirtualInterfaceAllocation":{ @@ -2111,7 +2113,8 @@ "customerAddress":{"shape":"CustomerAddress"}, "addressFamily":{"shape":"AddressFamily"}, "directConnectGatewayId":{"shape":"DirectConnectGatewayId"}, - "tags":{"shape":"TagList"} + "tags":{"shape":"TagList"}, + "enableSiteLink":{"shape":"EnableSiteLink"} } }, "NewTransitVirtualInterfaceAllocation":{ @@ -2189,6 +2192,7 @@ }, "RouterTypeIdentifier":{"type":"string"}, "SecretARN":{"type":"string"}, + "SiteLinkEnabled":{"type":"boolean"}, "Software":{"type":"string"}, "StartBgpFailoverTestRequest":{ "type":"structure", @@ -2353,7 +2357,9 @@ "required":["virtualInterfaceId"], "members":{ "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, - "mtu":{"shape":"MTU"} + "mtu":{"shape":"MTU"}, + "enableSiteLink":{"shape":"EnableSiteLink"}, + "virtualInterfaceName":{"shape":"VirtualInterfaceName"} } }, "VLAN":{"type":"integer"}, @@ -2408,7 +2414,8 @@ "region":{"shape":"Region"}, "awsDeviceV2":{"shape":"AwsDeviceV2"}, "awsLogicalDeviceId":{"shape":"AwsLogicalDeviceId"}, - "tags":{"shape":"TagList"} + "tags":{"shape":"TagList"}, + "siteLinkEnabled":{"shape":"SiteLinkEnabled"} } }, "VirtualInterfaceId":{"type":"string"}, diff --git a/models/apis/directconnect/2012-10-25/docs-2.json b/models/apis/directconnect/2012-10-25/docs-2.json index 767ad1d5189..fcd3bba6ac7 100644 --- a/models/apis/directconnect/2012-10-25/docs-2.json +++ b/models/apis/directconnect/2012-10-25/docs-2.json @@ -913,6 +913,14 @@ "refs": { } }, + "EnableSiteLink": { + "base": null, + "refs": { + "NewPrivateVirtualInterface$enableSiteLink": "

Indicates whether to enable or disable SiteLink.

", + "NewTransitVirtualInterface$enableSiteLink": "

Indicates whether to enable or disable SiteLink.

", + "UpdateVirtualInterfaceAttributesRequest$enableSiteLink": "

Indicates whether to enable or disable SiteLink.

" + } + }, "EncryptionMode": { "base": null, "refs": { @@ -1419,6 +1427,12 @@ "MacSecKey$secretARN": "

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

" } }, + "SiteLinkEnabled": { + "base": null, + "refs": { + "VirtualInterface$siteLinkEnabled": "

Indicates whether SiteLink is enabled.

" + } + }, "Software": { "base": null, "refs": { @@ -1704,13 +1718,14 @@ "VirtualInterfaceName": { "base": null, "refs": { - "DescribeRouterConfigurationResponse$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network.

", + "DescribeRouterConfigurationResponse$virtualInterfaceName": "

Provides the details about a virtual interface's router.

", "NewPrivateVirtualInterface$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", "NewPrivateVirtualInterfaceAllocation$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", "NewPublicVirtualInterface$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", "NewPublicVirtualInterfaceAllocation$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", "NewTransitVirtualInterface$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", "NewTransitVirtualInterfaceAllocation$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", + "UpdateVirtualInterfaceAttributesRequest$virtualInterfaceName": "

The name of the virtual private interface.

", "VirtualInterface$virtualInterfaceName": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" } }, diff --git a/models/apis/dynamodb/2012-08-10/api-2.json b/models/apis/dynamodb/2012-08-10/api-2.json index bb55c70cfd0..86fd44621d9 100644 --- a/models/apis/dynamodb/2012-08-10/api-2.json +++ b/models/apis/dynamodb/2012-08-10/api-2.json @@ -1436,7 +1436,8 @@ "RegionName":{"shape":"RegionName"}, "KMSMasterKeyId":{"shape":"KMSMasterKeyId"}, "ProvisionedThroughputOverride":{"shape":"ProvisionedThroughputOverride"}, - "GlobalSecondaryIndexes":{"shape":"ReplicaGlobalSecondaryIndexList"} + "GlobalSecondaryIndexes":{"shape":"ReplicaGlobalSecondaryIndexList"}, + "TableClassOverride":{"shape":"TableClass"} } }, "CreateTableInput":{ @@ -1456,7 +1457,8 @@ "ProvisionedThroughput":{"shape":"ProvisionedThroughput"}, "StreamSpecification":{"shape":"StreamSpecification"}, "SSESpecification":{"shape":"SSESpecification"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "TableClass":{"shape":"TableClass"} } }, "CreateTableOutput":{ @@ -2761,7 +2763,8 @@ "KMSMasterKeyId":{"shape":"KMSMasterKeyId"}, "ProvisionedThroughputOverride":{"shape":"ProvisionedThroughputOverride"}, "GlobalSecondaryIndexes":{"shape":"ReplicaGlobalSecondaryIndexDescriptionList"}, - "ReplicaInaccessibleDateTime":{"shape":"Date"} + "ReplicaInaccessibleDateTime":{"shape":"Date"}, + "ReplicaTableClassSummary":{"shape":"TableClassSummary"} } }, "ReplicaDescriptionList":{ @@ -2869,7 +2872,8 @@ "ReplicaProvisionedReadCapacityAutoScalingSettings":{"shape":"AutoScalingSettingsDescription"}, "ReplicaProvisionedWriteCapacityUnits":{"shape":"NonNegativeLongObject"}, "ReplicaProvisionedWriteCapacityAutoScalingSettings":{"shape":"AutoScalingSettingsDescription"}, - "ReplicaGlobalSecondaryIndexSettings":{"shape":"ReplicaGlobalSecondaryIndexSettingsDescriptionList"} + "ReplicaGlobalSecondaryIndexSettings":{"shape":"ReplicaGlobalSecondaryIndexSettingsDescriptionList"}, + "ReplicaTableClassSummary":{"shape":"TableClassSummary"} } }, "ReplicaSettingsDescriptionList":{ @@ -2883,7 +2887,8 @@ "RegionName":{"shape":"RegionName"}, "ReplicaProvisionedReadCapacityUnits":{"shape":"PositiveLongObject"}, "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate":{"shape":"AutoScalingSettingsUpdate"}, - "ReplicaGlobalSecondaryIndexSettingsUpdate":{"shape":"ReplicaGlobalSecondaryIndexSettingsUpdateList"} + "ReplicaGlobalSecondaryIndexSettingsUpdate":{"shape":"ReplicaGlobalSecondaryIndexSettingsUpdateList"}, + "ReplicaTableClass":{"shape":"TableClass"} } }, "ReplicaSettingsUpdateList":{ @@ -3236,6 +3241,20 @@ "Replicas":{"shape":"ReplicaAutoScalingDescriptionList"} } }, + "TableClass":{ + "type":"string", + "enum":[ + "STANDARD", + "STANDARD_INFREQUENT_ACCESS" + ] + }, + "TableClassSummary":{ + "type":"structure", + "members":{ + "TableClass":{"shape":"TableClass"}, + "LastUpdateDateTime":{"shape":"Date"} + } + }, "TableCreationDateTime":{"type":"timestamp"}, "TableDescription":{ "type":"structure", @@ -3260,7 +3279,8 @@ "Replicas":{"shape":"ReplicaDescriptionList"}, "RestoreSummary":{"shape":"RestoreSummary"}, "SSEDescription":{"shape":"SSEDescription"}, - "ArchivalSummary":{"shape":"ArchivalSummary"} + "ArchivalSummary":{"shape":"ArchivalSummary"}, + "TableClassSummary":{"shape":"TableClassSummary"} } }, "TableId":{ @@ -3612,7 +3632,8 @@ "RegionName":{"shape":"RegionName"}, "KMSMasterKeyId":{"shape":"KMSMasterKeyId"}, "ProvisionedThroughputOverride":{"shape":"ProvisionedThroughputOverride"}, - "GlobalSecondaryIndexes":{"shape":"ReplicaGlobalSecondaryIndexList"} + "GlobalSecondaryIndexes":{"shape":"ReplicaGlobalSecondaryIndexList"}, + "TableClassOverride":{"shape":"TableClass"} } }, "UpdateTableInput":{ @@ -3626,7 +3647,8 @@ "GlobalSecondaryIndexUpdates":{"shape":"GlobalSecondaryIndexUpdateList"}, "StreamSpecification":{"shape":"StreamSpecification"}, "SSESpecification":{"shape":"SSESpecification"}, - "ReplicaUpdates":{"shape":"ReplicationGroupUpdateList"} + "ReplicaUpdates":{"shape":"ReplicationGroupUpdateList"}, + "TableClass":{"shape":"TableClass"} } }, "UpdateTableOutput":{ diff --git a/models/apis/dynamodb/2012-08-10/docs-2.json b/models/apis/dynamodb/2012-08-10/docs-2.json index 91fc119963b..2632b0ef83e 100644 --- a/models/apis/dynamodb/2012-08-10/docs-2.json +++ b/models/apis/dynamodb/2012-08-10/docs-2.json @@ -717,6 +717,7 @@ "RestoreSummary$RestoreDateTime": "

Point in time or source backup time.

", "RestoreTableToPointInTimeInput$RestoreDateTime": "

Time in the past to restore the table to.

", "SSEDescription$InaccessibleEncryptionDateTime": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

", + "TableClassSummary$LastUpdateDateTime": "

The date and time at which the table class was last updated.

", "TableDescription$CreationDateTime": "

The date and time when the table was created, in UNIX epoch time format.

" } }, @@ -2503,6 +2504,25 @@ "UpdateTableReplicaAutoScalingOutput$TableAutoScalingDescription": "

Returns information about the auto scaling settings of a table with replicas.

" } }, + "TableClass": { + "base": null, + "refs": { + "CreateReplicationGroupMemberAction$TableClassOverride": "

Replica-specific table class. If not specified, uses the source table's table class.

", + "CreateTableInput$TableClass": "

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

", + "ReplicaSettingsUpdate$ReplicaTableClass": "

Replica-specific table class. If not specified, uses the source table's table class.

", + "TableClassSummary$TableClass": "

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

", + "UpdateReplicationGroupMemberAction$TableClassOverride": "

Replica-specific table class. If not specified, uses the source table's table class.

", + "UpdateTableInput$TableClass": "

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

" + } + }, + "TableClassSummary": { + "base": "

Contains details of the table class.

", + "refs": { + "ReplicaDescription$ReplicaTableClassSummary": null, + "ReplicaSettingsDescription$ReplicaTableClassSummary": null, + "TableDescription$TableClassSummary": "

Contains details of the table class.

" + } + }, "TableCreationDateTime": { "base": null, "refs": { diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 026e445cb33..802138755e2 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -93,6 +93,15 @@ "input":{"shape":"AllocateHostsRequest"}, "output":{"shape":"AllocateHostsResult"} }, + "AllocateIpamPoolCidr":{ + "name":"AllocateIpamPoolCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateIpamPoolCidrRequest"}, + "output":{"shape":"AllocateIpamPoolCidrResult"} + }, "ApplySecurityGroupsToClientVpnTargetNetwork":{ "name":"ApplySecurityGroupsToClientVpnTargetNetwork", "http":{ @@ -575,6 +584,33 @@ "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"} }, + "CreateIpam":{ + "name":"CreateIpam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpamRequest"}, + "output":{"shape":"CreateIpamResult"} + }, + "CreateIpamPool":{ + "name":"CreateIpamPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpamPoolRequest"}, + "output":{"shape":"CreateIpamPoolResult"} + }, + "CreateIpamScope":{ + "name":"CreateIpamScope", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpamScopeRequest"}, + "output":{"shape":"CreateIpamScopeResult"} + }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ @@ -655,6 +691,15 @@ }, "input":{"shape":"CreateNetworkAclEntryRequest"} }, + "CreateNetworkInsightsAccessScope":{ + "name":"CreateNetworkInsightsAccessScope", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInsightsAccessScopeRequest"}, + "output":{"shape":"CreateNetworkInsightsAccessScopeResult"} + }, "CreateNetworkInsightsPath":{ "name":"CreateNetworkInsightsPath", "http":{ @@ -691,6 +736,15 @@ "input":{"shape":"CreatePlacementGroupRequest"}, "output":{"shape":"CreatePlacementGroupResult"} }, + "CreatePublicIpv4Pool":{ + "name":"CreatePublicIpv4Pool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePublicIpv4PoolRequest"}, + "output":{"shape":"CreatePublicIpv4PoolResult"} + }, "CreateReplaceRootVolumeTask":{ "name":"CreateReplaceRootVolumeTask", "http":{ @@ -1100,6 +1154,33 @@ }, "input":{"shape":"DeleteInternetGatewayRequest"} }, + "DeleteIpam":{ + "name":"DeleteIpam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIpamRequest"}, + "output":{"shape":"DeleteIpamResult"} + }, + "DeleteIpamPool":{ + "name":"DeleteIpamPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIpamPoolRequest"}, + "output":{"shape":"DeleteIpamPoolResult"} + }, + "DeleteIpamScope":{ + "name":"DeleteIpamScope", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIpamScopeRequest"}, + "output":{"shape":"DeleteIpamScopeResult"} + }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ @@ -1178,6 +1259,24 @@ }, "input":{"shape":"DeleteNetworkAclEntryRequest"} }, + "DeleteNetworkInsightsAccessScope":{ + "name":"DeleteNetworkInsightsAccessScope", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInsightsAccessScopeRequest"}, + "output":{"shape":"DeleteNetworkInsightsAccessScopeResult"} + }, + "DeleteNetworkInsightsAccessScopeAnalysis":{ + "name":"DeleteNetworkInsightsAccessScopeAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInsightsAccessScopeAnalysisRequest"}, + "output":{"shape":"DeleteNetworkInsightsAccessScopeAnalysisResult"} + }, "DeleteNetworkInsightsAnalysis":{ "name":"DeleteNetworkInsightsAnalysis", "http":{ @@ -1221,6 +1320,15 @@ }, "input":{"shape":"DeletePlacementGroupRequest"} }, + "DeletePublicIpv4Pool":{ + "name":"DeletePublicIpv4Pool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePublicIpv4PoolRequest"}, + "output":{"shape":"DeletePublicIpv4PoolResult"} + }, "DeleteQueuedReservedInstances":{ "name":"DeleteQueuedReservedInstances", "http":{ @@ -1497,6 +1605,24 @@ "input":{"shape":"DeprovisionByoipCidrRequest"}, "output":{"shape":"DeprovisionByoipCidrResult"} }, + "DeprovisionIpamPoolCidr":{ + "name":"DeprovisionIpamPoolCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprovisionIpamPoolCidrRequest"}, + "output":{"shape":"DeprovisionIpamPoolCidrResult"} + }, + "DeprovisionPublicIpv4PoolCidr":{ + "name":"DeprovisionPublicIpv4PoolCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprovisionPublicIpv4PoolCidrRequest"}, + "output":{"shape":"DeprovisionPublicIpv4PoolCidrResult"} + }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ @@ -1982,6 +2108,33 @@ "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"} }, + "DescribeIpamPools":{ + "name":"DescribeIpamPools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpamPoolsRequest"}, + "output":{"shape":"DescribeIpamPoolsResult"} + }, + "DescribeIpamScopes":{ + "name":"DescribeIpamScopes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpamScopesRequest"}, + "output":{"shape":"DescribeIpamScopesResult"} + }, + "DescribeIpams":{ + "name":"DescribeIpams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpamsRequest"}, + "output":{"shape":"DescribeIpamsResult"} + }, "DescribeIpv6Pools":{ "name":"DescribeIpv6Pools", "http":{ @@ -2108,6 +2261,24 @@ "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"} }, + "DescribeNetworkInsightsAccessScopeAnalyses":{ + "name":"DescribeNetworkInsightsAccessScopeAnalyses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInsightsAccessScopeAnalysesRequest"}, + "output":{"shape":"DescribeNetworkInsightsAccessScopeAnalysesResult"} + }, + "DescribeNetworkInsightsAccessScopes":{ + "name":"DescribeNetworkInsightsAccessScopes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInsightsAccessScopesRequest"}, + "output":{"shape":"DescribeNetworkInsightsAccessScopesResult"} + }, "DescribeNetworkInsightsAnalyses":{ "name":"DescribeNetworkInsightsAnalyses", "http":{ @@ -2744,6 +2915,15 @@ "input":{"shape":"DisableImageDeprecationRequest"}, "output":{"shape":"DisableImageDeprecationResult"} }, + "DisableIpamOrganizationAdminAccount":{ + "name":"DisableIpamOrganizationAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableIpamOrganizationAdminAccountRequest"}, + "output":{"shape":"DisableIpamOrganizationAdminAccountResult"} + }, "DisableSerialConsoleAccess":{ "name":"DisableSerialConsoleAccess", "http":{ @@ -2912,6 +3092,15 @@ "input":{"shape":"EnableImageDeprecationRequest"}, "output":{"shape":"EnableImageDeprecationResult"} }, + "EnableIpamOrganizationAdminAccount":{ + "name":"EnableIpamOrganizationAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableIpamOrganizationAdminAccountRequest"}, + "output":{"shape":"EnableIpamOrganizationAdminAccountResult"} + }, "EnableSerialConsoleAccess":{ "name":"EnableSerialConsoleAccess", "http":{ @@ -3117,6 +3306,42 @@ "input":{"shape":"GetInstanceTypesFromInstanceRequirementsRequest"}, "output":{"shape":"GetInstanceTypesFromInstanceRequirementsResult"} }, + "GetIpamAddressHistory":{ + "name":"GetIpamAddressHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIpamAddressHistoryRequest"}, + "output":{"shape":"GetIpamAddressHistoryResult"} + }, + "GetIpamPoolAllocations":{ + "name":"GetIpamPoolAllocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIpamPoolAllocationsRequest"}, + "output":{"shape":"GetIpamPoolAllocationsResult"} + }, + "GetIpamPoolCidrs":{ + "name":"GetIpamPoolCidrs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIpamPoolCidrsRequest"}, + "output":{"shape":"GetIpamPoolCidrsResult"} + }, + "GetIpamResourceCidrs":{ + "name":"GetIpamResourceCidrs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIpamResourceCidrsRequest"}, + "output":{"shape":"GetIpamResourceCidrsResult"} + }, "GetLaunchTemplateData":{ "name":"GetLaunchTemplateData", "http":{ @@ -3144,6 +3369,24 @@ "input":{"shape":"GetManagedPrefixListEntriesRequest"}, "output":{"shape":"GetManagedPrefixListEntriesResult"} }, + "GetNetworkInsightsAccessScopeAnalysisFindings":{ + "name":"GetNetworkInsightsAccessScopeAnalysisFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNetworkInsightsAccessScopeAnalysisFindingsRequest"}, + "output":{"shape":"GetNetworkInsightsAccessScopeAnalysisFindingsResult"} + }, + "GetNetworkInsightsAccessScopeContent":{ + "name":"GetNetworkInsightsAccessScopeContent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNetworkInsightsAccessScopeContentRequest"}, + "output":{"shape":"GetNetworkInsightsAccessScopeContentResult"} + }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ @@ -3491,6 +3734,42 @@ "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"} }, + "ModifyIpam":{ + "name":"ModifyIpam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIpamRequest"}, + "output":{"shape":"ModifyIpamResult"} + }, + "ModifyIpamPool":{ + "name":"ModifyIpamPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIpamPoolRequest"}, + "output":{"shape":"ModifyIpamPoolResult"} + }, + "ModifyIpamResourceCidr":{ + "name":"ModifyIpamResourceCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIpamResourceCidrRequest"}, + "output":{"shape":"ModifyIpamResourceCidrResult"} + }, + "ModifyIpamScope":{ + "name":"ModifyIpamScope", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIpamScopeRequest"}, + "output":{"shape":"ModifyIpamScopeResult"} + }, "ModifyLaunchTemplate":{ "name":"ModifyLaunchTemplate", "http":{ @@ -3765,6 +4044,15 @@ "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"} }, + "MoveByoipCidrToIpam":{ + "name":"MoveByoipCidrToIpam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveByoipCidrToIpamRequest"}, + "output":{"shape":"MoveByoipCidrToIpamResult"} + }, "ProvisionByoipCidr":{ "name":"ProvisionByoipCidr", "http":{ @@ -3774,6 +4062,24 @@ "input":{"shape":"ProvisionByoipCidrRequest"}, "output":{"shape":"ProvisionByoipCidrResult"} }, + "ProvisionIpamPoolCidr":{ + "name":"ProvisionIpamPoolCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ProvisionIpamPoolCidrRequest"}, + "output":{"shape":"ProvisionIpamPoolCidrResult"} + }, + "ProvisionPublicIpv4PoolCidr":{ + "name":"ProvisionPublicIpv4PoolCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ProvisionPublicIpv4PoolCidrRequest"}, + "output":{"shape":"ProvisionPublicIpv4PoolCidrResult"} + }, "PurchaseHostReservation":{ "name":"PurchaseHostReservation", "http":{ @@ -3907,6 +4213,15 @@ "input":{"shape":"ReleaseHostsRequest"}, "output":{"shape":"ReleaseHostsResult"} }, + "ReleaseIpamPoolAllocation":{ + "name":"ReleaseIpamPoolAllocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseIpamPoolAllocationRequest"}, + "output":{"shape":"ReleaseIpamPoolAllocationResult"} + }, "ReplaceIamInstanceProfileAssociation":{ "name":"ReplaceIamInstanceProfileAssociation", "http":{ @@ -4169,6 +4484,15 @@ "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"} }, + "StartNetworkInsightsAccessScopeAnalysis":{ + "name":"StartNetworkInsightsAccessScopeAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartNetworkInsightsAccessScopeAnalysisRequest"}, + "output":{"shape":"StartNetworkInsightsAccessScopeAnalysisResult"} + }, "StartNetworkInsightsAnalysis":{ "name":"StartNetworkInsightsAnalysis", "http":{ @@ -4481,6 +4805,76 @@ } } }, + "AccessScopeAnalysisFinding":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{ + "shape":"NetworkInsightsAccessScopeAnalysisId", + "locationName":"networkInsightsAccessScopeAnalysisId" + }, + "NetworkInsightsAccessScopeId":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"networkInsightsAccessScopeId" + }, + "FindingId":{ + "shape":"String", + "locationName":"findingId" + }, + "FindingComponents":{ + "shape":"PathComponentList", + "locationName":"findingComponentSet" + } + } + }, + "AccessScopeAnalysisFindingList":{ + "type":"list", + "member":{ + "shape":"AccessScopeAnalysisFinding", + "locationName":"item" + } + }, + "AccessScopePath":{ + "type":"structure", + "members":{ + "Source":{ + "shape":"PathStatement", + "locationName":"source" + }, + "Destination":{ + "shape":"PathStatement", + "locationName":"destination" + }, + "ThroughResources":{ + "shape":"ThroughResourcesStatementList", + "locationName":"throughResourceSet" + } + } + }, + "AccessScopePathList":{ + "type":"list", + "member":{ + "shape":"AccessScopePath", + "locationName":"item" + } + }, + "AccessScopePathListRequest":{ + "type":"list", + "member":{ + "shape":"AccessScopePathRequest", + "locationName":"item" + } + }, + "AccessScopePathRequest":{ + "type":"structure", + "members":{ + "Source":{"shape":"PathStatementRequest"}, + "Destination":{"shape":"PathStatementRequest"}, + "ThroughResources":{ + "shape":"ThroughResourcesStatementRequestList", + "locationName":"ThroughResource" + } + } + }, "AccountAttribute":{ "type":"structure", "members":{ @@ -4568,6 +4962,18 @@ "fulfilled" ] }, + "AddIpamOperatingRegion":{ + "type":"structure", + "members":{ + "RegionName":{"shape":"String"} + } + }, + "AddIpamOperatingRegionSet":{ + "type":"list", + "member":{"shape":"AddIpamOperatingRegion"}, + "max":50, + "min":0 + }, "AddPrefixListEntries":{ "type":"list", "member":{"shape":"AddPrefixListEntry"}, @@ -4668,6 +5074,13 @@ "type":"string", "enum":["domain-name"] }, + "AddressFamily":{ + "type":"string", + "enum":[ + "ipv4", + "ipv6" + ] + }, "AddressList":{ "type":"list", "member":{ @@ -4810,6 +5223,35 @@ } } }, + "AllocateIpamPoolCidrRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Cidr":{"shape":"String"}, + "NetmaskLength":{"shape":"Integer"}, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + }, + "Description":{"shape":"String"}, + "PreviewNextCidr":{"shape":"Boolean"}, + "DisallowedCidrs":{ + "shape":"IpamPoolAllocationDisallowedCidrs", + "locationName":"DisallowedCidr" + } + } + }, + "AllocateIpamPoolCidrResult":{ + "type":"structure", + "members":{ + "IpamPoolAllocation":{ + "shape":"IpamPoolAllocation", + "locationName":"ipamPoolAllocation" + } + } + }, "AllocationId":{"type":"string"}, "AllocationIdList":{ "type":"list", @@ -4931,6 +5373,10 @@ "Arn":{ "shape":"String", "locationName":"arn" + }, + "Name":{ + "shape":"String", + "locationName":"name" } } }, @@ -5546,7 +5992,11 @@ }, "Ipv6CidrBlockNetworkBorderGroup":{"shape":"String"}, "Ipv6Pool":{"shape":"Ipv6PoolEc2Id"}, - "Ipv6CidrBlock":{"shape":"String"} + "Ipv6CidrBlock":{"shape":"String"}, + "Ipv4IpamPoolId":{"shape":"IpamPoolId"}, + "Ipv4NetmaskLength":{"shape":"NetmaskLength"}, + "Ipv6IpamPoolId":{"shape":"IpamPoolId"}, + "Ipv6NetmaskLength":{"shape":"NetmaskLength"} } }, "AssociateVpcCidrBlockResult":{ @@ -6255,6 +6705,7 @@ "uefi" ] }, + "BoxedDouble":{"type":"double"}, "BundleId":{"type":"string"}, "BundleIdStringList":{ "type":"list", @@ -8670,6 +9121,99 @@ } } }, + "CreateIpamPoolRequest":{ + "type":"structure", + "required":["IpamScopeId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamScopeId":{"shape":"IpamScopeId"}, + "Locale":{"shape":"String"}, + "SourceIpamPoolId":{"shape":"IpamPoolId"}, + "Description":{"shape":"String"}, + "AddressFamily":{"shape":"AddressFamily"}, + "AutoImport":{"shape":"Boolean"}, + "PubliclyAdvertisable":{"shape":"Boolean"}, + "AllocationMinNetmaskLength":{"shape":"IpamNetmaskLength"}, + "AllocationMaxNetmaskLength":{"shape":"IpamNetmaskLength"}, + "AllocationDefaultNetmaskLength":{"shape":"IpamNetmaskLength"}, + "AllocationResourceTags":{ + "shape":"RequestIpamResourceTagList", + "locationName":"AllocationResourceTag" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + }, + "AwsService":{"shape":"IpamPoolAwsService"} + } + }, + "CreateIpamPoolResult":{ + "type":"structure", + "members":{ + "IpamPool":{ + "shape":"IpamPool", + "locationName":"ipamPool" + } + } + }, + "CreateIpamRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Description":{"shape":"String"}, + "OperatingRegions":{ + "shape":"AddIpamOperatingRegionSet", + "locationName":"OperatingRegion" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + } + } + }, + "CreateIpamResult":{ + "type":"structure", + "members":{ + "Ipam":{ + "shape":"Ipam", + "locationName":"ipam" + } + } + }, + "CreateIpamScopeRequest":{ + "type":"structure", + "required":["IpamId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamId":{"shape":"IpamId"}, + "Description":{"shape":"String"}, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + } + } + }, + "CreateIpamScopeResult":{ + "type":"structure", + "members":{ + "IpamScope":{ + "shape":"IpamScope", + "locationName":"ipamScope" + } + } + }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], @@ -8936,6 +9480,42 @@ } } }, + "CreateNetworkInsightsAccessScopeRequest":{ + "type":"structure", + "required":["ClientToken"], + "members":{ + "MatchPaths":{ + "shape":"AccessScopePathListRequest", + "locationName":"MatchPath" + }, + "ExcludePaths":{ + "shape":"AccessScopePathListRequest", + "locationName":"ExcludePath" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "DryRun":{"shape":"Boolean"} + } + }, + "CreateNetworkInsightsAccessScopeResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScope":{ + "shape":"NetworkInsightsAccessScope", + "locationName":"networkInsightsAccessScope" + }, + "NetworkInsightsAccessScopeContent":{ + "shape":"NetworkInsightsAccessScopeContent", + "locationName":"networkInsightsAccessScopeContent" + } + } + }, "CreateNetworkInsightsPathRequest":{ "type":"structure", "required":[ @@ -9099,6 +9679,25 @@ } } }, + "CreatePublicIpv4PoolRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + } + } + }, + "CreatePublicIpv4PoolResult":{ + "type":"structure", + "members":{ + "PoolId":{ + "shape":"Ipv4PoolEc2Id", + "locationName":"poolId" + } + } + }, "CreateReplaceRootVolumeTaskRequest":{ "type":"structure", "required":["InstanceId"], @@ -10062,7 +10661,6 @@ }, "CreateVpcRequest":{ "type":"structure", - "required":["CidrBlock"], "members":{ "CidrBlock":{"shape":"String"}, "AmazonProvidedIpv6CidrBlock":{ @@ -10071,6 +10669,10 @@ }, "Ipv6Pool":{"shape":"Ipv6PoolEc2Id"}, "Ipv6CidrBlock":{"shape":"String"}, + "Ipv4IpamPoolId":{"shape":"IpamPoolId"}, + "Ipv4NetmaskLength":{"shape":"NetmaskLength"}, + "Ipv6IpamPoolId":{"shape":"IpamPoolId"}, + "Ipv6NetmaskLength":{"shape":"NetmaskLength"}, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" @@ -10547,6 +11149,57 @@ } } }, + "DeleteIpamPoolRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"} + } + }, + "DeleteIpamPoolResult":{ + "type":"structure", + "members":{ + "IpamPool":{ + "shape":"IpamPool", + "locationName":"ipamPool" + } + } + }, + "DeleteIpamRequest":{ + "type":"structure", + "required":["IpamId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamId":{"shape":"IpamId"} + } + }, + "DeleteIpamResult":{ + "type":"structure", + "members":{ + "Ipam":{ + "shape":"Ipam", + "locationName":"ipam" + } + } + }, + "DeleteIpamScopeRequest":{ + "type":"structure", + "required":["IpamScopeId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamScopeId":{"shape":"IpamScopeId"} + } + }, + "DeleteIpamScopeResult":{ + "type":"structure", + "members":{ + "IpamScope":{ + "shape":"IpamScope", + "locationName":"ipamScope" + } + } + }, "DeleteKeyPairRequest":{ "type":"structure", "members":{ @@ -10765,6 +11418,40 @@ } } }, + "DeleteNetworkInsightsAccessScopeAnalysisRequest":{ + "type":"structure", + "required":["NetworkInsightsAccessScopeAnalysisId"], + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{"shape":"NetworkInsightsAccessScopeAnalysisId"}, + "DryRun":{"shape":"Boolean"} + } + }, + "DeleteNetworkInsightsAccessScopeAnalysisResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{ + "shape":"NetworkInsightsAccessScopeAnalysisId", + "locationName":"networkInsightsAccessScopeAnalysisId" + } + } + }, + "DeleteNetworkInsightsAccessScopeRequest":{ + "type":"structure", + "required":["NetworkInsightsAccessScopeId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "NetworkInsightsAccessScopeId":{"shape":"NetworkInsightsAccessScopeId"} + } + }, + "DeleteNetworkInsightsAccessScopeResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeId":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"networkInsightsAccessScopeId" + } + } + }, "DeleteNetworkInsightsAnalysisRequest":{ "type":"structure", "required":["NetworkInsightsAnalysisId"], @@ -10845,6 +11532,23 @@ } } }, + "DeletePublicIpv4PoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "PoolId":{"shape":"Ipv4PoolEc2Id"} + } + }, + "DeletePublicIpv4PoolResult":{ + "type":"structure", + "members":{ + "ReturnValue":{ + "shape":"Boolean", + "locationName":"returnValue" + } + } + }, "DeleteQueuedReservedInstancesError":{ "type":"structure", "members":{ @@ -11397,6 +12101,56 @@ } } }, + "DeprovisionIpamPoolCidrRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Cidr":{"shape":"String"} + } + }, + "DeprovisionIpamPoolCidrResult":{ + "type":"structure", + "members":{ + "IpamPoolCidr":{ + "shape":"IpamPoolCidr", + "locationName":"ipamPoolCidr" + } + } + }, + "DeprovisionPublicIpv4PoolCidrRequest":{ + "type":"structure", + "required":[ + "PoolId", + "Cidr" + ], + "members":{ + "DryRun":{"shape":"Boolean"}, + "PoolId":{"shape":"Ipv4PoolEc2Id"}, + "Cidr":{"shape":"String"} + } + }, + "DeprovisionPublicIpv4PoolCidrResult":{ + "type":"structure", + "members":{ + "PoolId":{ + "shape":"Ipv4PoolEc2Id", + "locationName":"poolId" + }, + "DeprovisionedAddresses":{ + "shape":"DeprovisionedAddressSet", + "locationName":"deprovisionedAddressSet" + } + } + }, + "DeprovisionedAddressSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], @@ -13057,6 +13811,93 @@ } } }, + "DescribeIpamPoolsRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"IpamMaxResults"}, + "NextToken":{"shape":"NextToken"}, + "IpamPoolIds":{ + "shape":"ValueStringList", + "locationName":"IpamPoolId" + } + } + }, + "DescribeIpamPoolsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + }, + "IpamPools":{ + "shape":"IpamPoolSet", + "locationName":"ipamPoolSet" + } + } + }, + "DescribeIpamScopesRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"IpamMaxResults"}, + "NextToken":{"shape":"NextToken"}, + "IpamScopeIds":{ + "shape":"ValueStringList", + "locationName":"IpamScopeId" + } + } + }, + "DescribeIpamScopesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + }, + "IpamScopes":{ + "shape":"IpamScopeSet", + "locationName":"ipamScopeSet" + } + } + }, + "DescribeIpamsRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"IpamMaxResults"}, + "NextToken":{"shape":"NextToken"}, + "IpamIds":{ + "shape":"ValueStringList", + "locationName":"IpamId" + } + } + }, + "DescribeIpamsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + }, + "Ipams":{ + "shape":"IpamSet", + "locationName":"ipamSet" + } + } + }, "DescribeIpv6PoolsRequest":{ "type":"structure", "members":{ @@ -13501,6 +14342,67 @@ } } }, + "DescribeNetworkInsightsAccessScopeAnalysesRequest":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysisIds":{ + "shape":"NetworkInsightsAccessScopeAnalysisIdList", + "locationName":"NetworkInsightsAccessScopeAnalysisId" + }, + "NetworkInsightsAccessScopeId":{"shape":"NetworkInsightsAccessScopeId"}, + "AnalysisStartTimeBegin":{"shape":"MillisecondDateTime"}, + "AnalysisStartTimeEnd":{"shape":"MillisecondDateTime"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"NetworkInsightsMaxResults"}, + "DryRun":{"shape":"Boolean"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeNetworkInsightsAccessScopeAnalysesResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalyses":{ + "shape":"NetworkInsightsAccessScopeAnalysisList", + "locationName":"networkInsightsAccessScopeAnalysisSet" + }, + "NextToken":{ + "shape":"String", + "locationName":"nextToken" + } + } + }, + "DescribeNetworkInsightsAccessScopesRequest":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeIds":{ + "shape":"NetworkInsightsAccessScopeIdList", + "locationName":"NetworkInsightsAccessScopeId" + }, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"NetworkInsightsMaxResults"}, + "DryRun":{"shape":"Boolean"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeNetworkInsightsAccessScopesResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopes":{ + "shape":"NetworkInsightsAccessScopeList", + "locationName":"networkInsightsAccessScopeSet" + }, + "NextToken":{ + "shape":"String", + "locationName":"nextToken" + } + } + }, "DescribeNetworkInsightsAnalysesRequest":{ "type":"structure", "members":{ @@ -15909,6 +16811,23 @@ } } }, + "DisableIpamOrganizationAdminAccountRequest":{ + "type":"structure", + "required":["DelegatedAdminAccountId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "DelegatedAdminAccountId":{"shape":"String"} + } + }, + "DisableIpamOrganizationAdminAccountResult":{ + "type":"structure", + "members":{ + "Success":{ + "shape":"Boolean", + "locationName":"success" + } + } + }, "DisableSerialConsoleAccessRequest":{ "type":"structure", "members":{ @@ -16929,6 +17848,23 @@ } } }, + "EnableIpamOrganizationAdminAccountRequest":{ + "type":"structure", + "required":["DelegatedAdminAccountId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "DelegatedAdminAccountId":{"shape":"String"} + } + }, + "EnableIpamOrganizationAdminAccountResult":{ + "type":"structure", + "members":{ + "Success":{ + "shape":"Boolean", + "locationName":"success" + } + } + }, "EnableSerialConsoleAccessRequest":{ "type":"structure", "members":{ @@ -17731,6 +18667,14 @@ "locationName":"Filter" } }, + "FindingsFound":{ + "type":"string", + "enum":[ + "true", + "false", + "unknown" + ] + }, "FleetActivityStatus":{ "type":"string", "enum":[ @@ -18760,6 +19704,128 @@ } } }, + "GetIpamAddressHistoryRequest":{ + "type":"structure", + "required":[ + "Cidr", + "IpamScopeId" + ], + "members":{ + "DryRun":{"shape":"Boolean"}, + "Cidr":{"shape":"String"}, + "IpamScopeId":{"shape":"IpamScopeId"}, + "VpcId":{"shape":"String"}, + "StartTime":{"shape":"MillisecondDateTime"}, + "EndTime":{"shape":"MillisecondDateTime"}, + "MaxResults":{"shape":"IpamAddressHistoryMaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "GetIpamAddressHistoryResult":{ + "type":"structure", + "members":{ + "HistoryRecords":{ + "shape":"IpamAddressHistoryRecordSet", + "locationName":"historyRecordSet" + }, + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + } + } + }, + "GetIpamPoolAllocationsMaxResults":{ + "type":"integer", + "max":100000, + "min":1000 + }, + "GetIpamPoolAllocationsRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "IpamPoolAllocationId":{"shape":"IpamPoolAllocationId"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"GetIpamPoolAllocationsMaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "GetIpamPoolAllocationsResult":{ + "type":"structure", + "members":{ + "IpamPoolAllocations":{ + "shape":"IpamPoolAllocationSet", + "locationName":"ipamPoolAllocationSet" + }, + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + } + } + }, + "GetIpamPoolCidrsRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"IpamMaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "GetIpamPoolCidrsResult":{ + "type":"structure", + "members":{ + "IpamPoolCidrs":{ + "shape":"IpamPoolCidrSet", + "locationName":"ipamPoolCidrSet" + }, + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + } + } + }, + "GetIpamResourceCidrsRequest":{ + "type":"structure", + "required":["IpamScopeId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "Filters":{ + "shape":"FilterList", + "locationName":"Filter" + }, + "MaxResults":{"shape":"IpamMaxResults"}, + "NextToken":{"shape":"NextToken"}, + "IpamScopeId":{"shape":"IpamScopeId"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "ResourceId":{"shape":"String"}, + "ResourceType":{"shape":"IpamResourceType"}, + "ResourceTag":{"shape":"RequestIpamResourceTag"}, + "ResourceOwner":{"shape":"String"} + } + }, + "GetIpamResourceCidrsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "locationName":"nextToken" + }, + "IpamResourceCidrs":{ + "shape":"IpamResourceCidrSet", + "locationName":"ipamResourceCidrSet" + } + } + }, "GetLaunchTemplateDataRequest":{ "type":"structure", "required":["InstanceId"], @@ -18829,6 +19895,54 @@ } } }, + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest":{ + "type":"structure", + "required":["NetworkInsightsAccessScopeAnalysisId"], + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{"shape":"NetworkInsightsAccessScopeAnalysisId"}, + "MaxResults":{"shape":"NetworkInsightsMaxResults"}, + "NextToken":{"shape":"NextToken"}, + "DryRun":{"shape":"Boolean"} + } + }, + "GetNetworkInsightsAccessScopeAnalysisFindingsResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{ + "shape":"NetworkInsightsAccessScopeAnalysisId", + "locationName":"networkInsightsAccessScopeAnalysisId" + }, + "AnalysisStatus":{ + "shape":"AnalysisStatus", + "locationName":"analysisStatus" + }, + "AnalysisFindings":{ + "shape":"AccessScopeAnalysisFindingList", + "locationName":"analysisFindingSet" + }, + "NextToken":{ + "shape":"String", + "locationName":"nextToken" + } + } + }, + "GetNetworkInsightsAccessScopeContentRequest":{ + "type":"structure", + "required":["NetworkInsightsAccessScopeId"], + "members":{ + "NetworkInsightsAccessScopeId":{"shape":"NetworkInsightsAccessScopeId"}, + "DryRun":{"shape":"Boolean"} + } + }, + "GetNetworkInsightsAccessScopeContentResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeContent":{ + "shape":"NetworkInsightsAccessScopeContent", + "locationName":"networkInsightsAccessScopeContent" + } + } + }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], @@ -22890,6 +24004,616 @@ "locationName":"item" } }, + "Ipam":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "locationName":"ownerId" + }, + "IpamId":{ + "shape":"IpamId", + "locationName":"ipamId" + }, + "IpamArn":{ + "shape":"ResourceArn", + "locationName":"ipamArn" + }, + "IpamRegion":{ + "shape":"String", + "locationName":"ipamRegion" + }, + "PublicDefaultScopeId":{ + "shape":"IpamScopeId", + "locationName":"publicDefaultScopeId" + }, + "PrivateDefaultScopeId":{ + "shape":"IpamScopeId", + "locationName":"privateDefaultScopeId" + }, + "ScopeCount":{ + "shape":"Integer", + "locationName":"scopeCount" + }, + "Description":{ + "shape":"String", + "locationName":"description" + }, + "OperatingRegions":{ + "shape":"IpamOperatingRegionSet", + "locationName":"operatingRegionSet" + }, + "State":{ + "shape":"IpamState", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + } + }, + "IpamAddressHistoryMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "IpamAddressHistoryRecord":{ + "type":"structure", + "members":{ + "ResourceOwnerId":{ + "shape":"String", + "locationName":"resourceOwnerId" + }, + "ResourceRegion":{ + "shape":"String", + "locationName":"resourceRegion" + }, + "ResourceType":{ + "shape":"IpamAddressHistoryResourceType", + "locationName":"resourceType" + }, + "ResourceId":{ + "shape":"String", + "locationName":"resourceId" + }, + "ResourceCidr":{ + "shape":"String", + "locationName":"resourceCidr" + }, + "ResourceName":{ + "shape":"String", + "locationName":"resourceName" + }, + "ResourceComplianceStatus":{ + "shape":"IpamComplianceStatus", + "locationName":"resourceComplianceStatus" + }, + "ResourceOverlapStatus":{ + "shape":"IpamOverlapStatus", + "locationName":"resourceOverlapStatus" + }, + "VpcId":{ + "shape":"String", + "locationName":"vpcId" + }, + "SampledStartTime":{ + "shape":"MillisecondDateTime", + "locationName":"sampledStartTime" + }, + "SampledEndTime":{ + "shape":"MillisecondDateTime", + "locationName":"sampledEndTime" + } + } + }, + "IpamAddressHistoryRecordSet":{ + "type":"list", + "member":{ + "shape":"IpamAddressHistoryRecord", + "locationName":"item" + } + }, + "IpamAddressHistoryResourceType":{ + "type":"string", + "enum":[ + "eip", + "vpc", + "subnet", + "network-interface", + "instance" + ] + }, + "IpamCidrAuthorizationContext":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "Signature":{"shape":"String"} + } + }, + "IpamComplianceStatus":{ + "type":"string", + "enum":[ + "compliant", + "noncompliant", + "unmanaged", + "ignored" + ] + }, + "IpamId":{"type":"string"}, + "IpamManagementState":{ + "type":"string", + "enum":[ + "managed", + "unmanaged", + "ignored" + ] + }, + "IpamMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "IpamNetmaskLength":{ + "type":"integer", + "max":128, + "min":0 + }, + "IpamOperatingRegion":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "locationName":"regionName" + } + } + }, + "IpamOperatingRegionSet":{ + "type":"list", + "member":{ + "shape":"IpamOperatingRegion", + "locationName":"item" + } + }, + "IpamOverlapStatus":{ + "type":"string", + "enum":[ + "overlapping", + "nonoverlapping", + "ignored" + ] + }, + "IpamPool":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "locationName":"ownerId" + }, + "IpamPoolId":{ + "shape":"IpamPoolId", + "locationName":"ipamPoolId" + }, + "SourceIpamPoolId":{ + "shape":"IpamPoolId", + "locationName":"sourceIpamPoolId" + }, + "IpamPoolArn":{ + "shape":"ResourceArn", + "locationName":"ipamPoolArn" + }, + "IpamScopeArn":{ + "shape":"ResourceArn", + "locationName":"ipamScopeArn" + }, + "IpamScopeType":{ + "shape":"IpamScopeType", + "locationName":"ipamScopeType" + }, + "IpamArn":{ + "shape":"ResourceArn", + "locationName":"ipamArn" + }, + "IpamRegion":{ + "shape":"String", + "locationName":"ipamRegion" + }, + "Locale":{ + "shape":"String", + "locationName":"locale" + }, + "PoolDepth":{ + "shape":"Integer", + "locationName":"poolDepth" + }, + "State":{ + "shape":"IpamPoolState", + "locationName":"state" + }, + "StateMessage":{ + "shape":"String", + "locationName":"stateMessage" + }, + "Description":{ + "shape":"String", + "locationName":"description" + }, + "AutoImport":{ + "shape":"Boolean", + "locationName":"autoImport" + }, + "PubliclyAdvertisable":{ + "shape":"Boolean", + "locationName":"publiclyAdvertisable" + }, + "AddressFamily":{ + "shape":"AddressFamily", + "locationName":"addressFamily" + }, + "AllocationMinNetmaskLength":{ + "shape":"IpamNetmaskLength", + "locationName":"allocationMinNetmaskLength" + }, + "AllocationMaxNetmaskLength":{ + "shape":"IpamNetmaskLength", + "locationName":"allocationMaxNetmaskLength" + }, + "AllocationDefaultNetmaskLength":{ + "shape":"IpamNetmaskLength", + "locationName":"allocationDefaultNetmaskLength" + }, + "AllocationResourceTags":{ + "shape":"IpamResourceTagList", + "locationName":"allocationResourceTagSet" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + }, + "AwsService":{ + "shape":"IpamPoolAwsService", + "locationName":"awsService" + } + } + }, + "IpamPoolAllocation":{ + "type":"structure", + "members":{ + "Cidr":{ + "shape":"String", + "locationName":"cidr" + }, + "IpamPoolAllocationId":{ + "shape":"IpamPoolAllocationId", + "locationName":"ipamPoolAllocationId" + }, + "Description":{ + "shape":"String", + "locationName":"description" + }, + "ResourceId":{ + "shape":"String", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"IpamPoolAllocationResourceType", + "locationName":"resourceType" + }, + "ResourceRegion":{ + "shape":"String", + "locationName":"resourceRegion" + }, + "ResourceOwner":{ + "shape":"String", + "locationName":"resourceOwner" + } + } + }, + "IpamPoolAllocationDisallowedCidrs":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "IpamPoolAllocationId":{"type":"string"}, + "IpamPoolAllocationResourceType":{ + "type":"string", + "enum":[ + "ipam-pool", + "vpc", + "ec2-public-ipv4-pool", + "custom" + ] + }, + "IpamPoolAllocationSet":{ + "type":"list", + "member":{ + "shape":"IpamPoolAllocation", + "locationName":"item" + } + }, + "IpamPoolAwsService":{ + "type":"string", + "enum":["ec2"] + }, + "IpamPoolCidr":{ + "type":"structure", + "members":{ + "Cidr":{ + "shape":"String", + "locationName":"cidr" + }, + "State":{ + "shape":"IpamPoolCidrState", + "locationName":"state" + }, + "FailureReason":{ + "shape":"IpamPoolCidrFailureReason", + "locationName":"failureReason" + } + } + }, + "IpamPoolCidrFailureCode":{ + "type":"string", + "enum":["cidr-not-available"] + }, + "IpamPoolCidrFailureReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"IpamPoolCidrFailureCode", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "locationName":"message" + } + } + }, + "IpamPoolCidrSet":{ + "type":"list", + "member":{ + "shape":"IpamPoolCidr", + "locationName":"item" + } + }, + "IpamPoolCidrState":{ + "type":"string", + "enum":[ + "pending-provision", + "provisioned", + "failed-provision", + "pending-deprovision", + "deprovisioned", + "failed-deprovision", + "pending-import", + "failed-import" + ] + }, + "IpamPoolId":{"type":"string"}, + "IpamPoolSet":{ + "type":"list", + "member":{ + "shape":"IpamPool", + "locationName":"item" + } + }, + "IpamPoolState":{ + "type":"string", + "enum":[ + "create-in-progress", + "create-complete", + "create-failed", + "modify-in-progress", + "modify-complete", + "modify-failed", + "delete-in-progress", + "delete-complete", + "delete-failed" + ] + }, + "IpamResourceCidr":{ + "type":"structure", + "members":{ + "IpamId":{ + "shape":"IpamId", + "locationName":"ipamId" + }, + "IpamScopeId":{ + "shape":"IpamScopeId", + "locationName":"ipamScopeId" + }, + "IpamPoolId":{ + "shape":"IpamPoolId", + "locationName":"ipamPoolId" + }, + "ResourceRegion":{ + "shape":"String", + "locationName":"resourceRegion" + }, + "ResourceOwnerId":{ + "shape":"String", + "locationName":"resourceOwnerId" + }, + "ResourceId":{ + "shape":"String", + "locationName":"resourceId" + }, + "ResourceName":{ + "shape":"String", + "locationName":"resourceName" + }, + "ResourceCidr":{ + "shape":"String", + "locationName":"resourceCidr" + }, + "ResourceType":{ + "shape":"IpamResourceType", + "locationName":"resourceType" + }, + "ResourceTags":{ + "shape":"IpamResourceTagList", + "locationName":"resourceTagSet" + }, + "IpUsage":{ + "shape":"BoxedDouble", + "locationName":"ipUsage" + }, + "ComplianceStatus":{ + "shape":"IpamComplianceStatus", + "locationName":"complianceStatus" + }, + "ManagementState":{ + "shape":"IpamManagementState", + "locationName":"managementState" + }, + "OverlapStatus":{ + "shape":"IpamOverlapStatus", + "locationName":"overlapStatus" + }, + "VpcId":{ + "shape":"String", + "locationName":"vpcId" + } + } + }, + "IpamResourceCidrSet":{ + "type":"list", + "member":{ + "shape":"IpamResourceCidr", + "locationName":"item" + } + }, + "IpamResourceTag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "locationName":"value" + } + } + }, + "IpamResourceTagList":{ + "type":"list", + "member":{ + "shape":"IpamResourceTag", + "locationName":"item" + } + }, + "IpamResourceType":{ + "type":"string", + "enum":[ + "vpc", + "subnet", + "eip", + "public-ipv4-pool", + "ipv6-pool" + ] + }, + "IpamScope":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "locationName":"ownerId" + }, + "IpamScopeId":{ + "shape":"IpamScopeId", + "locationName":"ipamScopeId" + }, + "IpamScopeArn":{ + "shape":"ResourceArn", + "locationName":"ipamScopeArn" + }, + "IpamArn":{ + "shape":"ResourceArn", + "locationName":"ipamArn" + }, + "IpamRegion":{ + "shape":"String", + "locationName":"ipamRegion" + }, + "IpamScopeType":{ + "shape":"IpamScopeType", + "locationName":"ipamScopeType" + }, + "IsDefault":{ + "shape":"Boolean", + "locationName":"isDefault" + }, + "Description":{ + "shape":"String", + "locationName":"description" + }, + "PoolCount":{ + "shape":"Integer", + "locationName":"poolCount" + }, + "State":{ + "shape":"IpamScopeState", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + } + }, + "IpamScopeId":{"type":"string"}, + "IpamScopeSet":{ + "type":"list", + "member":{ + "shape":"IpamScope", + "locationName":"item" + } + }, + "IpamScopeState":{ + "type":"string", + "enum":[ + "create-in-progress", + "create-complete", + "create-failed", + "modify-in-progress", + "modify-complete", + "modify-failed", + "delete-in-progress", + "delete-complete", + "delete-failed" + ] + }, + "IpamScopeType":{ + "type":"string", + "enum":[ + "public", + "private" + ] + }, + "IpamSet":{ + "type":"list", + "member":{ + "shape":"Ipam", + "locationName":"item" + } + }, + "IpamState":{ + "type":"string", + "enum":[ + "create-in-progress", + "create-complete", + "create-failed", + "modify-in-progress", + "modify-complete", + "modify-failed", + "delete-in-progress", + "delete-complete", + "delete-failed" + ] + }, "Ipv4PoolEc2Id":{"type":"string"}, "Ipv4PrefixList":{ "type":"list", @@ -25292,6 +27016,109 @@ } } }, + "ModifyIpamPoolRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Description":{"shape":"String"}, + "AutoImport":{"shape":"Boolean"}, + "AllocationMinNetmaskLength":{"shape":"IpamNetmaskLength"}, + "AllocationMaxNetmaskLength":{"shape":"IpamNetmaskLength"}, + "AllocationDefaultNetmaskLength":{"shape":"IpamNetmaskLength"}, + "ClearAllocationDefaultNetmaskLength":{"shape":"Boolean"}, + "AddAllocationResourceTags":{ + "shape":"RequestIpamResourceTagList", + "locationName":"AddAllocationResourceTag" + }, + "RemoveAllocationResourceTags":{ + "shape":"RequestIpamResourceTagList", + "locationName":"RemoveAllocationResourceTag" + } + } + }, + "ModifyIpamPoolResult":{ + "type":"structure", + "members":{ + "IpamPool":{ + "shape":"IpamPool", + "locationName":"ipamPool" + } + } + }, + "ModifyIpamRequest":{ + "type":"structure", + "required":["IpamId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamId":{"shape":"IpamId"}, + "Description":{"shape":"String"}, + "AddOperatingRegions":{ + "shape":"AddIpamOperatingRegionSet", + "locationName":"AddOperatingRegion" + }, + "RemoveOperatingRegions":{ + "shape":"RemoveIpamOperatingRegionSet", + "locationName":"RemoveOperatingRegion" + } + } + }, + "ModifyIpamResourceCidrRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "ResourceCidr", + "ResourceRegion", + "CurrentIpamScopeId", + "Monitored" + ], + "members":{ + "DryRun":{"shape":"Boolean"}, + "ResourceId":{"shape":"String"}, + "ResourceCidr":{"shape":"String"}, + "ResourceRegion":{"shape":"String"}, + "CurrentIpamScopeId":{"shape":"IpamScopeId"}, + "DestinationIpamScopeId":{"shape":"IpamScopeId"}, + "Monitored":{"shape":"Boolean"} + } + }, + "ModifyIpamResourceCidrResult":{ + "type":"structure", + "members":{ + "IpamResourceCidr":{ + "shape":"IpamResourceCidr", + "locationName":"ipamResourceCidr" + } + } + }, + "ModifyIpamResult":{ + "type":"structure", + "members":{ + "Ipam":{ + "shape":"Ipam", + "locationName":"ipam" + } + } + }, + "ModifyIpamScopeRequest":{ + "type":"structure", + "required":["IpamScopeId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamScopeId":{"shape":"IpamScopeId"}, + "Description":{"shape":"String"} + } + }, + "ModifyIpamScopeResult":{ + "type":"structure", + "members":{ + "IpamScope":{ + "shape":"IpamScope", + "locationName":"ipamScope" + } + } + }, "ModifyLaunchTemplateRequest":{ "type":"structure", "members":{ @@ -26113,6 +27940,24 @@ } } }, + "MoveByoipCidrToIpamRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Cidr":{"shape":"String"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "IpamPoolOwner":{"shape":"String"} + } + }, + "MoveByoipCidrToIpamResult":{ + "type":"structure", + "members":{ + "ByoipCidr":{ + "shape":"ByoipCidr", + "locationName":"byoipCidr" + } + } + }, "MoveStatus":{ "type":"string", "enum":[ @@ -26253,6 +28098,7 @@ "deleted" ] }, + "NetmaskLength":{"type":"integer"}, "NetworkAcl":{ "type":"structure", "members":{ @@ -26448,6 +28294,127 @@ } } }, + "NetworkInsightsAccessScope":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeId":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"networkInsightsAccessScopeId" + }, + "NetworkInsightsAccessScopeArn":{ + "shape":"ResourceArn", + "locationName":"networkInsightsAccessScopeArn" + }, + "CreatedDate":{ + "shape":"MillisecondDateTime", + "locationName":"createdDate" + }, + "UpdatedDate":{ + "shape":"MillisecondDateTime", + "locationName":"updatedDate" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + } + }, + "NetworkInsightsAccessScopeAnalysis":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysisId":{ + "shape":"NetworkInsightsAccessScopeAnalysisId", + "locationName":"networkInsightsAccessScopeAnalysisId" + }, + "NetworkInsightsAccessScopeAnalysisArn":{ + "shape":"ResourceArn", + "locationName":"networkInsightsAccessScopeAnalysisArn" + }, + "NetworkInsightsAccessScopeId":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"networkInsightsAccessScopeId" + }, + "Status":{ + "shape":"AnalysisStatus", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "locationName":"statusMessage" + }, + "WarningMessage":{ + "shape":"String", + "locationName":"warningMessage" + }, + "StartDate":{ + "shape":"MillisecondDateTime", + "locationName":"startDate" + }, + "EndDate":{ + "shape":"MillisecondDateTime", + "locationName":"endDate" + }, + "FindingsFound":{ + "shape":"FindingsFound", + "locationName":"findingsFound" + }, + "AnalyzedEniCount":{ + "shape":"Integer", + "locationName":"analyzedEniCount" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + } + }, + "NetworkInsightsAccessScopeAnalysisId":{"type":"string"}, + "NetworkInsightsAccessScopeAnalysisIdList":{ + "type":"list", + "member":{ + "shape":"NetworkInsightsAccessScopeAnalysisId", + "locationName":"item" + } + }, + "NetworkInsightsAccessScopeAnalysisList":{ + "type":"list", + "member":{ + "shape":"NetworkInsightsAccessScopeAnalysis", + "locationName":"item" + } + }, + "NetworkInsightsAccessScopeContent":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeId":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"networkInsightsAccessScopeId" + }, + "MatchPaths":{ + "shape":"AccessScopePathList", + "locationName":"matchPathSet" + }, + "ExcludePaths":{ + "shape":"AccessScopePathList", + "locationName":"excludePathSet" + } + } + }, + "NetworkInsightsAccessScopeId":{"type":"string"}, + "NetworkInsightsAccessScopeIdList":{ + "type":"list", + "member":{ + "shape":"NetworkInsightsAccessScopeId", + "locationName":"item" + } + }, + "NetworkInsightsAccessScopeList":{ + "type":"list", + "member":{ + "shape":"NetworkInsightsAccessScope", + "locationName":"item" + } + }, "NetworkInsightsAnalysis":{ "type":"structure", "members":{ @@ -26479,6 +28446,10 @@ "shape":"String", "locationName":"statusMessage" }, + "WarningMessage":{ + "shape":"String", + "locationName":"warningMessage" + }, "NetworkPathFound":{ "shape":"Boolean", "locationName":"networkPathFound" @@ -27090,6 +29061,72 @@ "locationName":"Owner" } }, + "PacketHeaderStatement":{ + "type":"structure", + "members":{ + "SourceAddresses":{ + "shape":"ValueStringList", + "locationName":"sourceAddressSet" + }, + "DestinationAddresses":{ + "shape":"ValueStringList", + "locationName":"destinationAddressSet" + }, + "SourcePorts":{ + "shape":"ValueStringList", + "locationName":"sourcePortSet" + }, + "DestinationPorts":{ + "shape":"ValueStringList", + "locationName":"destinationPortSet" + }, + "SourcePrefixLists":{ + "shape":"ValueStringList", + "locationName":"sourcePrefixListSet" + }, + "DestinationPrefixLists":{ + "shape":"ValueStringList", + "locationName":"destinationPrefixListSet" + }, + "Protocols":{ + "shape":"ProtocolList", + "locationName":"protocolSet" + } + } + }, + "PacketHeaderStatementRequest":{ + "type":"structure", + "members":{ + "SourceAddresses":{ + "shape":"ValueStringList", + "locationName":"SourceAddress" + }, + "DestinationAddresses":{ + "shape":"ValueStringList", + "locationName":"DestinationAddress" + }, + "SourcePorts":{ + "shape":"ValueStringList", + "locationName":"SourcePort" + }, + "DestinationPorts":{ + "shape":"ValueStringList", + "locationName":"DestinationPort" + }, + "SourcePrefixLists":{ + "shape":"ValueStringList", + "locationName":"SourcePrefixList" + }, + "DestinationPrefixLists":{ + "shape":"ValueStringList", + "locationName":"DestinationPrefixList" + }, + "Protocols":{ + "shape":"ProtocolList", + "locationName":"Protocol" + } + } + }, "PartitionLoadFrequency":{ "type":"string", "enum":[ @@ -27110,6 +29147,10 @@ "shape":"AnalysisAclRule", "locationName":"aclRule" }, + "AttachedTo":{ + "shape":"AnalysisComponent", + "locationName":"attachedTo" + }, "Component":{ "shape":"AnalysisComponent", "locationName":"component" @@ -27155,6 +29196,26 @@ "locationName":"item" } }, + "PathStatement":{ + "type":"structure", + "members":{ + "PacketHeaderStatement":{ + "shape":"PacketHeaderStatement", + "locationName":"packetHeaderStatement" + }, + "ResourceStatement":{ + "shape":"ResourceStatement", + "locationName":"resourceStatement" + } + } + }, + "PathStatementRequest":{ + "type":"structure", + "members":{ + "PacketHeaderStatement":{"shape":"PacketHeaderStatementRequest"}, + "ResourceStatement":{"shape":"ResourceStatementRequest"} + } + }, "PaymentOption":{ "type":"string", "enum":[ @@ -28003,6 +30064,13 @@ "udp" ] }, + "ProtocolList":{ + "type":"list", + "member":{ + "shape":"Protocol", + "locationName":"item" + } + }, "ProtocolValue":{ "type":"string", "enum":["gre"] @@ -28032,6 +30100,52 @@ } } }, + "ProvisionIpamPoolCidrRequest":{ + "type":"structure", + "required":["IpamPoolId"], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Cidr":{"shape":"String"}, + "CidrAuthorizationContext":{"shape":"IpamCidrAuthorizationContext"} + } + }, + "ProvisionIpamPoolCidrResult":{ + "type":"structure", + "members":{ + "IpamPoolCidr":{ + "shape":"IpamPoolCidr", + "locationName":"ipamPoolCidr" + } + } + }, + "ProvisionPublicIpv4PoolCidrRequest":{ + "type":"structure", + "required":[ + "IpamPoolId", + "PoolId", + "NetmaskLength" + ], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "PoolId":{"shape":"Ipv4PoolEc2Id"}, + "NetmaskLength":{"shape":"Integer"} + } + }, + "ProvisionPublicIpv4PoolCidrResult":{ + "type":"structure", + "members":{ + "PoolId":{ + "shape":"Ipv4PoolEc2Id", + "locationName":"poolId" + }, + "PoolAddressRange":{ + "shape":"PublicIpv4PoolRange", + "locationName":"poolAddressRange" + } + } + }, "ProvisionedBandwidth":{ "type":"structure", "members":{ @@ -28701,6 +30815,40 @@ } } }, + "ReleaseIpamPoolAllocationRequest":{ + "type":"structure", + "required":[ + "IpamPoolId", + "Cidr" + ], + "members":{ + "DryRun":{"shape":"Boolean"}, + "IpamPoolId":{"shape":"IpamPoolId"}, + "Cidr":{"shape":"String"}, + "IpamPoolAllocationId":{"shape":"IpamPoolAllocationId"} + } + }, + "ReleaseIpamPoolAllocationResult":{ + "type":"structure", + "members":{ + "Success":{ + "shape":"Boolean", + "locationName":"success" + } + } + }, + "RemoveIpamOperatingRegion":{ + "type":"structure", + "members":{ + "RegionName":{"shape":"String"} + } + }, + "RemoveIpamOperatingRegionSet":{ + "type":"list", + "member":{"shape":"RemoveIpamOperatingRegion"}, + "max":50, + "min":0 + }, "RemovePrefixListEntries":{ "type":"list", "member":{"shape":"RemovePrefixListEntry"}, @@ -29068,6 +31216,20 @@ "max":100, "min":0 }, + "RequestIpamResourceTag":{ + "type":"structure", + "members":{ + "Key":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "RequestIpamResourceTagList":{ + "type":"list", + "member":{ + "shape":"RequestIpamResourceTag", + "locationName":"item" + } + }, "RequestLaunchTemplateData":{ "type":"structure", "members":{ @@ -29910,6 +32072,32 @@ "locationName":"item" } }, + "ResourceStatement":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"ValueStringList", + "locationName":"resourceSet" + }, + "ResourceTypes":{ + "shape":"ValueStringList", + "locationName":"resourceTypeSet" + } + } + }, + "ResourceStatementRequest":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"ValueStringList", + "locationName":"Resource" + }, + "ResourceTypes":{ + "shape":"ValueStringList", + "locationName":"ResourceType" + } + } + }, "ResourceType":{ "type":"string", "enum":[ @@ -29933,6 +32121,9 @@ "instance", "instance-event-window", "internet-gateway", + "ipam", + "ipam-pool", + "ipam-scope", "ipv4pool-ec2", "ipv6pool-ec2", "key-pair", @@ -29948,6 +32139,8 @@ "network-interface", "network-insights-analysis", "network-insights-path", + "network-insights-access-scope", + "network-insights-access-scope-analysis", "placement-group", "prefix-list", "replace-root-volume-task", @@ -32663,6 +34856,34 @@ } } }, + "StartNetworkInsightsAccessScopeAnalysisRequest":{ + "type":"structure", + "required":[ + "NetworkInsightsAccessScopeId", + "ClientToken" + ], + "members":{ + "NetworkInsightsAccessScopeId":{"shape":"NetworkInsightsAccessScopeId"}, + "DryRun":{"shape":"Boolean"}, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" + }, + "ClientToken":{ + "shape":"String", + "idempotencyToken":true + } + } + }, + "StartNetworkInsightsAccessScopeAnalysisResult":{ + "type":"structure", + "members":{ + "NetworkInsightsAccessScopeAnalysis":{ + "shape":"NetworkInsightsAccessScopeAnalysis", + "locationName":"networkInsightsAccessScopeAnalysis" + } + } + }, "StartNetworkInsightsAnalysisRequest":{ "type":"structure", "required":[ @@ -33457,6 +35678,35 @@ "locationName":"item" } }, + "ThroughResourcesStatement":{ + "type":"structure", + "members":{ + "ResourceStatement":{ + "shape":"ResourceStatement", + "locationName":"resourceStatement" + } + } + }, + "ThroughResourcesStatementList":{ + "type":"list", + "member":{ + "shape":"ThroughResourcesStatement", + "locationName":"item" + } + }, + "ThroughResourcesStatementRequest":{ + "type":"structure", + "members":{ + "ResourceStatement":{"shape":"ResourceStatementRequest"} + } + }, + "ThroughResourcesStatementRequestList":{ + "type":"list", + "member":{ + "shape":"ThroughResourcesStatementRequest", + "locationName":"item" + } + }, "TieringOperationStatus":{ "type":"string", "enum":[ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index b99095655a7..46d346163e5 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -11,6 +11,7 @@ "AdvertiseByoipCidr": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

", "AllocateAddress": "

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

", "AllocateHosts": "

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

", + "AllocateIpamPoolCidr": "

Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.

", "ApplySecurityGroupsToClientVpnTargetNetwork": "

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

", "AssignIpv6Addresses": "

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

You must specify either the IPv6 addresses or the IPv6 address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

", "AssignPrivateIpAddresses": "

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

", @@ -65,6 +66,9 @@ "CreateInstanceEventWindow": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

", "CreateInstanceExportTask": "

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

", "CreateInternetGateway": "

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

", + "CreateIpam": "

Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "CreateIpamPool": "

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.

", + "CreateIpamScope": "

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

", "CreateKeyPair": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

You can have up to 5,000 key pairs per Amazon Web Services Region.

For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

", "CreateLaunchTemplate": "

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.

", "CreateLaunchTemplateVersion": "

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

", @@ -74,10 +78,12 @@ "CreateNatGateway": "

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

", "CreateNetworkAcl": "

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

", "CreateNetworkAclEntry": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

", + "CreateNetworkInsightsAccessScope": "

Creates a Network Access Scope.

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

", "CreateNetworkInsightsPath": "

Creates a path to analyze for reachability.

Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.

", "CreateNetworkInterface": "

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

", "CreateNetworkInterfacePermission": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

", "CreatePlacementGroup": "

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon EC2 User Guide.

", + "CreatePublicIpv4Pool": "

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

", "CreateReplaceRootVolumeTask": "

Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

", "CreateReservedInstancesListing": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

", "CreateRestoreImageTask": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

", @@ -124,6 +130,9 @@ "DeleteFpgaImage": "

Deletes the specified Amazon FPGA Image (AFI).

", "DeleteInstanceEventWindow": "

Deletes the specified event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

", "DeleteInternetGateway": "

Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

", + "DeleteIpam": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

You cannot delete an IPAM if there are CIDRs provisioned to pools or if there are allocations in the pools within the IPAM. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr. To release allocations, see ReleaseIpamPoolAllocation.

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.

", + "DeleteIpamPool": "

Delete an IPAM pool.

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

", + "DeleteIpamScope": "

Delete the scope for an IPAM. You cannot delete the default scopes.

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

", "DeleteKeyPair": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

", "DeleteLaunchTemplate": "

Deletes a launch template. Deleting a launch template deletes all of its versions.

", "DeleteLaunchTemplateVersions": "

Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.

", @@ -133,11 +142,14 @@ "DeleteNatGateway": "

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

", "DeleteNetworkAcl": "

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

", "DeleteNetworkAclEntry": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

", + "DeleteNetworkInsightsAccessScope": "

Deletes the specified Network Access Scope.

", + "DeleteNetworkInsightsAccessScopeAnalysis": "

Deletes the specified Network Access Scope analysis.

", "DeleteNetworkInsightsAnalysis": "

Deletes the specified network insights analysis.

", "DeleteNetworkInsightsPath": "

Deletes the specified path.

", "DeleteNetworkInterface": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

", "DeleteNetworkInterfacePermission": "

Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.

", "DeletePlacementGroup": "

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.

", + "DeletePublicIpv4Pool": "

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

", "DeleteQueuedReservedInstances": "

Deletes the queued purchases for the specified Reserved Instances.

", "DeleteRoute": "

Deletes the specified route from the specified route table.

", "DeleteRouteTable": "

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

", @@ -170,6 +182,8 @@ "DeleteVpnConnectionRoute": "

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

", "DeleteVpnGateway": "

Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

", "DeprovisionByoipCidr": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

", + "DeprovisionIpamPoolCidr": "

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

", + "DeprovisionPublicIpv4PoolCidr": "

Deprovision a CIDR from a public IPv4 pool.

", "DeregisterImage": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

", "DeregisterInstanceEventNotificationAttributes": "

c

Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.

", "DeregisterTransitGatewayMulticastGroupMembers": "

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

", @@ -224,6 +238,9 @@ "DescribeInstanceTypes": "

Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.

", "DescribeInstances": "

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

", "DescribeInternetGateways": "

Describes one or more of your internet gateways.

", + "DescribeIpamPools": "

Get information about your IPAM pools.

", + "DescribeIpamScopes": "

Get information about your IPAM scopes.

", + "DescribeIpams": "

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

", "DescribeIpv6Pools": "

Describes your IPv6 address pools.

", "DescribeKeyPairs": "

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

", "DescribeLaunchTemplateVersions": "

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.

", @@ -238,6 +255,8 @@ "DescribeMovingAddresses": "

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

", "DescribeNatGateways": "

Describes one or more of your NAT gateways.

", "DescribeNetworkAcls": "

Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

", + "DescribeNetworkInsightsAccessScopeAnalyses": "

Describes the specified Network Access Scope analyses.

", + "DescribeNetworkInsightsAccessScopes": "

Describes the specified Network Access Scopes.

", "DescribeNetworkInsightsAnalyses": "

Describes one or more of your network insights analyses.

", "DescribeNetworkInsightsPaths": "

Describes one or more of your paths.

", "DescribeNetworkInterfaceAttribute": "

Describes a network interface attribute. You can specify only one attribute at a time.

", @@ -309,6 +328,7 @@ "DisableEbsEncryptionByDefault": "

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

", "DisableFastSnapshotRestores": "

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

", "DisableImageDeprecation": "

Cancels the deprecation of the specified AMI.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

", + "DisableIpamOrganizationAdminAccount": "

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.

", "DisableSerialConsoleAccess": "

Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.

", "DisableTransitGatewayRouteTablePropagation": "

Disables the specified resource attachment from propagating routes to the specified propagation route table.

", "DisableVgwRoutePropagation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

", @@ -328,6 +348,7 @@ "EnableEbsEncryptionByDefault": "

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.

", "EnableFastSnapshotRestores": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.

For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.

", "EnableImageDeprecation": "

Enables deprecation of the specified AMI at the specified date and time.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

", + "EnableIpamOrganizationAdminAccount": "

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.

", "EnableSerialConsoleAccess": "

Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.

", "EnableTransitGatewayRouteTablePropagation": "

Enables the specified attachment to propagate routes to the specified propagation route table.

", "EnableVgwRoutePropagation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

", @@ -351,9 +372,15 @@ "GetGroupsForCapacityReservation": "

Lists the resource groups to which a Capacity Reservation has been added.

", "GetHostReservationPurchasePreview": "

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

", "GetInstanceTypesFromInstanceRequirements": "

Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

", + "GetIpamAddressHistory": "

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

", + "GetIpamPoolAllocations": "

Get a list of all the CIDR allocations in an IPAM pool.

", + "GetIpamPoolCidrs": "

Get the CIDRs provisioned to an IPAM pool.

", + "GetIpamResourceCidrs": "

Get information about the resources in a scope.

", "GetLaunchTemplateData": "

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.

", "GetManagedPrefixListAssociations": "

Gets information about the resources that are associated with the specified managed prefix list.

", "GetManagedPrefixListEntries": "

Gets information about the entries for a specified managed prefix list.

", + "GetNetworkInsightsAccessScopeAnalysisFindings": "

Gets the findings for the specified Network Access Scope analysis.

", + "GetNetworkInsightsAccessScopeContent": "

Gets the content for the specified Network Access Scope.

", "GetPasswordData": "

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

", "GetReservedInstancesExchangeQuote": "

Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

", "GetSerialConsoleAccessStatus": "

Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.

", @@ -393,6 +420,10 @@ "ModifyInstanceEventWindow": "

Modifies the specified event window.

You can define either a set of time ranges or a cron expression when modifying the event window, but not both.

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

", "ModifyInstanceMetadataOptions": "

Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

", "ModifyInstancePlacement": "

Modifies the placement attributes for a specified instance. You can do the following:

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

", + "ModifyIpam": "

Modify the configurations of an IPAM.

", + "ModifyIpamPool": "

Modify the configurations of an IPAM pool.

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

", + "ModifyIpamResourceCidr": "

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

", + "ModifyIpamScope": "

Modify an IPAM scope.

", "ModifyLaunchTemplate": "

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

", "ModifyManagedPrefixList": "

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

", "ModifyNetworkInterfaceAttribute": "

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

", @@ -424,7 +455,10 @@ "ModifyVpnTunnelOptions": "

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

", "MonitorInstances": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.

To disable detailed monitoring, see .

", "MoveAddressToVpc": "

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

", + "MoveByoipCidrToIpam": "

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

", "ProvisionByoipCidr": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

", + "ProvisionIpamPoolCidr": "

Provision a CIDR to an IPAM pool. You can use thsi action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

", + "ProvisionPublicIpv4PoolCidr": "

Provision a CIDR to a public IPv4 pool.

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

", "PurchaseHostReservation": "

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

", "PurchaseReservedInstancesOffering": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.

", "PurchaseScheduledInstances": "

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

", @@ -440,6 +474,7 @@ "RejectVpcPeeringConnection": "

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

", "ReleaseAddress": "

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

", "ReleaseHosts": "

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

", + "ReleaseIpamPoolAllocation": "

Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.

", "ReplaceIamInstanceProfileAssociation": "

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

", "ReplaceNetworkAclAssociation": "

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

This is an idempotent operation.

", "ReplaceNetworkAclEntry": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

", @@ -470,6 +505,7 @@ "SearchTransitGatewayRoutes": "

Searches for routes in the specified transit gateway route table.

", "SendDiagnosticInterrupt": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).

", "StartInstances": "

Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.

For more information, see Stop and start your instance in the Amazon EC2 User Guide.

", + "StartNetworkInsightsAccessScopeAnalysis": "

Starts analyzing the specified Network Access Scope.

", "StartNetworkInsightsAnalysis": "

Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

", "StartVpcEndpointServicePrivateDnsVerification": "

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.

", "StopInstances": "

Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.

", @@ -606,6 +642,44 @@ "refs": { } }, + "AccessScopeAnalysisFinding": { + "base": "

Describes a finding for a Network Access Scope.

", + "refs": { + "AccessScopeAnalysisFindingList$member": null + } + }, + "AccessScopeAnalysisFindingList": { + "base": null, + "refs": { + "GetNetworkInsightsAccessScopeAnalysisFindingsResult$AnalysisFindings": "

The findings associated with Network Access Scope Analysis.

" + } + }, + "AccessScopePath": { + "base": "

Describes a path.

", + "refs": { + "AccessScopePathList$member": null + } + }, + "AccessScopePathList": { + "base": null, + "refs": { + "NetworkInsightsAccessScopeContent$MatchPaths": "

The paths to match.

", + "NetworkInsightsAccessScopeContent$ExcludePaths": "

The paths to exclude.

" + } + }, + "AccessScopePathListRequest": { + "base": null, + "refs": { + "CreateNetworkInsightsAccessScopeRequest$MatchPaths": "

The paths to match.

", + "CreateNetworkInsightsAccessScopeRequest$ExcludePaths": "

The paths to exclude.

" + } + }, + "AccessScopePathRequest": { + "base": "

Describes a path.

", + "refs": { + "AccessScopePathListRequest$member": null + } + }, "AccountAttribute": { "base": "

Describes an account attribute.

", "refs": { @@ -661,6 +735,19 @@ "SpotFleetRequestConfig$ActivityStatus": "

The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.

" } }, + "AddIpamOperatingRegion": { + "base": "

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "refs": { + "AddIpamOperatingRegionSet$member": null + } + }, + "AddIpamOperatingRegionSet": { + "base": null, + "refs": { + "CreateIpamRequest$OperatingRegions": "

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "ModifyIpamRequest$AddOperatingRegions": "

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

" + } + }, "AddPrefixListEntries": { "base": null, "refs": { @@ -695,6 +782,13 @@ "ResetAddressAttributeRequest$Attribute": "

The attribute of the IP address.

" } }, + "AddressFamily": { + "base": null, + "refs": { + "CreateIpamPoolRequest$AddressFamily": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

", + "IpamPool$AddressFamily": "

The address family of the pool.

" + } + }, "AddressList": { "base": null, "refs": { @@ -749,6 +843,16 @@ "refs": { } }, + "AllocateIpamPoolCidrRequest": { + "base": null, + "refs": { + } + }, + "AllocateIpamPoolCidrResult": { + "base": null, + "refs": { + } + }, "AllocationId": { "base": null, "refs": { @@ -851,6 +955,7 @@ "Explanation$VpcEndpoint": "

The VPC endpoint.

", "Explanation$VpnConnection": "

The VPN connection.

", "Explanation$VpnGateway": "

The VPN gateway.

", + "PathComponent$AttachedTo": "

The resource to which the path component is attached.

", "PathComponent$Component": "

The component.

", "PathComponent$DestinationVpc": "

The destination VPC.

", "PathComponent$SourceVpc": "

The source VPC.

", @@ -901,6 +1006,8 @@ "AnalysisStatus": { "base": null, "refs": { + "GetNetworkInsightsAccessScopeAnalysisFindingsResult$AnalysisStatus": "

The status of Network Access Scope Analysis.

", + "NetworkInsightsAccessScopeAnalysis$Status": "

The status.

", "NetworkInsightsAnalysis$Status": "

The status of the network insights analysis.

" } }, @@ -1510,6 +1617,8 @@ "AcceptVpcPeeringConnectionRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "AdvertiseByoipCidrRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "AllocateAddressRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "AllocateIpamPoolCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "AllocateIpamPoolCidrRequest$PreviewNextCidr": "

A preview of the next available CIDR in a pool.

", "AnalysisAclRule$Egress": "

Indicates whether the rule is an outbound rule.

", "ApplySecurityGroupsToClientVpnTargetNetworkRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "AssignPrivateIpAddressesRequest$AllowReassignment": "

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", @@ -1586,6 +1695,11 @@ "CreateImageRequest$NoReboot": "

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted at the same time), but not application consistent (all the operating system buffers are not flushed to disk before the snapshots are created).

", "CreateInstanceEventWindowRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateInternetGatewayRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "CreateIpamPoolRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "CreateIpamPoolRequest$AutoImport": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

", + "CreateIpamPoolRequest$PubliclyAdvertisable": "

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

", + "CreateIpamRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "CreateIpamScopeRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateKeyPairRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateLaunchTemplateRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateLaunchTemplateVersionRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1596,10 +1710,12 @@ "CreateNetworkAclEntryRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateNetworkAclEntryRequest$Egress": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "CreateNetworkAclRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "CreateNetworkInsightsAccessScopeRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateNetworkInsightsPathRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateNetworkInterfacePermissionRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateNetworkInterfaceRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreatePlacementGroupRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "CreatePublicIpv4PoolRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateReplaceRootVolumeTaskRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateRestoreImageTaskRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "CreateRouteRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1657,6 +1773,9 @@ "DeleteInstanceEventWindowRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteInstanceEventWindowRequest$ForceDelete": "

Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.

", "DeleteInternetGatewayRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeleteIpamPoolRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeleteIpamRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeleteIpamScopeRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteKeyPairRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteLaunchTemplateRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteLaunchTemplateVersionsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1667,6 +1786,8 @@ "DeleteNetworkAclEntryRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteNetworkAclEntryRequest$Egress": "

Indicates whether the rule is an egress rule.

", "DeleteNetworkAclRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeleteNetworkInsightsAccessScopeAnalysisRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeleteNetworkInsightsAccessScopeRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteNetworkInsightsAnalysisRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteNetworkInsightsPathRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteNetworkInterfacePermissionRequest$Force": "

Specify true to remove the permission even if the network interface is attached to an instance.

", @@ -1674,6 +1795,8 @@ "DeleteNetworkInterfacePermissionResult$Return": "

Returns true if the request succeeds, otherwise returns an error.

", "DeleteNetworkInterfaceRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeletePlacementGroupRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeletePublicIpv4PoolRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeletePublicIpv4PoolResult$ReturnValue": "

Information about the result of deleting the public IPv4 pool.

", "DeleteQueuedReservedInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteRouteRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteRouteTableRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1706,6 +1829,8 @@ "DeleteVpnConnectionRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeleteVpnGatewayRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeprovisionByoipCidrRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeprovisionIpamPoolCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DeprovisionPublicIpv4PoolCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeregisterImageRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeregisterInstanceEventNotificationAttributesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DeregisterInstanceTagAttributeRequest$IncludeAllTagsOfInstance": "

Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.

", @@ -1758,6 +1883,9 @@ "DescribeInstanceTypesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeInternetGatewaysRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DescribeIpamPoolsRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DescribeIpamScopesRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DescribeIpamsRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeIpv6PoolsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeKeyPairsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeLaunchTemplateVersionsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1772,6 +1900,8 @@ "DescribeMovingAddressesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeNatGatewaysRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeNetworkAclsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DescribeNetworkInsightsAccessScopesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeNetworkInsightsAnalysesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeNetworkInsightsPathsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DescribeNetworkInterfaceAttributeRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1849,6 +1979,8 @@ "DisableFastSnapshotRestoresRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DisableImageDeprecationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DisableImageDeprecationResult$Return": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "DisableIpamOrganizationAdminAccountRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "DisableIpamOrganizationAdminAccountResult$Success": "

The result of disabling the IPAM account.

", "DisableSerialConsoleAccessRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "DisableSerialConsoleAccessResult$SerialConsoleAccessEnabled": "

If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.

", "DisableTransitGatewayRouteTablePropagationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1876,6 +2008,8 @@ "EnableFastSnapshotRestoresRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "EnableImageDeprecationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "EnableImageDeprecationResult$Return": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "EnableIpamOrganizationAdminAccountRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "EnableIpamOrganizationAdminAccountResult$Success": "

The result of enabling the IPAM account.

", "EnableSerialConsoleAccessRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "EnableSerialConsoleAccessResult$SerialConsoleAccessEnabled": "

If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.

", "EnableTransitGatewayRouteTablePropagationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -1910,9 +2044,15 @@ "GetFlowLogsIntegrationTemplateRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetGroupsForCapacityReservationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetInstanceTypesFromInstanceRequirementsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetIpamAddressHistoryRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetIpamPoolAllocationsRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetIpamPoolCidrsRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetIpamResourceCidrsRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetLaunchTemplateDataRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetManagedPrefixListAssociationsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetManagedPrefixListEntriesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "GetNetworkInsightsAccessScopeContentRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetPasswordDataRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetReservedInstancesExchangeQuoteRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "GetReservedInstancesExchangeQuoteResult$IsValidExchange": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", @@ -1959,6 +2099,9 @@ "InstanceRequirementsRequest$RequireHibernateSupport": "

Indicates whether instance types must support hibernation for On-Demand Instances.

This parameter is not supported for GetSpotPlacementScores.

Default: false

", "InstanceSpecification$ExcludeBootVolume": "

Excludes the root volume from being snapshotted.

", "InstanceTagNotificationAttribute$IncludeAllTagsOfInstance": "

Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.

", + "IpamPool$AutoImport": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

", + "IpamPool$PubliclyAdvertisable": "

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

", + "IpamScope$IsDefault": "

Defines if the scope is the default scope or not.

", "LaunchSpecification$EbsOptimized": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "LaunchTemplateEbsBlockDevice$Encrypted": "

Indicates whether the EBS volume is encrypted.

", "LaunchTemplateEbsBlockDevice$DeleteOnTermination": "

Indicates whether the EBS volume is deleted on instance termination.

", @@ -2010,6 +2153,13 @@ "ModifyInstanceEventWindowRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ModifyInstanceMetadataOptionsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ModifyInstancePlacementResult$Return": "

Is true if the request succeeds, and an error otherwise.

", + "ModifyIpamPoolRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ModifyIpamPoolRequest$AutoImport": "

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

", + "ModifyIpamPoolRequest$ClearAllocationDefaultNetmaskLength": "

Clear the default netmask length allocation rule for this pool.

", + "ModifyIpamRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ModifyIpamResourceCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ModifyIpamResourceCidrRequest$Monitored": "

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

", + "ModifyIpamScopeRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ModifyLaunchTemplateRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ModifyManagedPrefixListRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ModifyNetworkInterfaceAttributeRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -2053,6 +2203,7 @@ "ModifyVpnTunnelOptionsRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "MonitorInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "MoveAddressToVpcRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "MoveByoipCidrToIpamRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "NetworkAcl$IsDefault": "

Indicates whether this is the default network ACL for the VPC.

", "NetworkAclEntry$Egress": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "NetworkInsightsAnalysis$NetworkPathFound": "

Indicates whether the destination is reachable from the source.

", @@ -2084,6 +2235,8 @@ "ProvisionByoipCidrRequest$PubliclyAdvertisable": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

", "ProvisionByoipCidrRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ProvisionByoipCidrRequest$MultiRegion": "

Reserved.

", + "ProvisionIpamPoolCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ProvisionPublicIpv4PoolCidrRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "PurchaseReservedInstancesOfferingRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "PurchaseScheduledInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "RebootInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -2100,6 +2253,8 @@ "RejectVpcPeeringConnectionRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "RejectVpcPeeringConnectionResult$Return": "

Returns true if the request succeeds; otherwise, it returns an error.

", "ReleaseAddressRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ReleaseIpamPoolAllocationRequest$DryRun": "

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "ReleaseIpamPoolAllocationResult$Success": "

Indicates if the release was successful.

", "ReplaceNetworkAclAssociationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ReplaceNetworkAclEntryRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "ReplaceNetworkAclEntryRequest$Egress": "

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", @@ -2177,6 +2332,7 @@ "SpotOptionsRequest$SingleInstanceType": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Supported only for fleets of type instant.

", "SpotOptionsRequest$SingleAvailabilityZone": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Supported only for fleets of type instant.

", "StartInstancesRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "StartNetworkInsightsAccessScopeAnalysisRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "StartNetworkInsightsAnalysisRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "StartVpcEndpointServicePrivateDnsVerificationRequest$DryRun": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "StartVpcEndpointServicePrivateDnsVerificationResult$ReturnValue": "

Returns true if the request succeeds; otherwise, it returns an error.

", @@ -2243,6 +2399,12 @@ "RegisterImageRequest$BootMode": "

The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.

" } }, + "BoxedDouble": { + "base": null, + "refs": { + "IpamResourceCidr$IpUsage": "

The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.

" + } + }, "BundleId": { "base": null, "refs": { @@ -2311,6 +2473,7 @@ "AdvertiseByoipCidrResult$ByoipCidr": "

Information about the address range.

", "ByoipCidrSet$member": null, "DeprovisionByoipCidrResult$ByoipCidr": "

Information about the address range.

", + "MoveByoipCidrToIpamResult$ByoipCidr": null, "ProvisionByoipCidrResult$ByoipCidr": "

Information about the address range.

", "WithdrawByoipCidrResult$ByoipCidr": "

Information about the address pool.

" } @@ -3391,6 +3554,36 @@ "refs": { } }, + "CreateIpamPoolRequest": { + "base": null, + "refs": { + } + }, + "CreateIpamPoolResult": { + "base": null, + "refs": { + } + }, + "CreateIpamRequest": { + "base": null, + "refs": { + } + }, + "CreateIpamResult": { + "base": null, + "refs": { + } + }, + "CreateIpamScopeRequest": { + "base": null, + "refs": { + } + }, + "CreateIpamScopeResult": { + "base": null, + "refs": { + } + }, "CreateKeyPairRequest": { "base": null, "refs": { @@ -3471,6 +3664,16 @@ "refs": { } }, + "CreateNetworkInsightsAccessScopeRequest": { + "base": null, + "refs": { + } + }, + "CreateNetworkInsightsAccessScopeResult": { + "base": null, + "refs": { + } + }, "CreateNetworkInsightsPathRequest": { "base": null, "refs": { @@ -3511,6 +3714,16 @@ "refs": { } }, + "CreatePublicIpv4PoolRequest": { + "base": null, + "refs": { + } + }, + "CreatePublicIpv4PoolResult": { + "base": null, + "refs": { + } + }, "CreateReplaceRootVolumeTaskRequest": { "base": null, "refs": { @@ -4252,6 +4465,36 @@ "refs": { } }, + "DeleteIpamPoolRequest": { + "base": null, + "refs": { + } + }, + "DeleteIpamPoolResult": { + "base": null, + "refs": { + } + }, + "DeleteIpamRequest": { + "base": null, + "refs": { + } + }, + "DeleteIpamResult": { + "base": null, + "refs": { + } + }, + "DeleteIpamScopeRequest": { + "base": null, + "refs": { + } + }, + "DeleteIpamScopeResult": { + "base": null, + "refs": { + } + }, "DeleteKeyPairRequest": { "base": null, "refs": { @@ -4351,6 +4594,26 @@ "refs": { } }, + "DeleteNetworkInsightsAccessScopeAnalysisRequest": { + "base": null, + "refs": { + } + }, + "DeleteNetworkInsightsAccessScopeAnalysisResult": { + "base": null, + "refs": { + } + }, + "DeleteNetworkInsightsAccessScopeRequest": { + "base": null, + "refs": { + } + }, + "DeleteNetworkInsightsAccessScopeResult": { + "base": null, + "refs": { + } + }, "DeleteNetworkInsightsAnalysisRequest": { "base": null, "refs": { @@ -4391,6 +4654,16 @@ "refs": { } }, + "DeletePublicIpv4PoolRequest": { + "base": null, + "refs": { + } + }, + "DeletePublicIpv4PoolResult": { + "base": null, + "refs": { + } + }, "DeleteQueuedReservedInstancesError": { "base": "

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

", "refs": { @@ -4669,6 +4942,32 @@ "refs": { } }, + "DeprovisionIpamPoolCidrRequest": { + "base": null, + "refs": { + } + }, + "DeprovisionIpamPoolCidrResult": { + "base": null, + "refs": { + } + }, + "DeprovisionPublicIpv4PoolCidrRequest": { + "base": null, + "refs": { + } + }, + "DeprovisionPublicIpv4PoolCidrResult": { + "base": null, + "refs": { + } + }, + "DeprovisionedAddressSet": { + "base": null, + "refs": { + "DeprovisionPublicIpv4PoolCidrResult$DeprovisionedAddresses": "

The deprovisioned CIDRs.

" + } + }, "DeregisterImageRequest": { "base": "

Contains the parameters for DeregisterImage.

", "refs": { @@ -5356,6 +5655,36 @@ "refs": { } }, + "DescribeIpamPoolsRequest": { + "base": null, + "refs": { + } + }, + "DescribeIpamPoolsResult": { + "base": null, + "refs": { + } + }, + "DescribeIpamScopesRequest": { + "base": null, + "refs": { + } + }, + "DescribeIpamScopesResult": { + "base": null, + "refs": { + } + }, + "DescribeIpamsRequest": { + "base": null, + "refs": { + } + }, + "DescribeIpamsResult": { + "base": null, + "refs": { + } + }, "DescribeIpv6PoolsRequest": { "base": null, "refs": { @@ -5520,6 +5849,26 @@ "refs": { } }, + "DescribeNetworkInsightsAccessScopeAnalysesRequest": { + "base": null, + "refs": { + } + }, + "DescribeNetworkInsightsAccessScopeAnalysesResult": { + "base": null, + "refs": { + } + }, + "DescribeNetworkInsightsAccessScopesRequest": { + "base": null, + "refs": { + } + }, + "DescribeNetworkInsightsAccessScopesResult": { + "base": null, + "refs": { + } + }, "DescribeNetworkInsightsAnalysesRequest": { "base": null, "refs": { @@ -6455,6 +6804,16 @@ "refs": { } }, + "DisableIpamOrganizationAdminAccountRequest": { + "base": null, + "refs": { + } + }, + "DisableIpamOrganizationAdminAccountResult": { + "base": null, + "refs": { + } + }, "DisableSerialConsoleAccessRequest": { "base": null, "refs": { @@ -7050,6 +7409,16 @@ "refs": { } }, + "EnableIpamOrganizationAdminAccountRequest": { + "base": null, + "refs": { + } + }, + "EnableIpamOrganizationAdminAccountResult": { + "base": null, + "refs": { + } + }, "EnableSerialConsoleAccessRequest": { "base": null, "refs": { @@ -7427,6 +7796,9 @@ "DescribeInstanceTypesRequest$Filters": "

One or more filters. Filter names and values are case-sensitive.

", "DescribeInstancesRequest$Filters": "

The filters.

", "DescribeInternetGatewaysRequest$Filters": "

One or more filters.

", + "DescribeIpamPoolsRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "DescribeIpamScopesRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "DescribeIpamsRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", "DescribeIpv6PoolsRequest$Filters": "

One or more filters.

", "DescribeKeyPairsRequest$Filters": "

The filters.

", "DescribeLaunchTemplateVersionsRequest$Filters": "

One or more filters.

", @@ -7441,6 +7813,8 @@ "DescribeMovingAddressesRequest$Filters": "

One or more filters.

", "DescribeNatGatewaysRequest$Filter": "

One or more filters.

", "DescribeNetworkAclsRequest$Filters": "

One or more filters.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$Filters": "

There are no supported filters.

", + "DescribeNetworkInsightsAccessScopesRequest$Filters": "

There are no supported filters.

", "DescribeNetworkInsightsAnalysesRequest$Filters": "

The filters. The following are possible values:

", "DescribeNetworkInsightsPathsRequest$Filters": "

The filters. The following are possible values:

", "DescribeNetworkInterfacePermissionsRequest$Filters": "

One or more filters.

", @@ -7494,6 +7868,9 @@ "DescribeVpnGatewaysRequest$Filters": "

One or more filters.

", "ExportTransitGatewayRoutesRequest$Filters": "

One or more filters. The possible values are:

", "GetCoipPoolUsageRequest$Filters": "

The filters. The following are the possible values:

", + "GetIpamPoolAllocationsRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "GetIpamPoolCidrsRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "GetIpamResourceCidrsRequest$Filters": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", "GetSubnetCidrReservationsRequest$Filters": "

One or more filters.

", "GetTransitGatewayAttachmentPropagationsRequest$Filters": "

One or more filters. The possible values are:

", "GetTransitGatewayMulticastDomainAssociationsRequest$Filters": "

One or more filters. The possible values are:

", @@ -7505,6 +7882,12 @@ "SearchTransitGatewayRoutesRequest$Filters": "

One or more filters. The possible values are:

" } }, + "FindingsFound": { + "base": null, + "refs": { + "NetworkInsightsAccessScopeAnalysis$FindingsFound": "

Indicates whether there are findings.

" + } + }, "FleetActivityStatus": { "base": null, "refs": { @@ -8031,120 +8414,186 @@ "refs": { } }, - "GetLaunchTemplateDataRequest": { + "GetIpamAddressHistoryRequest": { "base": null, "refs": { } }, - "GetLaunchTemplateDataResult": { + "GetIpamAddressHistoryResult": { "base": null, "refs": { } }, - "GetManagedPrefixListAssociationsMaxResults": { + "GetIpamPoolAllocationsMaxResults": { "base": null, "refs": { - "GetManagedPrefixListAssociationsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + "GetIpamPoolAllocationsRequest$MaxResults": "

The maximum number of results you would like returned per page.

" } }, - "GetManagedPrefixListAssociationsRequest": { + "GetIpamPoolAllocationsRequest": { "base": null, "refs": { } }, - "GetManagedPrefixListAssociationsResult": { + "GetIpamPoolAllocationsResult": { "base": null, "refs": { } }, - "GetManagedPrefixListEntriesRequest": { + "GetIpamPoolCidrsRequest": { "base": null, "refs": { } }, - "GetManagedPrefixListEntriesResult": { + "GetIpamPoolCidrsResult": { "base": null, "refs": { } }, - "GetPasswordDataRequest": { + "GetIpamResourceCidrsRequest": { "base": null, "refs": { } }, - "GetPasswordDataResult": { + "GetIpamResourceCidrsResult": { "base": null, "refs": { } }, - "GetReservedInstancesExchangeQuoteRequest": { - "base": "

Contains the parameters for GetReservedInstanceExchangeQuote.

", + "GetLaunchTemplateDataRequest": { + "base": null, "refs": { } }, - "GetReservedInstancesExchangeQuoteResult": { - "base": "

Contains the output of GetReservedInstancesExchangeQuote.

", + "GetLaunchTemplateDataResult": { + "base": null, "refs": { } }, - "GetSerialConsoleAccessStatusRequest": { + "GetManagedPrefixListAssociationsMaxResults": { "base": null, "refs": { + "GetManagedPrefixListAssociationsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, - "GetSerialConsoleAccessStatusResult": { + "GetManagedPrefixListAssociationsRequest": { "base": null, "refs": { } }, - "GetSpotPlacementScoresRequest": { + "GetManagedPrefixListAssociationsResult": { "base": null, "refs": { } }, - "GetSpotPlacementScoresResult": { + "GetManagedPrefixListEntriesRequest": { "base": null, "refs": { } }, - "GetSubnetCidrReservationsMaxResults": { + "GetManagedPrefixListEntriesResult": { "base": null, "refs": { - "GetSubnetCidrReservationsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, - "GetSubnetCidrReservationsRequest": { + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest": { "base": null, "refs": { } }, - "GetSubnetCidrReservationsResult": { + "GetNetworkInsightsAccessScopeAnalysisFindingsResult": { "base": null, "refs": { } }, - "GetTransitGatewayAttachmentPropagationsRequest": { + "GetNetworkInsightsAccessScopeContentRequest": { "base": null, "refs": { } }, - "GetTransitGatewayAttachmentPropagationsResult": { + "GetNetworkInsightsAccessScopeContentResult": { "base": null, "refs": { } }, - "GetTransitGatewayMulticastDomainAssociationsRequest": { + "GetPasswordDataRequest": { "base": null, "refs": { } }, - "GetTransitGatewayMulticastDomainAssociationsResult": { + "GetPasswordDataResult": { "base": null, "refs": { } }, - "GetTransitGatewayPrefixListReferencesRequest": { - "base": null, + "GetReservedInstancesExchangeQuoteRequest": { + "base": "

Contains the parameters for GetReservedInstanceExchangeQuote.

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

Contains the output of GetReservedInstancesExchangeQuote.

", + "refs": { + } + }, + "GetSerialConsoleAccessStatusRequest": { + "base": null, + "refs": { + } + }, + "GetSerialConsoleAccessStatusResult": { + "base": null, + "refs": { + } + }, + "GetSpotPlacementScoresRequest": { + "base": null, + "refs": { + } + }, + "GetSpotPlacementScoresResult": { + "base": null, + "refs": { + } + }, + "GetSubnetCidrReservationsMaxResults": { + "base": null, + "refs": { + "GetSubnetCidrReservationsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "GetSubnetCidrReservationsRequest": { + "base": null, + "refs": { + } + }, + "GetSubnetCidrReservationsResult": { + "base": null, + "refs": { + } + }, + "GetTransitGatewayAttachmentPropagationsRequest": { + "base": null, + "refs": { + } + }, + "GetTransitGatewayAttachmentPropagationsResult": { + "base": null, + "refs": { + } + }, + "GetTransitGatewayMulticastDomainAssociationsRequest": { + "base": null, + "refs": { + } + }, + "GetTransitGatewayMulticastDomainAssociationsResult": { + "base": null, + "refs": { + } + }, + "GetTransitGatewayPrefixListReferencesRequest": { + "base": null, "refs": { } }, @@ -9580,6 +10029,7 @@ "AcceleratorTotalMemoryMiBRequest$Min": "

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

", "AcceleratorTotalMemoryMiBRequest$Max": "

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

", "AllocateHostsRequest$Quantity": "

The number of Dedicated Hosts to allocate to your account with these parameters.

", + "AllocateIpamPoolCidrRequest$NetmaskLength": "

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", "AnalysisAclRule$RuleNumber": "

The rule number.

", "AssignIpv6AddressesRequest$Ipv6AddressCount": "

The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

", "AssignIpv6AddressesRequest$Ipv6PrefixCount": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

", @@ -9704,6 +10154,9 @@ "InstanceUsage$UsedInstanceCount": "

The number of instances the Amazon Web Services account currently has in the Capacity Reservation.

", "IpPermission$FromPort": "

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

", "IpPermission$ToPort": "

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

", + "Ipam$ScopeCount": "

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

", + "IpamPool$PoolDepth": "

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

", + "IpamScope$PoolCount": "

The number of pools in the scope.

", "LaunchTemplateCpuOptions$CoreCount": "

The number of CPU cores for the instance.

", "LaunchTemplateCpuOptions$ThreadsPerCore": "

The number of threads per CPU core.

", "LaunchTemplateCpuOptionsRequest$CoreCount": "

The number of CPU cores for the instance.

", @@ -9765,6 +10218,7 @@ "ModifyVpnTunnelOptionsSpecification$ReplayWindowSize": "

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

", "ModifyVpnTunnelOptionsSpecification$DPDTimeoutSeconds": "

The number of seconds after which a DPD timeout occurs.

Constraints: A value between 0 and 30.

Default: 30

", "NetworkAclEntry$RuleNumber": "

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "NetworkInsightsAccessScopeAnalysis$AnalyzedEniCount": "

The number of network interfaces analyzed.

", "NetworkInsightsPath$DestinationPort": "

The destination port.

", "NetworkInterfaceAttachment$DeviceIndex": "

The device index of the network interface attachment on the instance.

", "NetworkInterfaceAttachment$NetworkCardIndex": "

The index of the network card.

", @@ -9786,6 +10240,7 @@ "PortRange$From": "

The first port in the range.

", "PortRange$To": "

The last port in the range.

", "PricingDetail$Count": "

The number of reservations available for the price.

", + "ProvisionPublicIpv4PoolCidrRequest$NetmaskLength": "

The netmask length of the CIDR you would like to allocate to the public IPv4 pool.

", "PublicIpv4Pool$TotalAddressCount": "

The total number of addresses.

", "PublicIpv4Pool$TotalAvailableAddressCount": "

The total number of available addresses.

", "PublicIpv4PoolRange$AddressCount": "

The number of addresses in the range.

", @@ -10030,10 +10485,327 @@ "StaleIpPermission$IpRanges": "

The IP ranges. Not applicable for stale security group rules.

" } }, + "Ipam": { + "base": "

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "refs": { + "CreateIpamResult$Ipam": "

Information about the IPAM created.

", + "DeleteIpamResult$Ipam": "

Information about the results of the deletion.

", + "IpamSet$member": null, + "ModifyIpamResult$Ipam": "

The results of the modification.

" + } + }, + "IpamAddressHistoryMaxResults": { + "base": null, + "refs": { + "GetIpamAddressHistoryRequest$MaxResults": "

The maximum number of historical results you would like returned per page. Defaults to 100.

" + } + }, + "IpamAddressHistoryRecord": { + "base": "

The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

", + "refs": { + "IpamAddressHistoryRecordSet$member": null + } + }, + "IpamAddressHistoryRecordSet": { + "base": null, + "refs": { + "GetIpamAddressHistoryResult$HistoryRecords": "

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

" + } + }, + "IpamAddressHistoryResourceType": { + "base": null, + "refs": { + "IpamAddressHistoryRecord$ResourceType": "

The type of the resource.

" + } + }, + "IpamCidrAuthorizationContext": { + "base": "

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

", + "refs": { + "ProvisionIpamPoolCidrRequest$CidrAuthorizationContext": "

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.

" + } + }, + "IpamComplianceStatus": { + "base": null, + "refs": { + "IpamAddressHistoryRecord$ResourceComplianceStatus": "

The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "IpamResourceCidr$ComplianceStatus": "

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

" + } + }, + "IpamId": { + "base": null, + "refs": { + "CreateIpamScopeRequest$IpamId": "

The ID of the IPAM for which you're creating this scope.

", + "DeleteIpamRequest$IpamId": "

The ID of the IPAM to delete.

", + "Ipam$IpamId": "

The ID of the IPAM.

", + "IpamResourceCidr$IpamId": "

The IPAM ID for an IPAM resource.

", + "ModifyIpamRequest$IpamId": "

The ID of the IPAM you want to modify.

" + } + }, + "IpamManagementState": { + "base": null, + "refs": { + "IpamResourceCidr$ManagementState": "

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

" + } + }, + "IpamMaxResults": { + "base": null, + "refs": { + "DescribeIpamPoolsRequest$MaxResults": "

The maximum number of results to return in the request.

", + "DescribeIpamScopesRequest$MaxResults": "

The maximum number of results to return in the request.

", + "DescribeIpamsRequest$MaxResults": "

The maximum number of results to return in the request.

", + "GetIpamPoolCidrsRequest$MaxResults": "

The maximum number of results to return in the request.

", + "GetIpamResourceCidrsRequest$MaxResults": "

The maximum number of results to return in the request.

" + } + }, + "IpamNetmaskLength": { + "base": null, + "refs": { + "CreateIpamPoolRequest$AllocationMinNetmaskLength": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "CreateIpamPoolRequest$AllocationMaxNetmaskLength": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "CreateIpamPoolRequest$AllocationDefaultNetmaskLength": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

", + "IpamPool$AllocationMinNetmaskLength": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "IpamPool$AllocationMaxNetmaskLength": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "IpamPool$AllocationDefaultNetmaskLength": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

", + "ModifyIpamPoolRequest$AllocationMinNetmaskLength": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

", + "ModifyIpamPoolRequest$AllocationMaxNetmaskLength": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

", + "ModifyIpamPoolRequest$AllocationDefaultNetmaskLength": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

" + } + }, + "IpamOperatingRegion": { + "base": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "refs": { + "IpamOperatingRegionSet$member": null + } + }, + "IpamOperatingRegionSet": { + "base": null, + "refs": { + "Ipam$OperatingRegions": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "IpamOverlapStatus": { + "base": null, + "refs": { + "IpamAddressHistoryRecord$ResourceOverlapStatus": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "IpamResourceCidr$OverlapStatus": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

" + } + }, + "IpamPool": { + "base": "

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

", + "refs": { + "CreateIpamPoolResult$IpamPool": "

Information about the IPAM pool created.

", + "DeleteIpamPoolResult$IpamPool": "

Information about the results of the deletion.

", + "IpamPoolSet$member": null, + "ModifyIpamPoolResult$IpamPool": "

The results of the modification.

" + } + }, + "IpamPoolAllocation": { + "base": "

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.

", + "refs": { + "AllocateIpamPoolCidrResult$IpamPoolAllocation": "

Information about the allocation created.

", + "IpamPoolAllocationSet$member": null + } + }, + "IpamPoolAllocationDisallowedCidrs": { + "base": null, + "refs": { + "AllocateIpamPoolCidrRequest$DisallowedCidrs": "

Exclude a particular CIDR range from being returned by the pool.

" + } + }, + "IpamPoolAllocationId": { + "base": null, + "refs": { + "GetIpamPoolAllocationsRequest$IpamPoolAllocationId": "

The ID of the allocation.

", + "IpamPoolAllocation$IpamPoolAllocationId": "

The ID of an allocation.

", + "ReleaseIpamPoolAllocationRequest$IpamPoolAllocationId": "

The ID of the allocation.

" + } + }, + "IpamPoolAllocationResourceType": { + "base": null, + "refs": { + "IpamPoolAllocation$ResourceType": "

The type of the resource.

" + } + }, + "IpamPoolAllocationSet": { + "base": null, + "refs": { + "GetIpamPoolAllocationsResult$IpamPoolAllocations": "

The IPAM pool allocations you want information on.

" + } + }, + "IpamPoolAwsService": { + "base": null, + "refs": { + "CreateIpamPoolRequest$AwsService": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

", + "IpamPool$AwsService": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

" + } + }, + "IpamPoolCidr": { + "base": "

A CIDR provisioned to an IPAM pool.

", + "refs": { + "DeprovisionIpamPoolCidrResult$IpamPoolCidr": "

The deprovisioned pool CIDR.

", + "IpamPoolCidrSet$member": null, + "ProvisionIpamPoolCidrResult$IpamPoolCidr": "

Information about the provisioned CIDR.

" + } + }, + "IpamPoolCidrFailureCode": { + "base": null, + "refs": { + "IpamPoolCidrFailureReason$Code": "

An error code related to why an IPAM pool CIDR failed to be provisioned.

" + } + }, + "IpamPoolCidrFailureReason": { + "base": "

Details related to why an IPAM pool CIDR failed to be provisioned.

", + "refs": { + "IpamPoolCidr$FailureReason": "

Details related to why an IPAM pool CIDR failed to be provisioned.

" + } + }, + "IpamPoolCidrSet": { + "base": null, + "refs": { + "GetIpamPoolCidrsResult$IpamPoolCidrs": "

Information about the CIDRs provisioned to an IPAM pool.

" + } + }, + "IpamPoolCidrState": { + "base": null, + "refs": { + "IpamPoolCidr$State": "

The state of the CIDR.

" + } + }, + "IpamPoolId": { + "base": null, + "refs": { + "AllocateIpamPoolCidrRequest$IpamPoolId": "

The ID of the IPAM pool from which you would like to allocate a CIDR.

", + "AssociateVpcCidrBlockRequest$Ipv4IpamPoolId": "

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "AssociateVpcCidrBlockRequest$Ipv6IpamPoolId": "

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "CreateIpamPoolRequest$SourceIpamPoolId": "

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

", + "CreateVpcRequest$Ipv4IpamPoolId": "

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "CreateVpcRequest$Ipv6IpamPoolId": "

The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "DeleteIpamPoolRequest$IpamPoolId": "

The ID of the pool to delete.

", + "DeprovisionIpamPoolCidrRequest$IpamPoolId": "

The ID of the pool that has the CIDR you want to deprovision.

", + "GetIpamPoolAllocationsRequest$IpamPoolId": "

The ID of the IPAM pool you want to see the allocations for.

", + "GetIpamPoolCidrsRequest$IpamPoolId": "

The ID of the IPAM pool you want the CIDR for.

", + "GetIpamResourceCidrsRequest$IpamPoolId": "

The ID of the IPAM pool that the resource is in.

", + "IpamPool$IpamPoolId": "

The ID of the IPAM pool.

", + "IpamPool$SourceIpamPoolId": "

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

", + "IpamResourceCidr$IpamPoolId": "

The pool ID for an IPAM resource.

", + "ModifyIpamPoolRequest$IpamPoolId": "

The ID of the IPAM pool you want to modify.

", + "MoveByoipCidrToIpamRequest$IpamPoolId": "

The IPAM pool ID.

", + "ProvisionIpamPoolCidrRequest$IpamPoolId": "

The ID of the IPAM pool to which you want to assign a CIDR.

", + "ProvisionPublicIpv4PoolCidrRequest$IpamPoolId": "

The ID of the IPAM pool you would like to use to allocate this CIDR.

", + "ReleaseIpamPoolAllocationRequest$IpamPoolId": "

The ID of the IPAM pool which contains the allocation you want to release.

" + } + }, + "IpamPoolSet": { + "base": null, + "refs": { + "DescribeIpamPoolsResult$IpamPools": "

Information about the IPAM pools.

" + } + }, + "IpamPoolState": { + "base": null, + "refs": { + "IpamPool$State": "

The state of the IPAM pool.

" + } + }, + "IpamResourceCidr": { + "base": "

The CIDR for an IPAM resource.

", + "refs": { + "IpamResourceCidrSet$member": null, + "ModifyIpamResourceCidrResult$IpamResourceCidr": null + } + }, + "IpamResourceCidrSet": { + "base": null, + "refs": { + "GetIpamResourceCidrsResult$IpamResourceCidrs": "

The resource CIDRs.

" + } + }, + "IpamResourceTag": { + "base": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "refs": { + "IpamResourceTagList$member": null + } + }, + "IpamResourceTagList": { + "base": null, + "refs": { + "IpamPool$AllocationResourceTags": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "IpamResourceCidr$ResourceTags": "

The tags for an IPAM resource.

" + } + }, + "IpamResourceType": { + "base": null, + "refs": { + "GetIpamResourceCidrsRequest$ResourceType": "

The resource type.

", + "IpamResourceCidr$ResourceType": "

The type of IPAM resource.

" + } + }, + "IpamScope": { + "base": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide

", + "refs": { + "CreateIpamScopeResult$IpamScope": "

Information about the created scope.

", + "DeleteIpamScopeResult$IpamScope": "

Information about the results of the deletion.

", + "IpamScopeSet$member": null, + "ModifyIpamScopeResult$IpamScope": "

The results of the modification.

" + } + }, + "IpamScopeId": { + "base": null, + "refs": { + "CreateIpamPoolRequest$IpamScopeId": "

The ID of the scope in which you would like to create the IPAM pool.

", + "DeleteIpamScopeRequest$IpamScopeId": "

The ID of the scope to delete.

", + "GetIpamAddressHistoryRequest$IpamScopeId": "

The ID of the IPAM scope that the CIDR is in.

", + "GetIpamResourceCidrsRequest$IpamScopeId": "

The ID of the scope that the resource is in.

", + "Ipam$PublicDefaultScopeId": "

The ID of the IPAM's default public scope.

", + "Ipam$PrivateDefaultScopeId": "

The ID of the IPAM's default private scope.

", + "IpamResourceCidr$IpamScopeId": "

The scope ID for an IPAM resource.

", + "IpamScope$IpamScopeId": "

The ID of the scope.

", + "ModifyIpamResourceCidrRequest$CurrentIpamScopeId": "

The ID of the current scope that the resource CIDR is in.

", + "ModifyIpamResourceCidrRequest$DestinationIpamScopeId": "

The ID of the scope you want to transfer the resource CIDR to.

", + "ModifyIpamScopeRequest$IpamScopeId": "

The ID of the scope you want to modify.

" + } + }, + "IpamScopeSet": { + "base": null, + "refs": { + "DescribeIpamScopesResult$IpamScopes": "

The scopes you want information on.

" + } + }, + "IpamScopeState": { + "base": null, + "refs": { + "IpamScope$State": "

The state of the IPAM scope.

" + } + }, + "IpamScopeType": { + "base": null, + "refs": { + "IpamPool$IpamScopeType": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

", + "IpamScope$IpamScopeType": "

The type of the scope.

" + } + }, + "IpamSet": { + "base": null, + "refs": { + "DescribeIpamsResult$Ipams": "

Information about the IPAMs.

" + } + }, + "IpamState": { + "base": null, + "refs": { + "Ipam$State": "

The state of the IPAM.

" + } + }, "Ipv4PoolEc2Id": { "base": null, "refs": { "AllocateAddressRequest$PublicIpv4Pool": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

", + "CreatePublicIpv4PoolResult$PoolId": "

The ID of the public IPv4 pool.

", + "DeletePublicIpv4PoolRequest$PoolId": "

The ID of the public IPv4 pool you want to delete.

", + "DeprovisionPublicIpv4PoolCidrRequest$PoolId": "

The ID of the pool that you want to deprovision the CIDR from.

", + "DeprovisionPublicIpv4PoolCidrResult$PoolId": "

The ID of the pool that you deprovisioned the CIDR from.

", + "ProvisionPublicIpv4PoolCidrRequest$PoolId": "

The ID of the public IPv4 pool you would like to use for this CIDR.

", + "ProvisionPublicIpv4PoolCidrResult$PoolId": "

The ID of the pool that you want to provision the CIDR to.

", "PublicIpv4PoolIdStringList$member": null } }, @@ -11247,6 +12019,8 @@ "DescribeFastSnapshotRestoreSuccessItem$EnabledTime": "

The time at which fast snapshot restores entered the enabled state.

", "DescribeFastSnapshotRestoreSuccessItem$DisablingTime": "

The time at which fast snapshot restores entered the disabling state.

", "DescribeFastSnapshotRestoreSuccessItem$DisabledTime": "

The time at which fast snapshot restores entered the disabled state.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$AnalysisStartTimeBegin": "

Filters the results based on the start time. The analysis must have started on or after this time.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$AnalysisStartTimeEnd": "

Filters the results based on the start time. The analysis must have started on or before this time.

", "DescribeNetworkInsightsAnalysesRequest$AnalysisStartTime": "

The time when the network insights analyses started.

", "DescribeNetworkInsightsAnalysesRequest$AnalysisEndTime": "

The time when the network insights analyses ended.

", "DisableFastSnapshotRestoreSuccessItem$EnablingTime": "

The time at which fast snapshot restores entered the enabling state.

", @@ -11262,9 +12036,17 @@ "EnableImageDeprecationRequest$DeprecateAt": "

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now.

", "FleetCapacityReservation$CreateDate": "

The date and time at which the Capacity Reservation was created.

", "FlowLog$CreationTime": "

The date and time the flow log was created.

", + "GetIpamAddressHistoryRequest$StartTime": "

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

", + "GetIpamAddressHistoryRequest$EndTime": "

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

", "Instance$UsageOperationUpdateTime": "

The time that the usage operation was last updated.

", + "IpamAddressHistoryRecord$SampledStartTime": "

Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.

", + "IpamAddressHistoryRecord$SampledEndTime": "

Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.

", "ModifyCapacityReservationFleetRequest$EndDate": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

You can't specify EndDate and RemoveEndDate in the same request.

", "ModifySnapshotTierResult$TieringStartTime": "

The date and time when the archive process was started.

", + "NetworkInsightsAccessScope$CreatedDate": "

The creation date.

", + "NetworkInsightsAccessScope$UpdatedDate": "

The last updated date.

", + "NetworkInsightsAccessScopeAnalysis$StartDate": "

The analysis start date.

", + "NetworkInsightsAccessScopeAnalysis$EndDate": "

The analysis end date.

", "NetworkInsightsAnalysis$StartDate": "

The time the analysis started.

", "NetworkInsightsPath$CreatedDate": "

The time stamp when the path was created.

", "RestoreSnapshotFromRecycleBinResult$StartTime": "

The time stamp when the snapshot was initiated.

", @@ -11470,6 +12252,46 @@ "refs": { } }, + "ModifyIpamPoolRequest": { + "base": null, + "refs": { + } + }, + "ModifyIpamPoolResult": { + "base": null, + "refs": { + } + }, + "ModifyIpamRequest": { + "base": null, + "refs": { + } + }, + "ModifyIpamResourceCidrRequest": { + "base": null, + "refs": { + } + }, + "ModifyIpamResourceCidrResult": { + "base": null, + "refs": { + } + }, + "ModifyIpamResult": { + "base": null, + "refs": { + } + }, + "ModifyIpamScopeRequest": { + "base": null, + "refs": { + } + }, + "ModifyIpamScopeResult": { + "base": null, + "refs": { + } + }, "ModifyLaunchTemplateRequest": { "base": null, "refs": { @@ -11786,6 +12608,16 @@ "refs": { } }, + "MoveByoipCidrToIpamRequest": { + "base": null, + "refs": { + } + }, + "MoveByoipCidrToIpamResult": { + "base": null, + "refs": { + } + }, "MoveStatus": { "base": null, "refs": { @@ -11857,6 +12689,15 @@ "NatGateway$State": "

The state of the NAT gateway.

" } }, + "NetmaskLength": { + "base": null, + "refs": { + "AssociateVpcCidrBlockRequest$Ipv4NetmaskLength": "

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "AssociateVpcCidrBlockRequest$Ipv6NetmaskLength": "

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "CreateVpcRequest$Ipv4NetmaskLength": "

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

", + "CreateVpcRequest$Ipv6NetmaskLength": "

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, "NetworkAcl": { "base": "

Describes a network ACL.

", "refs": { @@ -11941,6 +12782,78 @@ "InstanceTypeInfo$NetworkInfo": "

Describes the network settings for the instance type.

" } }, + "NetworkInsightsAccessScope": { + "base": "

Describes a Network Access Scope.

", + "refs": { + "CreateNetworkInsightsAccessScopeResult$NetworkInsightsAccessScope": "

The Network Access Scope.

", + "NetworkInsightsAccessScopeList$member": null + } + }, + "NetworkInsightsAccessScopeAnalysis": { + "base": "

Describes a Network Access Scope analysis.

", + "refs": { + "NetworkInsightsAccessScopeAnalysisList$member": null, + "StartNetworkInsightsAccessScopeAnalysisResult$NetworkInsightsAccessScopeAnalysis": "

The Network Access Scope analysis.

" + } + }, + "NetworkInsightsAccessScopeAnalysisId": { + "base": null, + "refs": { + "AccessScopeAnalysisFinding$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "DeleteNetworkInsightsAccessScopeAnalysisRequest$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "DeleteNetworkInsightsAccessScopeAnalysisResult$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsResult$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "NetworkInsightsAccessScopeAnalysis$NetworkInsightsAccessScopeAnalysisId": "

The ID of the Network Access Scope analysis.

", + "NetworkInsightsAccessScopeAnalysisIdList$member": null + } + }, + "NetworkInsightsAccessScopeAnalysisIdList": { + "base": null, + "refs": { + "DescribeNetworkInsightsAccessScopeAnalysesRequest$NetworkInsightsAccessScopeAnalysisIds": "

The IDs of the Network Access Scope analyses.

" + } + }, + "NetworkInsightsAccessScopeAnalysisList": { + "base": null, + "refs": { + "DescribeNetworkInsightsAccessScopeAnalysesResult$NetworkInsightsAccessScopeAnalyses": "

The Network Access Scope analyses.

" + } + }, + "NetworkInsightsAccessScopeContent": { + "base": "

Describes the Network Access Scope content.

", + "refs": { + "CreateNetworkInsightsAccessScopeResult$NetworkInsightsAccessScopeContent": "

The Network Access Scope content.

", + "GetNetworkInsightsAccessScopeContentResult$NetworkInsightsAccessScopeContent": "

The Network Access Scope content.

" + } + }, + "NetworkInsightsAccessScopeId": { + "base": null, + "refs": { + "AccessScopeAnalysisFinding$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "DeleteNetworkInsightsAccessScopeRequest$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "DeleteNetworkInsightsAccessScopeResult$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "GetNetworkInsightsAccessScopeContentRequest$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "NetworkInsightsAccessScope$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "NetworkInsightsAccessScopeAnalysis$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "NetworkInsightsAccessScopeContent$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

", + "NetworkInsightsAccessScopeIdList$member": null, + "StartNetworkInsightsAccessScopeAnalysisRequest$NetworkInsightsAccessScopeId": "

The ID of the Network Access Scope.

" + } + }, + "NetworkInsightsAccessScopeIdList": { + "base": null, + "refs": { + "DescribeNetworkInsightsAccessScopesRequest$NetworkInsightsAccessScopeIds": "

The IDs of the Network Access Scopes.

" + } + }, + "NetworkInsightsAccessScopeList": { + "base": null, + "refs": { + "DescribeNetworkInsightsAccessScopesResult$NetworkInsightsAccessScopes": "

The Network Access Scopes.

" + } + }, "NetworkInsightsAnalysis": { "base": "

Describes a network insights analysis.

", "refs": { @@ -11972,8 +12885,11 @@ "NetworkInsightsMaxResults": { "base": null, "refs": { + "DescribeNetworkInsightsAccessScopeAnalysesRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

", + "DescribeNetworkInsightsAccessScopesRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

", "DescribeNetworkInsightsAnalysesRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

", - "DescribeNetworkInsightsPathsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + "DescribeNetworkInsightsPathsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, "NetworkInsightsPath": { @@ -12227,10 +13143,18 @@ "DescribeInstanceTypeOfferingsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeInstanceTypesRequest$NextToken": "

The token to retrieve the next page of results.

", "DescribeInstanceTypesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeIpamPoolsRequest$NextToken": "

The token for the next page of results.

", + "DescribeIpamPoolsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeIpamScopesRequest$NextToken": "

The token for the next page of results.

", + "DescribeIpamScopesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeIpamsRequest$NextToken": "

The token for the next page of results.

", + "DescribeIpamsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeIpv6PoolsRequest$NextToken": "

The token for the next page of results.

", "DescribeIpv6PoolsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeManagedPrefixListsRequest$NextToken": "

The token for the next page of results.

", "DescribeManagedPrefixListsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeNetworkInsightsAccessScopeAnalysesRequest$NextToken": "

The token for the next page of results.

", + "DescribeNetworkInsightsAccessScopesRequest$NextToken": "

The token for the next page of results.

", "DescribeNetworkInsightsAnalysesRequest$NextToken": "

The token for the next page of results.

", "DescribeNetworkInsightsPathsRequest$NextToken": "

The token for the next page of results.

", "DescribePublicIpv4PoolsRequest$NextToken": "

The token for the next page of results.

", @@ -12239,9 +13163,18 @@ "DescribeTrafficMirrorSessionsRequest$NextToken": "

The token for the next page of results.

", "DescribeTrafficMirrorTargetsRequest$NextToken": "

The token for the next page of results.

", "GetAssociatedIpv6PoolCidrsRequest$NextToken": "

The token for the next page of results.

", + "GetIpamAddressHistoryRequest$NextToken": "

The token for the next page of results.

", + "GetIpamAddressHistoryResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "GetIpamPoolAllocationsRequest$NextToken": "

The token for the next page of results.

", + "GetIpamPoolAllocationsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "GetIpamPoolCidrsRequest$NextToken": "

The token for the next page of results.

", + "GetIpamPoolCidrsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "GetIpamResourceCidrsRequest$NextToken": "

The token for the next page of results.

", + "GetIpamResourceCidrsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "GetManagedPrefixListAssociationsRequest$NextToken": "

The token for the next page of results.

", "GetManagedPrefixListEntriesRequest$NextToken": "

The token for the next page of results.

", "GetManagedPrefixListEntriesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsRequest$NextToken": "

The token for the next page of results.

", "GetVpnConnectionDeviceTypesRequest$NextToken": "

The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "GetVpnConnectionDeviceTypesResult$NextToken": "

The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } @@ -12337,6 +13270,18 @@ "DescribeSnapshotsRequest$OwnerIds": "

Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

" } }, + "PacketHeaderStatement": { + "base": "

Describes a packet header statement.

", + "refs": { + "PathStatement$PacketHeaderStatement": "

The packet header statement.

" + } + }, + "PacketHeaderStatementRequest": { + "base": "

Describes a packet header statement.

", + "refs": { + "PathStatementRequest$PacketHeaderStatement": "

The packet header statement.

" + } + }, "PartitionLoadFrequency": { "base": null, "refs": { @@ -12352,10 +13297,25 @@ "PathComponentList": { "base": null, "refs": { + "AccessScopeAnalysisFinding$FindingComponents": "

The finding components.

", "NetworkInsightsAnalysis$ForwardPathComponents": "

The components in the path from source to destination.

", "NetworkInsightsAnalysis$ReturnPathComponents": "

The components in the path from destination to source.

" } }, + "PathStatement": { + "base": "

Describes a path statement.

", + "refs": { + "AccessScopePath$Source": "

The source.

", + "AccessScopePath$Destination": "

The destination.

" + } + }, + "PathStatementRequest": { + "base": "

Describes a path statement.

", + "refs": { + "AccessScopePathRequest$Source": "

The source.

", + "AccessScopePathRequest$Destination": "

The destination.

" + } + }, "PaymentOption": { "base": null, "refs": { @@ -12985,7 +13945,15 @@ "base": null, "refs": { "CreateNetworkInsightsPathRequest$Protocol": "

The protocol.

", - "NetworkInsightsPath$Protocol": "

The protocol.

" + "NetworkInsightsPath$Protocol": "

The protocol.

", + "ProtocolList$member": null + } + }, + "ProtocolList": { + "base": null, + "refs": { + "PacketHeaderStatement$Protocols": "

The protocols.

", + "PacketHeaderStatementRequest$Protocols": "

The protocols.

" } }, "ProtocolValue": { @@ -13006,6 +13974,26 @@ "refs": { } }, + "ProvisionIpamPoolCidrRequest": { + "base": null, + "refs": { + } + }, + "ProvisionIpamPoolCidrResult": { + "base": null, + "refs": { + } + }, + "ProvisionPublicIpv4PoolCidrRequest": { + "base": null, + "refs": { + } + }, + "ProvisionPublicIpv4PoolCidrResult": { + "base": null, + "refs": { + } + }, "ProvisionedBandwidth": { "base": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "refs": { @@ -13046,6 +14034,7 @@ "PublicIpv4PoolRange": { "base": "

Describes an address range of an IPv4 address pool.

", "refs": { + "ProvisionPublicIpv4PoolCidrResult$PoolAddressRange": null, "PublicIpv4PoolRangeSet$member": null } }, @@ -13313,6 +14302,28 @@ "refs": { } }, + "ReleaseIpamPoolAllocationRequest": { + "base": null, + "refs": { + } + }, + "ReleaseIpamPoolAllocationResult": { + "base": null, + "refs": { + } + }, + "RemoveIpamOperatingRegion": { + "base": "

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide

", + "refs": { + "RemoveIpamOperatingRegionSet$member": null + } + }, + "RemoveIpamOperatingRegionSet": { + "base": null, + "refs": { + "ModifyIpamRequest$RemoveOperatingRegions": "

The operating Regions to remove.

" + } + }, "RemovePrefixListEntries": { "base": null, "refs": { @@ -13451,6 +14462,21 @@ "DescribeInstanceTypesRequest$InstanceTypes": "

The instance types. For more information, see Instance types in the Amazon EC2 User Guide.

" } }, + "RequestIpamResourceTag": { + "base": "

A tag on an IPAM resource.

", + "refs": { + "GetIpamResourceCidrsRequest$ResourceTag": null, + "RequestIpamResourceTagList$member": null + } + }, + "RequestIpamResourceTagList": { + "base": null, + "refs": { + "CreateIpamPoolRequest$AllocationResourceTags": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "ModifyIpamPoolRequest$AddAllocationResourceTags": "

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

", + "ModifyIpamPoolRequest$RemoveAllocationResourceTags": "

Remove tag allocation rules from a pool.

" + } + }, "RequestLaunchTemplateData": { "base": "

The information to include in the launch template.

", "refs": { @@ -13777,11 +14803,19 @@ "DisassociateEnclaveCertificateIamRoleRequest$RoleArn": "

The ARN of the IAM role to disassociate.

", "Explanation$LoadBalancerArn": "

The Amazon Resource Name (ARN) of the load balancer.

", "GetAssociatedEnclaveCertificateIamRolesRequest$CertificateArn": "

The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.

", + "Ipam$IpamArn": "

The ARN of the IPAM.

", + "IpamPool$IpamPoolArn": "

The ARN of the IPAM pool.

", + "IpamPool$IpamScopeArn": "

The ARN of the scope of the IPAM pool.

", + "IpamPool$IpamArn": "

The ARN of the IPAM.

", + "IpamScope$IpamScopeArn": "

The ARN of the scope.

", + "IpamScope$IpamArn": "

The ARN of the IPAM.

", "LocalGatewayRoute$LocalGatewayRouteTableArn": "

The Amazon Resource Name (ARN) of the local gateway route table.

", "LocalGatewayRouteTable$LocalGatewayRouteTableArn": "

The Amazon Resource Name (ARN) of the local gateway route table.

", "LocalGatewayRouteTableVirtualInterfaceGroupAssociation$LocalGatewayRouteTableArn": "

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

", "LocalGatewayRouteTableVpcAssociation$LocalGatewayRouteTableArn": "

The Amazon Resource Name (ARN) of the local gateway route table for the association.

", "ManagedPrefixList$PrefixListArn": "

The Amazon Resource Name (ARN) for the prefix list.

", + "NetworkInsightsAccessScope$NetworkInsightsAccessScopeArn": "

The Amazon Resource Name (ARN) of the Network Access Scope.

", + "NetworkInsightsAccessScopeAnalysis$NetworkInsightsAccessScopeAnalysisArn": "

The Amazon Resource Name (ARN) of the Network Access Scope analysis.

", "NetworkInsightsAnalysis$NetworkInsightsAnalysisArn": "

The Amazon Resource Name (ARN) of the network insights analysis.

", "NetworkInsightsPath$NetworkInsightsPathArn": "

The Amazon Resource Name (ARN) of the path.

" } @@ -13799,6 +14833,20 @@ "DescribePrincipalIdFormatRequest$Resources": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

" } }, + "ResourceStatement": { + "base": "

Describes a resource statement.

", + "refs": { + "PathStatement$ResourceStatement": "

The resource statement.

", + "ThroughResourcesStatement$ResourceStatement": "

The resource statement.

" + } + }, + "ResourceStatementRequest": { + "base": "

Describes a resource statement.

", + "refs": { + "PathStatementRequest$ResourceStatement": "

The resource statement.

", + "ThroughResourcesStatementRequest$ResourceStatement": "

The resource statement.

" + } + }, "ResourceType": { "base": null, "refs": { @@ -14837,6 +15885,16 @@ "refs": { } }, + "StartNetworkInsightsAccessScopeAnalysisRequest": { + "base": null, + "refs": { + } + }, + "StartNetworkInsightsAccessScopeAnalysisResult": { + "base": null, + "refs": { + } + }, "StartNetworkInsightsAnalysisRequest": { "base": null, "refs": { @@ -14944,11 +16002,13 @@ "base": null, "refs": { "AcceptReservedInstancesExchangeQuoteResult$ExchangeId": "

The ID of the successful exchange.

", + "AccessScopeAnalysisFinding$FindingId": "

The ID of the finding.

", "AccountAttribute$AttributeName": "

The name of the account attribute.

", "AccountAttributeValue$AttributeValue": "

The value of the attribute.

", "ActiveInstance$InstanceId": "

The ID of the instance.

", "ActiveInstance$InstanceType": "

The instance type.

", "ActiveInstance$SpotInstanceRequestId": "

The ID of the Spot Instance request.

", + "AddIpamOperatingRegion$RegionName": "

The name of the operating Region.

", "AddPrefixListEntry$Cidr": "

The CIDR block.

", "AddPrefixListEntry$Description": "

A description for the entry.

Constraints: Up to 255 characters in length.

", "Address$InstanceId": "

The ID of the instance that the address is associated with (if any).

", @@ -14978,6 +16038,9 @@ "AllocateHostsRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", "AllocateHostsRequest$InstanceType": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

", "AllocateHostsRequest$InstanceFamily": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

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

", + "AllocateIpamPoolCidrRequest$Cidr": "

The CIDR you would like to allocate from the IPAM pool. Note the following:

Possible values: Any available IPv4 or IPv6 CIDR.

", + "AllocateIpamPoolCidrRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "AllocateIpamPoolCidrRequest$Description": "

A description for the allocation.

", "AllowedPrincipal$Principal": "

The Amazon Resource Name (ARN) of the principal.

", "AlternatePathHint$ComponentId": "

The ID of the component.

", "AlternatePathHint$ComponentArn": "

The Amazon Resource Name (ARN) of the component.

", @@ -14986,6 +16049,7 @@ "AnalysisAclRule$RuleAction": "

Indicates whether to allow or deny traffic that matches the rule.

", "AnalysisComponent$Id": "

The ID of the component.

", "AnalysisComponent$Arn": "

The Amazon Resource Name (ARN) of the component.

", + "AnalysisComponent$Name": "

The name of the analysis component.

", "AnalysisLoadBalancerTarget$AvailabilityZone": "

The Availability Zone.

", "AnalysisPacketHeader$Protocol": "

The protocol.

", "AnalysisRouteTableRoute$DestinationCidr": "

The destination IPv4 address, in CIDR notation.

", @@ -15218,6 +16282,13 @@ "CreateImageResult$ImageId": "

The ID of the new AMI.

", "CreateInstanceEventWindowRequest$Name": "

The name of the event window.

", "CreateInstanceExportTaskRequest$Description": "

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

", + "CreateIpamPoolRequest$Locale": "

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region, such as us-east-1.

", + "CreateIpamPoolRequest$Description": "

A description for the IPAM pool.

", + "CreateIpamPoolRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "CreateIpamRequest$Description": "

A description for the IPAM.

", + "CreateIpamRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "CreateIpamScopeRequest$Description": "

A description for the scope you're creating.

", + "CreateIpamScopeRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", "CreateKeyPairRequest$KeyName": "

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

", "CreateLaunchTemplateRequest$ClientToken": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

", "CreateLaunchTemplateVersionRequest$ClientToken": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

", @@ -15231,6 +16302,7 @@ "CreateNetworkAclEntryRequest$CidrBlock": "

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", "CreateNetworkAclEntryRequest$Ipv6CidrBlock": "

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

", "CreateNetworkAclEntryRequest$Protocol": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "CreateNetworkInsightsAccessScopeRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", "CreateNetworkInsightsPathRequest$Source": "

The Amazon Web Services resource that is the source of the path.

", "CreateNetworkInsightsPathRequest$Destination": "

The Amazon Web Services resource that is the destination of the path.

", "CreateNetworkInsightsPathRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", @@ -15338,6 +16410,9 @@ "DeleteTransitGatewayRouteRequest$DestinationCidrBlock": "

The CIDR range for the route. This must match the CIDR for the route exactly.

", "DeleteVpnConnectionRouteRequest$DestinationCidrBlock": "

The CIDR block associated with the local subnet of the customer network.

", "DeprovisionByoipCidrRequest$Cidr": "

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

", + "DeprovisionIpamPoolCidrRequest$Cidr": "

The CIDR which you want to deprovision from the pool.

", + "DeprovisionPublicIpv4PoolCidrRequest$Cidr": "

The CIDR you want to deprovision from the pool.

", + "DeprovisionedAddressSet$member": null, "DeregisterTransitGatewayMulticastGroupMembersRequest$GroupIpAddress": "

The IP address assigned to the transit gateway multicast group.

", "DeregisterTransitGatewayMulticastGroupSourcesRequest$GroupIpAddress": "

The IP address assigned to the transit gateway multicast group.

", "DescribeByoipCidrsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", @@ -15419,6 +16494,8 @@ "DescribeNatGatewaysResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeNetworkAclsRequest$NextToken": "

The token for the next page of results.

", "DescribeNetworkAclsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeNetworkInsightsAccessScopeAnalysesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "DescribeNetworkInsightsAccessScopesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeNetworkInsightsAnalysesResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeNetworkInsightsPathsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeNetworkInterfaceAttributeResult$NetworkInterfaceId": "

The ID of the network interface.

", @@ -15532,6 +16609,7 @@ "DisableFastSnapshotRestoreSuccessItem$StateTransitionReason": "

The reason for the state transition. The possible values are as follows:

", "DisableFastSnapshotRestoreSuccessItem$OwnerId": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", "DisableFastSnapshotRestoreSuccessItem$OwnerAlias": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "DisableIpamOrganizationAdminAccountRequest$DelegatedAdminAccountId": "

The Organizations member account ID that you want to disable as IPAM account.

", "DisassociateAddressRequest$PublicIp": "

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

", "DisassociateClientVpnTargetNetworkResult$AssociationId": "

The ID of the target network association.

", "DisassociateSubnetCidrBlockResult$SubnetId": "

The ID of the subnet.

", @@ -15571,6 +16649,7 @@ "EnableFastSnapshotRestoreSuccessItem$StateTransitionReason": "

The reason for the state transition. The possible values are as follows:

", "EnableFastSnapshotRestoreSuccessItem$OwnerId": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", "EnableFastSnapshotRestoreSuccessItem$OwnerAlias": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "EnableIpamOrganizationAdminAccountRequest$DelegatedAdminAccountId": "

The Organizations member account ID that you want to enable as the IPAM account.

", "EventInformation$EventDescription": "

The description of the event.

", "EventInformation$EventSubType": "

The event.

error events:

fleetRequestChange events:

instanceChange events:

Information events:

", "EventInformation$InstanceId": "

The ID of the instance. This information is available only for instanceChange events.

", @@ -15670,7 +16749,12 @@ "GetHostReservationPurchasePreviewResult$TotalUpfrontPrice": "

The potential total upfront price. This is billed immediately.

", "GetInstanceTypesFromInstanceRequirementsRequest$NextToken": "

The token for the next set of results.

", "GetInstanceTypesFromInstanceRequirementsResult$NextToken": "

The token for the next set of results.

", + "GetIpamAddressHistoryRequest$Cidr": "

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

", + "GetIpamAddressHistoryRequest$VpcId": "

The ID of the VPC you want your history records filtered by.

", + "GetIpamResourceCidrsRequest$ResourceId": "

The ID of the resource.

", + "GetIpamResourceCidrsRequest$ResourceOwner": "

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

", "GetManagedPrefixListAssociationsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "GetNetworkInsightsAccessScopeAnalysisFindingsResult$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "GetPasswordDataResult$InstanceId": "

The ID of the Windows instance.

", "GetPasswordDataResult$PasswordData": "

The password of the instance. Returns an empty string if the password is not available.

", "GetReservedInstancesExchangeQuoteResult$CurrencyCode": "

The currency of the transaction.

", @@ -15875,6 +16959,42 @@ "IpRange$CidrIp": "

The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.

", "IpRange$Description": "

A description for the security group rule that references this IPv4 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "IpRanges$member": null, + "Ipam$OwnerId": "

The Amazon Web Services account ID of the owner of the IPAM.

", + "Ipam$IpamRegion": "

The Amazon Web Services Region of the IPAM.

", + "Ipam$Description": "

The description for the IPAM.

", + "IpamAddressHistoryRecord$ResourceOwnerId": "

The ID of the resource owner.

", + "IpamAddressHistoryRecord$ResourceRegion": "

The Amazon Web Services Region of the resource.

", + "IpamAddressHistoryRecord$ResourceId": "

The ID of the resource.

", + "IpamAddressHistoryRecord$ResourceCidr": "

The CIDR of the resource.

", + "IpamAddressHistoryRecord$ResourceName": "

The name of the resource.

", + "IpamAddressHistoryRecord$VpcId": "

The VPC ID of the resource.

", + "IpamCidrAuthorizationContext$Message": "

The plain-text authorization message for the prefix and account.

", + "IpamCidrAuthorizationContext$Signature": "

The signed authorization message for the prefix and account.

", + "IpamOperatingRegion$RegionName": "

The name of the operating Region.

", + "IpamPool$OwnerId": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", + "IpamPool$IpamRegion": "

The Amazon Web Services Region of the IPAM pool.

", + "IpamPool$Locale": "

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", + "IpamPool$StateMessage": "

A message related to the failed creation of an IPAM pool.

", + "IpamPool$Description": "

The description of the IPAM pool.

", + "IpamPoolAllocation$Cidr": "

The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "IpamPoolAllocation$Description": "

A description of the pool allocation.

", + "IpamPoolAllocation$ResourceId": "

The ID of the resource.

", + "IpamPoolAllocation$ResourceRegion": "

The Amazon Web Services Region of the resource.

", + "IpamPoolAllocation$ResourceOwner": "

The owner of the resource.

", + "IpamPoolAllocationDisallowedCidrs$member": null, + "IpamPoolCidr$Cidr": "

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "IpamPoolCidrFailureReason$Message": "

A message related to why an IPAM pool CIDR failed to be provisioned.

", + "IpamResourceCidr$ResourceRegion": "

The Amazon Web Services Region for an IPAM resource.

", + "IpamResourceCidr$ResourceOwnerId": "

The Amazon Web Services account number of the owner of an IPAM resource.

", + "IpamResourceCidr$ResourceId": "

The ID of an IPAM resource.

", + "IpamResourceCidr$ResourceName": "

The name of an IPAM resource.

", + "IpamResourceCidr$ResourceCidr": "

The CIDR for an IPAM resource.

", + "IpamResourceCidr$VpcId": "

The ID of a VPC.

", + "IpamResourceTag$Key": "

The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "IpamResourceTag$Value": "

The value of the tag.

", + "IpamScope$OwnerId": "

The Amazon Web Services account ID of the owner of the scope.

", + "IpamScope$IpamRegion": "

The Amazon Web Services Region of the IPAM scope.

", + "IpamScope$Description": "

The description of the scope.

", "Ipv4PrefixSpecification$Ipv4Prefix": "

The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

", "Ipv4PrefixSpecificationRequest$Ipv4Prefix": "

The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

", "Ipv4PrefixSpecificationResponse$Ipv4Prefix": "

One or more IPv4 delegated prefixes assigned to the network interface.

", @@ -16003,6 +17123,12 @@ "ModifyInstanceEventWindowRequest$Name": "

The name of the event window.

", "ModifyInstanceMetadataOptionsResult$InstanceId": "

The ID of the instance.

", "ModifyInstancePlacementRequest$HostResourceGroupArn": "

The ARN of the host resource group in which to place the instance.

", + "ModifyIpamPoolRequest$Description": "

The description of the IPAM pool you want to modify.

", + "ModifyIpamRequest$Description": "

The description of the IPAM you want to modify.

", + "ModifyIpamResourceCidrRequest$ResourceId": "

The ID of the resource you want to modify.

", + "ModifyIpamResourceCidrRequest$ResourceCidr": "

The CIDR of the resource you want to modify.

", + "ModifyIpamResourceCidrRequest$ResourceRegion": "

The Amazon Web Services Region of the resource you want to modify.

", + "ModifyIpamScopeRequest$Description": "

The description of the scope you want to modify.

", "ModifyLaunchTemplateRequest$ClientToken": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

", "ModifyLaunchTemplateRequest$DefaultVersion": "

The version number of the launch template to set as the default version.

", "ModifyManagedPrefixListRequest$PrefixListName": "

A name for the prefix list.

", @@ -16031,6 +17157,8 @@ "ModifyVpnTunnelOptionsSpecification$StartupAction": "

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

Valid Values: add | start

Default: add

", "MoveAddressToVpcRequest$PublicIp": "

The Elastic IP address.

", "MoveAddressToVpcResult$AllocationId": "

The allocation ID for the Elastic IP address.

", + "MoveByoipCidrToIpamRequest$Cidr": "

The BYOIP CIDR.

", + "MoveByoipCidrToIpamRequest$IpamPoolOwner": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", "MovingAddressStatus$PublicIp": "

The Elastic IP address.

", "NatGateway$FailureCode": "

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", "NatGateway$FailureMessage": "

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

", @@ -16050,7 +17178,10 @@ "NetworkAclEntry$CidrBlock": "

The IPv4 network range to allow or deny, in CIDR notation.

", "NetworkAclEntry$Ipv6CidrBlock": "

The IPv6 network range to allow or deny, in CIDR notation.

", "NetworkAclEntry$Protocol": "

The protocol number. A value of \"-1\" means all protocols.

", + "NetworkInsightsAccessScopeAnalysis$StatusMessage": "

The status message.

", + "NetworkInsightsAccessScopeAnalysis$WarningMessage": "

The warning message.

", "NetworkInsightsAnalysis$StatusMessage": "

The status message, if the status is failed.

", + "NetworkInsightsAnalysis$WarningMessage": "

The warning message.

", "NetworkInsightsPath$Source": "

The Amazon Web Services resource that is the source of the path.

", "NetworkInsightsPath$Destination": "

The Amazon Web Services resource that is the destination of the path.

", "NetworkInterface$AvailabilityZone": "

The Availability Zone.

", @@ -16136,6 +17267,7 @@ "PropagatingVgw$GatewayId": "

The ID of the virtual private gateway.

", "ProvisionByoipCidrRequest$Cidr": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.

", "ProvisionByoipCidrRequest$Description": "

A description for the address range and the address pool.

", + "ProvisionIpamPoolCidrRequest$Cidr": "

The CIDR you want to assign to the IPAM pool.

", "ProvisionedBandwidth$Provisioned": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "ProvisionedBandwidth$Requested": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "ProvisionedBandwidth$Status": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", @@ -16181,6 +17313,8 @@ "RegisterTransitGatewayMulticastGroupSourcesRequest$GroupIpAddress": "

The IP address assigned to the transit gateway multicast group.

", "ReleaseAddressRequest$PublicIp": "

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

", "ReleaseAddressRequest$NetworkBorderGroup": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.

", + "ReleaseIpamPoolAllocationRequest$Cidr": "

The CIDR of the allocation you want to release.

", + "RemoveIpamOperatingRegion$RegionName": "

The name of the operating Region you want to remove.

", "RemovePrefixListEntry$Cidr": "

The CIDR block.

", "ReplaceNetworkAclAssociationResult$NewAssociationId": "

The ID of the new association.

", "ReplaceNetworkAclEntryRequest$CidrBlock": "

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", @@ -16194,6 +17328,8 @@ "ReplaceRouteTableAssociationResult$NewAssociationId": "

The ID of the new association.

", "ReplaceTransitGatewayRouteRequest$DestinationCidrBlock": "

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

", "ReportInstanceStatusRequest$Description": "

Descriptive text about the health state of your instance.

", + "RequestIpamResourceTag$Key": "

The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "RequestIpamResourceTag$Value": "

The value for the tag.

", "RequestLaunchTemplateData$UserData": "

The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

", "RequestSpotFleetResponse$SpotFleetRequestId": "

The ID of the Spot Fleet request.

", "RequestSpotInstancesRequest$AvailabilityZoneGroup": "

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", @@ -16430,6 +17566,7 @@ "StaleSecurityGroup$GroupName": "

The name of the security group.

", "StaleSecurityGroup$VpcId": "

The ID of the VPC for the security group.

", "StartInstancesRequest$AdditionalInfo": "

Reserved.

", + "StartNetworkInsightsAccessScopeAnalysisRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", "StartNetworkInsightsAnalysisRequest$ClientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", "StateReason$Code": "

The reason code for the state change.

", "StateReason$Message": "

The message for the state change.

", @@ -16896,6 +18033,9 @@ "InstanceEventWindowAssociationTarget$Tags": "

The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.

", "InstanceEventWindowDisassociationRequest$InstanceTags": "

The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.

", "InternetGateway$Tags": "

Any tags assigned to the internet gateway.

", + "Ipam$Tags": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "IpamPool$Tags": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "IpamScope$Tags": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", "Ipv6Pool$Tags": "

Any tags for the address pool.

", "KeyPair$Tags": "

Any tags applied to the key pair.

", "KeyPairInfo$Tags": "

Any tags applied to the key pair.

", @@ -16911,6 +18051,8 @@ "ManagedPrefixList$Tags": "

The tags for the prefix list.

", "NatGateway$Tags": "

The tags for the NAT gateway.

", "NetworkAcl$Tags": "

Any tags assigned to the network ACL.

", + "NetworkInsightsAccessScope$Tags": "

The tags.

", + "NetworkInsightsAccessScopeAnalysis$Tags": "

The tags.

", "NetworkInsightsAnalysis$Tags": "

The tags.

", "NetworkInsightsPath$Tags": "

The tags associated with the path.

", "NetworkInterface$TagSet": "

Any tags assigned to the network interface.

", @@ -16982,15 +18124,20 @@ "CreateInstanceEventWindowRequest$TagSpecifications": "

The tags to apply to the event window.

", "CreateInstanceExportTaskRequest$TagSpecifications": "

The tags to apply to the export instance task during creation.

", "CreateInternetGatewayRequest$TagSpecifications": "

The tags to assign to the internet gateway.

", + "CreateIpamPoolRequest$TagSpecifications": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "CreateIpamRequest$TagSpecifications": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", + "CreateIpamScopeRequest$TagSpecifications": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", "CreateKeyPairRequest$TagSpecifications": "

The tags to apply to the new key pair.

", "CreateLaunchTemplateRequest$TagSpecifications": "

The tags to apply to the launch template during creation.

", "CreateLocalGatewayRouteTableVpcAssociationRequest$TagSpecifications": "

The tags to assign to the local gateway route table VPC association.

", "CreateManagedPrefixListRequest$TagSpecifications": "

The tags to apply to the prefix list during creation.

", "CreateNatGatewayRequest$TagSpecifications": "

The tags to assign to the NAT gateway.

", "CreateNetworkAclRequest$TagSpecifications": "

The tags to assign to the network ACL.

", + "CreateNetworkInsightsAccessScopeRequest$TagSpecifications": "

The tags to apply.

", "CreateNetworkInsightsPathRequest$TagSpecifications": "

The tags to add to the path.

", "CreateNetworkInterfaceRequest$TagSpecifications": "

The tags to apply to the new network interface.

", "CreatePlacementGroupRequest$TagSpecifications": "

The tags to apply to the new placement group.

", + "CreatePublicIpv4PoolRequest$TagSpecifications": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", "CreateReplaceRootVolumeTaskRequest$TagSpecifications": "

The tags to apply to the root volume replacement task.

", "CreateRestoreImageTaskRequest$TagSpecifications": "

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.

", "CreateRouteTableRequest$TagSpecifications": "

The tags to assign to the route table.

", @@ -17025,6 +18172,7 @@ "RequestSpotInstancesRequest$TagSpecifications": "

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.

", "RunInstancesRequest$TagSpecifications": "

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

", "SpotFleetRequestConfigData$TagSpecifications": "

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

", + "StartNetworkInsightsAccessScopeAnalysisRequest$TagSpecifications": "

The tags to apply.

", "StartNetworkInsightsAnalysisRequest$TagSpecifications": "

The tags to apply.

" } }, @@ -17188,6 +18336,30 @@ "VCpuInfo$ValidThreadsPerCore": "

The valid number of threads per core that can be configured for the instance type.

" } }, + "ThroughResourcesStatement": { + "base": "

Describes a through resource statement.

", + "refs": { + "ThroughResourcesStatementList$member": null + } + }, + "ThroughResourcesStatementList": { + "base": null, + "refs": { + "AccessScopePath$ThroughResources": "

The through resources.

" + } + }, + "ThroughResourcesStatementRequest": { + "base": "

Describes a through resource statement.

", + "refs": { + "ThroughResourcesStatementRequestList$member": null + } + }, + "ThroughResourcesStatementRequestList": { + "base": null, + "refs": { + "AccessScopePathRequest$ThroughResources": "

The through resources.

" + } + }, "TieringOperationStatus": { "base": null, "refs": { @@ -18293,6 +19465,9 @@ "CreateVpcEndpointServiceConfigurationRequest$NetworkLoadBalancerArns": "

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

", "CreateVpcEndpointServiceConfigurationRequest$GatewayLoadBalancerArns": "

The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.

", "DescribeClientVpnTargetNetworksRequest$AssociationIds": "

The IDs of the target network associations.

", + "DescribeIpamPoolsRequest$IpamPoolIds": "

The IDs of the IPAM pools you would like information on.

", + "DescribeIpamScopesRequest$IpamScopeIds": "

The IDs of the scopes you want information on.

", + "DescribeIpamsRequest$IpamIds": "

The IDs of the IPAMs you want information on.

", "DescribeManagedPrefixListsRequest$PrefixListIds": "

One or more prefix list IDs.

", "DescribeMovingAddressesRequest$PublicIps": "

One or more Elastic IP addresses.

", "DescribeVpcEndpointServicesRequest$ServiceNames": "

One or more service names.

", @@ -18309,8 +19484,24 @@ "ModifyVpcEndpointServicePermissionsRequest$AddAllowedPrincipals": "

The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).

", "ModifyVpcEndpointServicePermissionsRequest$RemoveAllowedPrincipals": "

The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.

", "NewDhcpConfiguration$Values": null, + "PacketHeaderStatement$SourceAddresses": "

The source addresses.

", + "PacketHeaderStatement$DestinationAddresses": "

The destination addresses.

", + "PacketHeaderStatement$SourcePorts": "

The source ports.

", + "PacketHeaderStatement$DestinationPorts": "

The destination ports.

", + "PacketHeaderStatement$SourcePrefixLists": "

The source prefix lists.

", + "PacketHeaderStatement$DestinationPrefixLists": "

The destination prefix lists.

", + "PacketHeaderStatementRequest$SourceAddresses": "

The source addresses.

", + "PacketHeaderStatementRequest$DestinationAddresses": "

The destination addresses.

", + "PacketHeaderStatementRequest$SourcePorts": "

The source ports.

", + "PacketHeaderStatementRequest$DestinationPorts": "

The destination ports.

", + "PacketHeaderStatementRequest$SourcePrefixLists": "

The source prefix lists.

", + "PacketHeaderStatementRequest$DestinationPrefixLists": "

The destination prefix lists.

", "PrefixList$Cidrs": "

The IP address range of the Amazon Web Service.

", "RejectTransitGatewayMulticastDomainAssociationsRequest$SubnetIds": "

The IDs of the subnets to associate with the transit gateway multicast domain.

", + "ResourceStatement$Resources": "

The resources.

", + "ResourceStatement$ResourceTypes": "

The resource types.

", + "ResourceStatementRequest$Resources": "

The resources.

", + "ResourceStatementRequest$ResourceTypes": "

The resource types.

", "ResponseLaunchTemplateData$SecurityGroupIds": "

The security group IDs.

", "ResponseLaunchTemplateData$SecurityGroups": "

The security group names.

", "ServiceConfiguration$AvailabilityZones": "

The Availability Zones in which the service is available.

", diff --git a/models/apis/ec2/2016-11-15/paginators-1.json b/models/apis/ec2/2016-11-15/paginators-1.json index b3d97ce0481..a44793e9a69 100755 --- a/models/apis/ec2/2016-11-15/paginators-1.json +++ b/models/apis/ec2/2016-11-15/paginators-1.json @@ -216,6 +216,24 @@ "output_token": "NextToken", "result_key": "InternetGateways" }, + "DescribeIpamPools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpamPools" + }, + "DescribeIpamScopes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpamScopes" + }, + "DescribeIpams": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Ipams" + }, "DescribeIpv6Pools": { "input_token": "NextToken", "limit_key": "MaxResults", @@ -297,6 +315,18 @@ "output_token": "NextToken", "result_key": "NetworkAcls" }, + "DescribeNetworkInsightsAccessScopeAnalyses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInsightsAccessScopeAnalyses" + }, + "DescribeNetworkInsightsAccessScopes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInsightsAccessScopes" + }, "DescribeNetworkInsightsAnalyses": { "input_token": "NextToken", "limit_key": "MaxResults", @@ -614,6 +644,30 @@ "output_token": "NextToken", "result_key": "InstanceTypes" }, + "GetIpamAddressHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "HistoryRecords" + }, + "GetIpamPoolAllocations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpamPoolAllocations" + }, + "GetIpamPoolCidrs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpamPoolCidrs" + }, + "GetIpamResourceCidrs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpamResourceCidrs" + }, "GetManagedPrefixListAssociations": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/kendra/2019-02-03/api-2.json b/models/apis/kendra/2019-02-03/api-2.json index 8abb39a3c82..a36cf6e9115 100644 --- a/models/apis/kendra/2019-02-03/api-2.json +++ b/models/apis/kendra/2019-02-03/api-2.json @@ -14,6 +14,40 @@ "uid":"kendra-2019-02-03" }, "operations":{ + "AssociateEntitiesToExperience":{ + "name":"AssociateEntitiesToExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateEntitiesToExperienceRequest"}, + "output":{"shape":"AssociateEntitiesToExperienceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "AssociatePersonasToEntities":{ + "name":"AssociatePersonasToEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociatePersonasToEntitiesRequest"}, + "output":{"shape":"AssociatePersonasToEntitiesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "BatchDeleteDocument":{ "name":"BatchDeleteDocument", "http":{ @@ -101,6 +135,24 @@ {"shape":"InternalServerException"} ] }, + "CreateExperience":{ + "name":"CreateExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExperienceRequest"}, + "output":{"shape":"CreateExperienceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "CreateFaq":{ "name":"CreateFaq", "http":{ @@ -189,6 +241,23 @@ {"shape":"InternalServerException"} ] }, + "DeleteExperience":{ + "name":"DeleteExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteExperienceRequest"}, + "output":{"shape":"DeleteExperienceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteFaq":{ "name":"DeleteFaq", "http":{ @@ -285,6 +354,22 @@ {"shape":"InternalServerException"} ] }, + "DescribeExperience":{ + "name":"DescribeExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExperienceRequest"}, + "output":{"shape":"DescribeExperienceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeFaq":{ "name":"DescribeFaq", "http":{ @@ -381,6 +466,38 @@ {"shape":"InternalServerException"} ] }, + "DisassociateEntitiesFromExperience":{ + "name":"DisassociateEntitiesFromExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateEntitiesFromExperienceRequest"}, + "output":{"shape":"DisassociateEntitiesFromExperienceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "DisassociatePersonasFromEntities":{ + "name":"DisassociatePersonasFromEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociatePersonasFromEntitiesRequest"}, + "output":{"shape":"DisassociatePersonasFromEntitiesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "GetQuerySuggestions":{ "name":"GetQuerySuggestions", "http":{ @@ -399,6 +516,21 @@ {"shape":"InternalServerException"} ] }, + "GetSnapshots":{ + "name":"GetSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSnapshotsRequest"}, + "output":{"shape":"GetSnapshotsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "ListDataSourceSyncJobs":{ "name":"ListDataSourceSyncJobs", "http":{ @@ -432,6 +564,54 @@ {"shape":"InternalServerException"} ] }, + "ListEntityPersonas":{ + "name":"ListEntityPersonas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntityPersonasRequest"}, + "output":{"shape":"ListEntityPersonasResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, + "ListExperienceEntities":{ + "name":"ListExperienceEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExperienceEntitiesRequest"}, + "output":{"shape":"ListExperienceEntitiesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, + "ListExperiences":{ + "name":"ListExperiences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExperiencesRequest"}, + "output":{"shape":"ListExperiencesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "ListFaqs":{ "name":"ListFaqs", "http":{ @@ -660,6 +840,22 @@ {"shape":"InternalServerException"} ] }, + "UpdateExperience":{ + "name":"UpdateExperience", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateExperienceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateIndex":{ "name":"UpdateIndex", "http":{ @@ -779,6 +975,56 @@ "max":1011, "min":1 }, + "AssociateEntitiesToExperienceFailedEntityList":{ + "type":"list", + "member":{"shape":"FailedEntity"}, + "max":20, + "min":1 + }, + "AssociateEntitiesToExperienceRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId", + "EntityList" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "EntityList":{"shape":"AssociateEntityList"} + } + }, + "AssociateEntitiesToExperienceResponse":{ + "type":"structure", + "members":{ + "FailedEntityList":{"shape":"AssociateEntitiesToExperienceFailedEntityList"} + } + }, + "AssociateEntityList":{ + "type":"list", + "member":{"shape":"EntityConfiguration"}, + "max":20, + "min":1 + }, + "AssociatePersonasToEntitiesRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId", + "Personas" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "Personas":{"shape":"EntityPersonaConfigurationList"} + } + }, + "AssociatePersonasToEntitiesResponse":{ + "type":"structure", + "members":{ + "FailedEntityList":{"shape":"FailedEntityList"} + } + }, "AttributeFilter":{ "type":"structure", "members":{ @@ -892,7 +1138,8 @@ "members":{ "IndexId":{"shape":"IndexId"}, "RoleArn":{"shape":"RoleArn"}, - "Documents":{"shape":"DocumentList"} + "Documents":{"shape":"DocumentList"}, + "CustomDocumentEnrichmentConfiguration":{"shape":"CustomDocumentEnrichmentConfiguration"} } }, "BatchPutDocumentResponse":{ @@ -986,6 +1233,22 @@ "min":1, "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" }, + "ConditionOperator":{ + "type":"string", + "enum":[ + "GreaterThan", + "GreaterThanOrEquals", + "LessThan", + "LessThanOrEquals", + "Equals", + "NotEquals", + "Contains", + "NotContains", + "Exists", + "NotExists", + "BeginsWith" + ] + }, "ConflictException":{ "type":"structure", "members":{ @@ -1189,6 +1452,14 @@ "SecretArn":{"shape":"SecretArn"} } }, + "ContentSourceConfiguration":{ + "type":"structure", + "members":{ + "DataSourceIds":{"shape":"DataSourceIdList"}, + "FaqIds":{"shape":"FaqIdsList"}, + "DirectPutContent":{"shape":"Boolean"} + } + }, "ContentType":{ "type":"string", "enum":[ @@ -1224,7 +1495,8 @@ "shape":"ClientTokenName", "idempotencyToken":true }, - "LanguageCode":{"shape":"LanguageCode"} + "LanguageCode":{"shape":"LanguageCode"}, + "CustomDocumentEnrichmentConfiguration":{"shape":"CustomDocumentEnrichmentConfiguration"} } }, "CreateDataSourceResponse":{ @@ -1234,6 +1506,31 @@ "Id":{"shape":"DataSourceId"} } }, + "CreateExperienceRequest":{ + "type":"structure", + "required":[ + "Name", + "IndexId" + ], + "members":{ + "Name":{"shape":"ExperienceName"}, + "IndexId":{"shape":"IndexId"}, + "RoleArn":{"shape":"RoleArn"}, + "Configuration":{"shape":"ExperienceConfiguration"}, + "Description":{"shape":"Description"}, + "ClientToken":{ + "shape":"ClientTokenName", + "idempotencyToken":true + } + } + }, + "CreateExperienceResponse":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{"shape":"ExperienceId"} + } + }, "CreateFaqRequest":{ "type":"structure", "required":[ @@ -1345,6 +1642,15 @@ "Id":{"shape":"ThesaurusId"} } }, + "CustomDocumentEnrichmentConfiguration":{ + "type":"structure", + "members":{ + "InlineConfigurations":{"shape":"InlineCustomDocumentEnrichmentConfigurationList"}, + "PreExtractionHookConfiguration":{"shape":"HookConfiguration"}, + "PostExtractionHookConfiguration":{"shape":"HookConfiguration"}, + "RoleArn":{"shape":"RoleArn"} + } + }, "DataSourceConfiguration":{ "type":"structure", "members":{ @@ -1395,6 +1701,12 @@ "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" }, + "DataSourceIdList":{ + "type":"list", + "member":{"shape":"DataSourceId"}, + "max":100, + "min":1 + }, "DataSourceInclusionsExclusionsStrings":{ "type":"list", "member":{"shape":"DataSourceInclusionsExclusionsStringsMember"}, @@ -1588,6 +1900,22 @@ "IndexId":{"shape":"IndexId"} } }, + "DeleteExperienceRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"} + } + }, + "DeleteExperienceResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteFaqRequest":{ "type":"structure", "required":[ @@ -1667,7 +1995,35 @@ "Schedule":{"shape":"ScanSchedule"}, "RoleArn":{"shape":"RoleArn"}, "ErrorMessage":{"shape":"ErrorMessage"}, - "LanguageCode":{"shape":"LanguageCode"} + "LanguageCode":{"shape":"LanguageCode"}, + "CustomDocumentEnrichmentConfiguration":{"shape":"CustomDocumentEnrichmentConfiguration"} + } + }, + "DescribeExperienceRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"} + } + }, + "DescribeExperienceResponse":{ + "type":"structure", + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "Name":{"shape":"ExperienceName"}, + "Endpoints":{"shape":"ExperienceEndpoints"}, + "Configuration":{"shape":"ExperienceConfiguration"}, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"}, + "Description":{"shape":"Description"}, + "Status":{"shape":"ExperienceStatus"}, + "RoleArn":{"shape":"RoleArn"}, + "ErrorMessage":{"shape":"ErrorMessage"} } }, "DescribeFaqRequest":{ @@ -1825,11 +2181,55 @@ "SynonymRuleCount":{"shape":"Long"} } }, - "Description":{ - "type":"string", - "max":1000, - "min":0, - "pattern":"^\\P{C}*$" + "Description":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^\\P{C}*$" + }, + "DisassociateEntitiesFromExperienceRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId", + "EntityList" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "EntityList":{"shape":"DisassociateEntityList"} + } + }, + "DisassociateEntitiesFromExperienceResponse":{ + "type":"structure", + "members":{ + "FailedEntityList":{"shape":"FailedEntityList"} + } + }, + "DisassociateEntityList":{ + "type":"list", + "member":{"shape":"EntityConfiguration"}, + "max":40, + "min":1 + }, + "DisassociatePersonasFromEntitiesRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId", + "EntityIds" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "EntityIds":{"shape":"EntityIdsList"} + } + }, + "DisassociatePersonasFromEntitiesResponse":{ + "type":"structure", + "members":{ + "FailedEntityList":{"shape":"FailedEntityList"} + } }, "Document":{ "type":"structure", @@ -1856,6 +2256,18 @@ "Value":{"shape":"DocumentAttributeValue"} } }, + "DocumentAttributeCondition":{ + "type":"structure", + "required":[ + "ConditionDocumentAttributeKey", + "Operator" + ], + "members":{ + "ConditionDocumentAttributeKey":{"shape":"DocumentAttributeKey"}, + "Operator":{"shape":"ConditionOperator"}, + "ConditionOnValue":{"shape":"DocumentAttributeValue"} + } + }, "DocumentAttributeKey":{ "type":"string", "max":200, @@ -1881,6 +2293,14 @@ "max":2048, "min":1 }, + "DocumentAttributeTarget":{ + "type":"structure", + "members":{ + "TargetDocumentAttributeKey":{"shape":"DocumentAttributeKey"}, + "TargetDocumentAttributeValueDeletion":{"shape":"Boolean"}, + "TargetDocumentAttributeValue":{"shape":"DocumentAttributeValue"} + } + }, "DocumentAttributeValue":{ "type":"structure", "members":{ @@ -2010,6 +2430,73 @@ "min":1, "pattern":"[0-9]+[s]" }, + "Endpoint":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\P{C}*$" + }, + "EndpointType":{ + "type":"string", + "enum":["HOME"] + }, + "EntityConfiguration":{ + "type":"structure", + "required":[ + "EntityId", + "EntityType" + ], + "members":{ + "EntityId":{"shape":"EntityId"}, + "EntityType":{"shape":"EntityType"} + } + }, + "EntityDisplayData":{ + "type":"structure", + "members":{ + "UserName":{"shape":"NameType"}, + "GroupName":{"shape":"NameType"}, + "IdentifiedUserName":{"shape":"NameType"}, + "FirstName":{"shape":"NameType"}, + "LastName":{"shape":"NameType"} + } + }, + "EntityId":{ + "type":"string", + "max":47, + "min":1, + "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + }, + "EntityIdsList":{ + "type":"list", + "member":{"shape":"EntityId"}, + "max":25, + "min":1 + }, + "EntityPersonaConfiguration":{ + "type":"structure", + "required":[ + "EntityId", + "Persona" + ], + "members":{ + "EntityId":{"shape":"EntityId"}, + "Persona":{"shape":"Persona"} + } + }, + "EntityPersonaConfigurationList":{ + "type":"list", + "member":{"shape":"EntityPersonaConfiguration"}, + "max":25, + "min":1 + }, + "EntityType":{ + "type":"string", + "enum":[ + "USER", + "GROUP" + ] + }, "ErrorCode":{ "type":"string", "enum":[ @@ -2041,6 +2528,73 @@ "max":100, "min":0 }, + "ExperienceConfiguration":{ + "type":"structure", + "members":{ + "ContentSourceConfiguration":{"shape":"ContentSourceConfiguration"}, + "UserIdentityConfiguration":{"shape":"UserIdentityConfiguration"} + } + }, + "ExperienceEndpoint":{ + "type":"structure", + "members":{ + "EndpointType":{"shape":"EndpointType"}, + "Endpoint":{"shape":"Endpoint"} + } + }, + "ExperienceEndpoints":{ + "type":"list", + "member":{"shape":"ExperienceEndpoint"}, + "max":2, + "min":1 + }, + "ExperienceEntitiesSummary":{ + "type":"structure", + "members":{ + "EntityId":{"shape":"EntityId"}, + "EntityType":{"shape":"EntityType"}, + "DisplayData":{"shape":"EntityDisplayData"} + } + }, + "ExperienceEntitiesSummaryList":{ + "type":"list", + "member":{"shape":"ExperienceEntitiesSummary"} + }, + "ExperienceId":{ + "type":"string", + "max":36, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "ExperienceName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "ExperienceStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED" + ] + }, + "ExperiencesSummary":{ + "type":"structure", + "members":{ + "Name":{"shape":"ExperienceName"}, + "Id":{"shape":"ExperienceId"}, + "CreatedAt":{"shape":"Timestamp"}, + "Status":{"shape":"ExperienceStatus"}, + "Endpoints":{"shape":"ExperienceEndpoints"} + } + }, + "ExperiencesSummaryList":{ + "type":"list", + "member":{"shape":"ExperiencesSummary"} + }, "Facet":{ "type":"structure", "members":{ @@ -2063,6 +2617,19 @@ "type":"list", "member":{"shape":"FacetResult"} }, + "FailedEntity":{ + "type":"structure", + "members":{ + "EntityId":{"shape":"EntityId"}, + "ErrorMessage":{"shape":"ErrorMessage"} + } + }, + "FailedEntityList":{ + "type":"list", + "member":{"shape":"FailedEntity"}, + "max":25, + "min":1 + }, "FailureReason":{ "type":"string", "max":2048, @@ -2083,6 +2650,12 @@ "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" }, + "FaqIdsList":{ + "type":"list", + "member":{"shape":"FaqId"}, + "max":100, + "min":1 + }, "FaqName":{ "type":"string", "max":100, @@ -2147,6 +2720,30 @@ "Suggestions":{"shape":"SuggestionList"} } }, + "GetSnapshotsRequest":{ + "type":"structure", + "required":[ + "IndexId", + "Interval", + "MetricType" + ], + "members":{ + "IndexId":{"shape":"IndexId"}, + "Interval":{"shape":"Interval"}, + "MetricType":{"shape":"MetricType"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"Integer"} + } + }, + "GetSnapshotsResponse":{ + "type":"structure", + "members":{ + "SnapShotTimeFilter":{"shape":"TimeRange"}, + "SnapshotsDataHeader":{"shape":"SnapshotsDataHeaderFields"}, + "SnapshotsData":{"shape":"SnapshotsDataRecords"}, + "NextToken":{"shape":"NextToken"} + } + }, "GoogleDriveConfiguration":{ "type":"structure", "required":["SecretArn"], @@ -2245,12 +2842,30 @@ "THESAURUS_SYNONYM" ] }, + "HookConfiguration":{ + "type":"structure", + "required":[ + "LambdaArn", + "S3Bucket" + ], + "members":{ + "InvocationCondition":{"shape":"DocumentAttributeCondition"}, + "LambdaArn":{"shape":"LambdaArn"}, + "S3Bucket":{"shape":"S3BucketName"} + } + }, "Host":{ "type":"string", "max":253, "min":1, "pattern":"([^\\s]*)" }, + "IdentityAttributeName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, "Importance":{ "type":"integer", "max":10, @@ -2335,6 +2950,20 @@ "type":"integer", "min":0 }, + "InlineCustomDocumentEnrichmentConfiguration":{ + "type":"structure", + "members":{ + "Condition":{"shape":"DocumentAttributeCondition"}, + "Target":{"shape":"DocumentAttributeTarget"}, + "DocumentContentDeletion":{"shape":"Boolean"} + } + }, + "InlineCustomDocumentEnrichmentConfigurationList":{ + "type":"list", + "member":{"shape":"InlineCustomDocumentEnrichmentConfiguration"}, + "max":100, + "min":0 + }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", @@ -2344,6 +2973,24 @@ "exception":true, "fault":true }, + "Interval":{ + "type":"string", + "enum":[ + "THIS_MONTH", + "THIS_WEEK", + "ONE_WEEK_AGO", + "TWO_WEEKS_AGO", + "ONE_MONTH_AGO", + "TWO_MONTHS_AGO" + ] + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "exception":true + }, "Issuer":{ "type":"string", "max":65, @@ -2387,6 +3034,12 @@ "min":1, "sensitive":true }, + "LambdaArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"/arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?/" + }, "LanguageCode":{ "type":"string", "max":10, @@ -2431,6 +3084,61 @@ "NextToken":{"shape":"NextToken"} } }, + "ListEntityPersonasRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResultsIntegerForListEntityPersonasRequest"} + } + }, + "ListEntityPersonasResponse":{ + "type":"structure", + "members":{ + "SummaryItems":{"shape":"PersonasSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListExperienceEntitiesRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "IndexId":{"shape":"IndexId"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListExperienceEntitiesResponse":{ + "type":"structure", + "members":{ + "SummaryItems":{"shape":"ExperienceEntitiesSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListExperiencesRequest":{ + "type":"structure", + "required":["IndexId"], + "members":{ + "IndexId":{"shape":"IndexId"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResultsIntegerForListExperiencesRequest"} + } + }, + "ListExperiencesResponse":{ + "type":"structure", + "members":{ + "SummaryItems":{"shape":"ExperiencesSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListFaqsRequest":{ "type":"structure", "required":["IndexId"], @@ -2552,6 +3260,16 @@ "max":100, "min":1 }, + "MaxResultsIntegerForListEntityPersonasRequest":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxResultsIntegerForListExperiencesRequest":{ + "type":"integer", + "max":100, + "min":1 + }, "MaxResultsIntegerForListFaqsRequest":{ "type":"integer", "max":100, @@ -2609,6 +3327,17 @@ "max":1000, "min":1 }, + "MetricType":{ + "type":"string", + "enum":[ + "QUERIES_BY_COUNT", + "QUERIES_BY_ZERO_CLICK_RATE", + "QUERIES_BY_ZERO_RESULT_RATE", + "DOCS_BY_CLICK_COUNT", + "AGG_QUERY_DOC_METRICS", + "TREND_QUERY_DOC_METRICS" + ] + }, "MetricValue":{ "type":"string", "pattern":"(([1-9][0-9]*)|0)" @@ -2636,6 +3365,13 @@ "LEARN_ONLY" ] }, + "NameType":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[\\S\\s]*$", + "sensitive":true + }, "NextToken":{ "type":"string", "max":800, @@ -2691,6 +3427,26 @@ "min":12, "pattern":"d-[0-9a-fA-F]{10}" }, + "Persona":{ + "type":"string", + "enum":[ + "OWNER", + "VIEWER" + ] + }, + "PersonasSummary":{ + "type":"structure", + "members":{ + "EntityId":{"shape":"EntityId"}, + "Persona":{"shape":"Persona"}, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"} + } + }, + "PersonasSummaryList":{ + "type":"list", + "member":{"shape":"PersonasSummary"} + }, "Port":{ "type":"integer", "max":65535, @@ -2975,7 +3731,7 @@ "RoleArn":{ "type":"string", "max":1284, - "min":1, + "min":0, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "S3BucketName":{ @@ -3357,6 +4113,18 @@ "max":3, "min":0 }, + "SnapshotsDataHeaderFields":{ + "type":"list", + "member":{"shape":"String"} + }, + "SnapshotsDataRecord":{ + "type":"list", + "member":{"shape":"String"} + }, + "SnapshotsDataRecords":{ + "type":"list", + "member":{"shape":"SnapshotsDataRecord"} + }, "SortOrder":{ "type":"string", "enum":[ @@ -3659,7 +4427,23 @@ "Description":{"shape":"Description"}, "Schedule":{"shape":"ScanSchedule"}, "RoleArn":{"shape":"RoleArn"}, - "LanguageCode":{"shape":"LanguageCode"} + "LanguageCode":{"shape":"LanguageCode"}, + "CustomDocumentEnrichmentConfiguration":{"shape":"CustomDocumentEnrichmentConfiguration"} + } + }, + "UpdateExperienceRequest":{ + "type":"structure", + "required":[ + "Id", + "IndexId" + ], + "members":{ + "Id":{"shape":"ExperienceId"}, + "Name":{"shape":"ExperienceName"}, + "IndexId":{"shape":"IndexId"}, + "RoleArn":{"shape":"RoleArn"}, + "Configuration":{"shape":"ExperienceConfiguration"}, + "Description":{"shape":"Description"} } }, "UpdateIndexRequest":{ @@ -3774,6 +4558,12 @@ "min":1, "pattern":"^\\P{C}*$" }, + "UserIdentityConfiguration":{ + "type":"structure", + "members":{ + "IdentityAttributeName":{"shape":"IdentityAttributeName"} + } + }, "UserNameAttributeField":{ "type":"string", "max":100, diff --git a/models/apis/kendra/2019-02-03/docs-2.json b/models/apis/kendra/2019-02-03/docs-2.json index 0aadf2bdd2e..2e27729543d 100644 --- a/models/apis/kendra/2019-02-03/docs-2.json +++ b/models/apis/kendra/2019-02-03/docs-2.json @@ -2,48 +2,60 @@ "version": "2.0", "service": "

Amazon Kendra is a service for indexing large document sets.

", "operations": { + "AssociateEntitiesToExperience": "

Grants users or groups in your Amazon Web Services SSO identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "AssociatePersonasToEntities": "

Defines the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "BatchDeleteDocument": "

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

", "BatchGetDocumentStatus": "

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

", "BatchPutDocument": "

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

", - "ClearQuerySuggestions": "

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

", - "CreateDataSource": "

Creates a data source that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", + "ClearQuerySuggestions": "

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "CreateDataSource": "

Creates a data source that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.

", + "CreateExperience": "

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "CreateFaq": "

Creates an new set of frequently asked question (FAQ) questions and answers.

", "CreateIndex": "

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

", - "CreateQuerySuggestionsBlockList": "

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

", + "CreateQuerySuggestionsBlockList": "

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "CreateThesaurus": "

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

", "DeleteDataSource": "

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources.

", + "DeleteExperience": "

Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "DeleteFaq": "

Removes an FAQ from an index.

", "DeleteIndex": "

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

", - "DeletePrincipalMapping": "

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

", - "DeleteQuerySuggestionsBlockList": "

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

", + "DeletePrincipalMapping": "

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "DeleteQuerySuggestionsBlockList": "

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "DeleteThesaurus": "

Deletes an existing Amazon Kendra thesaurus.

", "DescribeDataSource": "

Gets information about a Amazon Kendra data source.

", + "DescribeExperience": "

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "DescribeFaq": "

Gets information about an FAQ list.

", "DescribeIndex": "

Describes an existing Amazon Kendra index

", - "DescribePrincipalMapping": "

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

", - "DescribeQuerySuggestionsBlockList": "

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

", - "DescribeQuerySuggestionsConfig": "

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

", + "DescribePrincipalMapping": "

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "DescribeQuerySuggestionsBlockList": "

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "DescribeQuerySuggestionsConfig": "

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "DescribeThesaurus": "

Describes an existing Amazon Kendra thesaurus.

", - "GetQuerySuggestions": "

Fetches the queries that are suggested to your users.

", + "DisassociateEntitiesFromExperience": "

Prevents users or groups in your Amazon Web Services SSO identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "DisassociatePersonasFromEntities": "

Removes the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "GetQuerySuggestions": "

Fetches the queries that are suggested to your users.

GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "GetSnapshots": "

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

", "ListDataSourceSyncJobs": "

Gets statistics about synchronizing Amazon Kendra with a data source.

", "ListDataSources": "

Lists the data sources that you have created.

", + "ListEntityPersonas": "

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

", + "ListExperienceEntities": "

Lists users or groups in your Amazon Web Services SSO identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "ListExperiences": "

Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "ListFaqs": "

Gets a list of FAQ lists associated with an index.

", - "ListGroupsOlderThanOrderingId": "

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

", + "ListGroupsOlderThanOrderingId": "

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "ListIndices": "

Lists the Amazon Kendra indexes that you have created.

", - "ListQuerySuggestionsBlockLists": "

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

", + "ListQuerySuggestionsBlockLists": "

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "ListTagsForResource": "

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

", "ListThesauri": "

Lists the Amazon Kendra thesauri associated with an index.

", - "PutPrincipalMapping": "

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

", + "PutPrincipalMapping": "

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "Query": "

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

", "StartDataSourceSyncJob": "

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

", "StopDataSourceSyncJob": "

Stops a running synchronization job. You can't stop a scheduled synchronization job.

", - "SubmitFeedback": "

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

", + "SubmitFeedback": "

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "TagResource": "

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

", "UntagResource": "

Removes a tag from an index, FAQ, or a data source.

", "UpdateDataSource": "

Updates an existing Amazon Kendra data source.

", + "UpdateExperience": "

Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "UpdateIndex": "

Updates an existing Amazon Kendra index.

", - "UpdateQuerySuggestionsBlockList": "

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

", - "UpdateQuerySuggestionsConfig": "

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

", + "UpdateQuerySuggestionsBlockList": "

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", + "UpdateQuerySuggestionsConfig": "

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "UpdateThesaurus": "

Updates a thesaurus file associated with an index.

" }, "shapes": { @@ -96,8 +108,40 @@ "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.

" } }, + "AssociateEntitiesToExperienceFailedEntityList": { + "base": null, + "refs": { + "AssociateEntitiesToExperienceResponse$FailedEntityList": "

Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.

" + } + }, + "AssociateEntitiesToExperienceRequest": { + "base": null, + "refs": { + } + }, + "AssociateEntitiesToExperienceResponse": { + "base": null, + "refs": { + } + }, + "AssociateEntityList": { + "base": null, + "refs": { + "AssociateEntitiesToExperienceRequest$EntityList": "

Lists users or groups in your Amazon Web Services SSO identity source.

" + } + }, + "AssociatePersonasToEntitiesRequest": { + "base": null, + "refs": { + } + }, + "AssociatePersonasToEntitiesResponse": { + "base": null, + "refs": { + } + }, "AttributeFilter": { - "base": "

Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

  1. <OrAllFilters>

  2. <EqualTo>

If you use more than 2 layers, you receive a ValidationException exception with the message \"AttributeFilter cannot have a depth of more than 2.\"

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message \"AttributeFilter cannot have a length of more than 10\".

", + "base": "

Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

  1. <OrAllFilters>

  2. <EqualsTo>

If you use more than 2 layers, you receive a ValidationException exception with the message \"AttributeFilter cannot have a depth of more than 2.\"

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message \"AttributeFilter cannot have a length of more than 10\".

", "refs": { "AttributeFilter$NotFilter": "

Performs a logical NOT operation on all supplied filters.

", "AttributeFilterList$member": null, @@ -114,7 +158,7 @@ "AuthenticationConfiguration": { "base": "

Provides the configuration information to connect to websites that require user authentication.

", "refs": { - "WebCrawlerConfiguration$AuthenticationConfiguration": "

Provides configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.

" + "WebCrawlerConfiguration$AuthenticationConfiguration": "

Provides configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS. You use a secret in Secrets Manager to store your authentication credentials.

" } }, "BasicAuthenticationConfiguration": { @@ -207,7 +251,10 @@ "ConfluenceAttachmentConfiguration$CrawlAttachments": "

Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

", "ConfluenceSpaceConfiguration$CrawlPersonalSpaces": "

Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

", "ConfluenceSpaceConfiguration$CrawlArchivedSpaces": "

Specifies whether Amazon Kendra should index archived spaces.

", + "ContentSourceConfiguration$DirectPutContent": "

TRUE to use documents you indexed directly using the BatchPutDocument operation.

", + "DocumentAttributeTarget$TargetDocumentAttributeValueDeletion": "

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

", "Highlight$TopAnswer": "

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

", + "InlineCustomDocumentEnrichmentConfiguration$DocumentContentDeletion": "

TRUE to delete content if the condition used for the target attribute is met.

", "OneDriveConfiguration$DisableLocalGroups": "

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

", "SalesforceConfiguration$CrawlAttachments": "

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

", "Search$Facetable": "

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

", @@ -263,6 +310,7 @@ "base": null, "refs": { "CreateDataSourceRequest$ClientToken": "

A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource operation with the same client token will create only one data source.

", + "CreateExperienceRequest$ClientToken": "

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience operation with the same client token creates only one Amazon Kendra experience.

", "CreateFaqRequest$ClientToken": "

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest operation with the same client token will create only one FAQ.

", "CreateIndexRequest$ClientToken": "

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.

", "CreateQuerySuggestionsBlockListRequest$ClientToken": "

A token that you provide to identify the request to create a query suggestions block list.

", @@ -285,6 +333,12 @@ "ColumnConfiguration$DocumentTitleColumnName": "

The column that contains the title of the document.

" } }, + "ConditionOperator": { + "base": null, + "refs": { + "DocumentAttributeCondition$Operator": "

The condition operator.

For example, you can use 'Contains' to partially match a string.

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

", "refs": { @@ -417,6 +471,12 @@ "DatabaseConfiguration$ConnectionConfiguration": "

The information necessary to connect to a database.

" } }, + "ContentSourceConfiguration": { + "base": "

Configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.

", + "refs": { + "ExperienceConfiguration$ContentSourceConfiguration": "

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument operation. This is the content you want to use for your Amazon Kendra experience.

" + } + }, "ContentType": { "base": null, "refs": { @@ -439,6 +499,16 @@ "refs": { } }, + "CreateExperienceRequest": { + "base": null, + "refs": { + } + }, + "CreateExperienceResponse": { + "base": null, + "refs": { + } + }, "CreateFaqRequest": { "base": null, "refs": { @@ -479,12 +549,21 @@ "refs": { } }, + "CustomDocumentEnrichmentConfiguration": { + "base": "

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process.

", + "refs": { + "BatchPutDocumentRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", + "CreateDataSourceRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you create a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", + "DescribeDataSourceResponse$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", + "UpdateDataSourceRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you update a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

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

Configuration information for a Amazon Kendra data source.

", + "base": "

Configuration information for an Amazon Kendra data source.

", "refs": { "CreateDataSourceRequest$Configuration": "

The connector configuration information that is required to access the repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

", "DescribeDataSourceResponse$Configuration": "

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

", - "UpdateDataSourceRequest$Configuration": null + "UpdateDataSourceRequest$Configuration": "

Configuration information for an Amazon Kendra data source.

" } }, "DataSourceDateFieldFormat": { @@ -534,6 +613,7 @@ "refs": { "CreateDataSourceResponse$Id": "

A unique identifier for the data source.

", "DataSourceGroup$DataSourceId": "

The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.

", + "DataSourceIdList$member": null, "DataSourceSummary$Id": "

The unique identifier for the data source.

", "DataSourceSyncJobMetricTarget$DataSourceId": "

The ID of the data source that is running the sync job.

", "DeleteDataSourceRequest$Id": "

The unique identifier of the data source to delete.

", @@ -552,6 +632,12 @@ "UpdateDataSourceRequest$Id": "

The unique identifier of the data source to update.

" } }, + "DataSourceIdList": { + "base": null, + "refs": { + "ContentSourceConfiguration$DataSourceIds": "

The identifier of the data sources you want to use for your Amazon Kendra experience.

" + } + }, "DataSourceInclusionsExclusionsStrings": { "base": null, "refs": { @@ -723,6 +809,16 @@ "refs": { } }, + "DeleteExperienceRequest": { + "base": null, + "refs": { + } + }, + "DeleteExperienceResponse": { + "base": null, + "refs": { + } + }, "DeleteFaqRequest": { "base": null, "refs": { @@ -758,6 +854,16 @@ "refs": { } }, + "DescribeExperienceRequest": { + "base": null, + "refs": { + } + }, + "DescribeExperienceResponse": { + "base": null, + "refs": { + } + }, "DescribeFaqRequest": { "base": null, "refs": { @@ -822,21 +928,50 @@ "base": null, "refs": { "CreateDataSourceRequest$Description": "

A description for the data source.

", + "CreateExperienceRequest$Description": "

A description for your Amazon Kendra experience.

", "CreateFaqRequest$Description": "

A description of the FAQ.

", "CreateIndexRequest$Description": "

A description for the index.

", "CreateQuerySuggestionsBlockListRequest$Description": "

A user-friendly description for the block list.

For example, the description \"List of all offensive words that can appear in user queries and need to be blocked from suggestions.\"

", "CreateThesaurusRequest$Description": "

The description for the new thesaurus.

", "DescribeDataSourceResponse$Description": "

The description of the data source.

", + "DescribeExperienceResponse$Description": "

Shows the description for your Amazon Kendra experience.

", "DescribeFaqResponse$Description": "

The description of the FAQ that you provided when it was created.

", "DescribeIndexResponse$Description": "

The description of the index.

", "DescribeQuerySuggestionsBlockListResponse$Description": "

Shows the description for the block list.

", "DescribeThesaurusResponse$Description": "

The thesaurus description.

", "UpdateDataSourceRequest$Description": "

The new description for the data source.

", + "UpdateExperienceRequest$Description": "

The description of your Amazon Kendra experience you want to update.

", "UpdateIndexRequest$Description": "

A new description for the index.

", "UpdateQuerySuggestionsBlockListRequest$Description": "

The description for a block list.

", "UpdateThesaurusRequest$Description": "

The updated description of the thesaurus.

" } }, + "DisassociateEntitiesFromExperienceRequest": { + "base": null, + "refs": { + } + }, + "DisassociateEntitiesFromExperienceResponse": { + "base": null, + "refs": { + } + }, + "DisassociateEntityList": { + "base": null, + "refs": { + "DisassociateEntitiesFromExperienceRequest$EntityList": "

Lists users or groups in your Amazon Web Services SSO identity source.

" + } + }, + "DisassociatePersonasFromEntitiesRequest": { + "base": null, + "refs": { + } + }, + "DisassociatePersonasFromEntitiesResponse": { + "base": null, + "refs": { + } + }, "Document": { "base": "

A document in an index.

", "refs": { @@ -856,11 +991,20 @@ "DocumentAttributeList$member": null } }, + "DocumentAttributeCondition": { + "base": "

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

", + "refs": { + "HookConfiguration$InvocationCondition": "

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

", + "InlineCustomDocumentEnrichmentConfiguration$Condition": "

Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

" + } + }, "DocumentAttributeKey": { "base": null, "refs": { "DocumentAttribute$Key": "

The identifier for the attribute.

", + "DocumentAttributeCondition$ConditionDocumentAttributeKey": "

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

", "DocumentAttributeKeyList$member": null, + "DocumentAttributeTarget$TargetDocumentAttributeKey": "

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

", "Facet$DocumentAttributeKey": "

The unique key for the document attribute.

", "FacetResult$DocumentAttributeKey": "

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

", "SortingConfiguration$DocumentAttributeKey": "

The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

You can also sort by any of the following built-in attributes:

" @@ -892,10 +1036,18 @@ "DocumentAttributeValue$StringValue": "

A string, such as \"department\".

" } }, + "DocumentAttributeTarget": { + "base": "

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition.

", + "refs": { + "InlineCustomDocumentEnrichmentConfiguration$Target": "

Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

" + } + }, "DocumentAttributeValue": { "base": "

The value of a custom document attribute. You can only provide one value for a custom attribute.

", "refs": { "DocumentAttribute$Value": "

The value of the attribute.

", + "DocumentAttributeCondition$ConditionOnValue": "

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

", + "DocumentAttributeTarget$TargetDocumentAttributeValue": "

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

", "DocumentAttributeValueCountPair$DocumentAttributeValue": "

The value of the attribute. For example, \"HR.\"

" } }, @@ -1017,6 +1169,67 @@ "Relevance$Duration": "

Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use \"2628000s\". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character \"s\", for example \"86400s\" for one day, or \"604800s\" for one week.

Only applies to DATE fields.

" } }, + "Endpoint": { + "base": null, + "refs": { + "ExperienceEndpoint$Endpoint": "

The endpoint of your Amazon Kendra experience.

" + } + }, + "EndpointType": { + "base": null, + "refs": { + "ExperienceEndpoint$EndpointType": "

The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

" + } + }, + "EntityConfiguration": { + "base": "

Provides the configuration information of users or groups in your Amazon Web Services SSO identity source to grant access your Amazon Kendra experience.

", + "refs": { + "AssociateEntityList$member": null, + "DisassociateEntityList$member": null + } + }, + "EntityDisplayData": { + "base": "

Information about the user entity.

", + "refs": { + "ExperienceEntitiesSummary$DisplayData": "

Information about the user entity.

" + } + }, + "EntityId": { + "base": null, + "refs": { + "EntityConfiguration$EntityId": "

The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

", + "EntityIdsList$member": null, + "EntityPersonaConfiguration$EntityId": "

The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

", + "ExperienceEntitiesSummary$EntityId": "

The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

", + "FailedEntity$EntityId": "

The identifier of the user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

", + "PersonasSummary$EntityId": "

The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

" + } + }, + "EntityIdsList": { + "base": null, + "refs": { + "DisassociatePersonasFromEntitiesRequest$EntityIds": "

The identifiers of users or groups in your Amazon Web Services SSO identity source. For example, user IDs could be user emails.

" + } + }, + "EntityPersonaConfiguration": { + "base": "

Provides the configuration information of users or groups in your Amazon Web Services SSO identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

", + "refs": { + "EntityPersonaConfigurationList$member": null + } + }, + "EntityPersonaConfigurationList": { + "base": null, + "refs": { + "AssociatePersonasToEntitiesRequest$Personas": "

The personas that define the specific permissions of users or groups in your Amazon Web Services SSO identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

" + } + }, + "EntityType": { + "base": null, + "refs": { + "EntityConfiguration$EntityType": "

Specifies whether you are configuring a User or a Group.

", + "ExperienceEntitiesSummary$EntityType": "

Shows the type as User or Group.

" + } + }, "ErrorCode": { "base": null, "refs": { @@ -1036,11 +1249,14 @@ "ConflictException$Message": null, "DataSourceSyncJob$ErrorMessage": "

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

", "DescribeDataSourceResponse$ErrorMessage": "

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

", + "DescribeExperienceResponse$ErrorMessage": "

The reason your Amazon Kendra experience could not properly process.

", "DescribeFaqResponse$ErrorMessage": "

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

", "DescribeIndexResponse$ErrorMessage": "

When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.

", "DescribeQuerySuggestionsBlockListResponse$ErrorMessage": "

Shows the error message with details when there are issues in processing the block list.

", "DescribeThesaurusResponse$ErrorMessage": "

When the Status field value is FAILED, the ErrorMessage field provides more information.

", + "FailedEntity$ErrorMessage": "

The reason the user or group in your Amazon Web Services SSO identity source failed to properly configure with your Amazon Kendra experience.

", "InternalServerException$Message": null, + "InvalidRequestException$Message": null, "ResourceAlreadyExistException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": null, @@ -1068,6 +1284,84 @@ "GoogleDriveConfiguration$ExcludeUserAccounts": "

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

" } }, + "ExperienceConfiguration": { + "base": "

Specifies the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.

", + "refs": { + "CreateExperienceRequest$Configuration": "

Provides the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

", + "DescribeExperienceResponse$Configuration": "

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

", + "UpdateExperienceRequest$Configuration": "

Provides the user configuration information. This includes the Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.

" + } + }, + "ExperienceEndpoint": { + "base": "

Provides the configuration information of the endpoint for your Amazon Kendra experience.

", + "refs": { + "ExperienceEndpoints$member": null + } + }, + "ExperienceEndpoints": { + "base": null, + "refs": { + "DescribeExperienceResponse$Endpoints": "

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

", + "ExperiencesSummary$Endpoints": "

The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

" + } + }, + "ExperienceEntitiesSummary": { + "base": "

Summary information for users or groups in your Amazon Web Services SSO identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "refs": { + "ExperienceEntitiesSummaryList$member": null + } + }, + "ExperienceEntitiesSummaryList": { + "base": null, + "refs": { + "ListExperienceEntitiesResponse$SummaryItems": "

An array of summary information for one or more users or groups.

" + } + }, + "ExperienceId": { + "base": null, + "refs": { + "AssociateEntitiesToExperienceRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "AssociatePersonasToEntitiesRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "CreateExperienceResponse$Id": "

The identifier for your created Amazon Kendra experience.

", + "DeleteExperienceRequest$Id": "

The identifier of your Amazon Kendra experience you want to delete.

", + "DescribeExperienceRequest$Id": "

The identifier of your Amazon Kendra experience you want to get information on.

", + "DescribeExperienceResponse$Id": "

Shows the identifier of your Amazon Kendra experience.

", + "DisassociateEntitiesFromExperienceRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "DisassociatePersonasFromEntitiesRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "ExperiencesSummary$Id": "

The identifier of your Amazon Kendra experience.

", + "ListEntityPersonasRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "ListExperienceEntitiesRequest$Id": "

The identifier of your Amazon Kendra experience.

", + "UpdateExperienceRequest$Id": "

The identifier of your Amazon Kendra experience you want to update.

" + } + }, + "ExperienceName": { + "base": null, + "refs": { + "CreateExperienceRequest$Name": "

A name for your Amazon Kendra experience.

", + "DescribeExperienceResponse$Name": "

Shows the name of your Amazon Kendra experience.

", + "ExperiencesSummary$Name": "

The name of your Amazon Kendra experience.

", + "UpdateExperienceRequest$Name": "

The name of your Amazon Kendra experience you want to update.

" + } + }, + "ExperienceStatus": { + "base": null, + "refs": { + "DescribeExperienceResponse$Status": "

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

", + "ExperiencesSummary$Status": "

The processing status of your Amazon Kendra experience.

" + } + }, + "ExperiencesSummary": { + "base": "

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "refs": { + "ExperiencesSummaryList$member": null + } + }, + "ExperiencesSummaryList": { + "base": null, + "refs": { + "ListExperiencesResponse$SummaryItems": "

An array of summary information for one or more Amazon Kendra experiences.

" + } + }, "Facet": { "base": "

Information about a document attribute

", "refs": { @@ -1092,6 +1386,21 @@ "QueryResult$FacetResults": "

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

" } }, + "FailedEntity": { + "base": "

Information on the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.

", + "refs": { + "AssociateEntitiesToExperienceFailedEntityList$member": null, + "FailedEntityList$member": null + } + }, + "FailedEntityList": { + "base": null, + "refs": { + "AssociatePersonasToEntitiesResponse$FailedEntityList": "

Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly configure with your Amazon Kendra experience.

", + "DisassociateEntitiesFromExperienceResponse$FailedEntityList": "

Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly remove access to your Amazon Kendra experience.

", + "DisassociatePersonasFromEntitiesResponse$FailedEntityList": "

Lists the users or groups in your Amazon Web Services SSO identity source that failed to properly remove access to your Amazon Kendra experience.

" + } + }, "FailureReason": { "base": null, "refs": { @@ -1113,9 +1422,16 @@ "DeleteFaqRequest$Id": "

The identifier of the FAQ to remove.

", "DescribeFaqRequest$Id": "

The unique identifier of the FAQ.

", "DescribeFaqResponse$Id": "

The identifier of the FAQ.

", + "FaqIdsList$member": null, "FaqSummary$Id": "

The unique identifier of the FAQ.

" } }, + "FaqIdsList": { + "base": null, + "refs": { + "ContentSourceConfiguration$FaqIds": "

The identifier of the FAQs that you want to use for your Amazon Kendra experience.

" + } + }, "FaqName": { "base": null, "refs": { @@ -1165,6 +1481,16 @@ "refs": { } }, + "GetSnapshotsRequest": { + "base": null, + "refs": { + } + }, + "GetSnapshotsResponse": { + "base": null, + "refs": { + } + }, "GoogleDriveConfiguration": { "base": "

Provides configuration information for data sources that connect to Google Drive.

", "refs": { @@ -1248,6 +1574,13 @@ "Highlight$Type": "

The highlight type.

" } }, + "HookConfiguration": { + "base": "

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process.

", + "refs": { + "CustomDocumentEnrichmentConfiguration$PreExtractionHookConfiguration": "

Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

", + "CustomDocumentEnrichmentConfiguration$PostExtractionHookConfiguration": "

Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

" + } + }, "Host": { "base": null, "refs": { @@ -1255,6 +1588,12 @@ "ProxyConfiguration$Host": "

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is \"a.example.com\".

" } }, + "IdentityAttributeName": { + "base": null, + "refs": { + "UserIdentityConfiguration$IdentityAttributeName": "

The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an Amazon Web Services SSO identity source.

" + } + }, "Importance": { "base": null, "refs": { @@ -1295,16 +1634,20 @@ "IndexId": { "base": null, "refs": { + "AssociateEntitiesToExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", + "AssociatePersonasToEntitiesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "BatchDeleteDocumentRequest$IndexId": "

The identifier of the index that contains the documents to delete.

", "BatchGetDocumentStatusRequest$IndexId": "

The identifier of the index to add documents to. The index ID is returned by the CreateIndex operation.

", "BatchPutDocumentRequest$IndexId": "

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

", "ClearQuerySuggestionsRequest$IndexId": "

The identifier of the index you want to clear query suggestions from.

", "CreateDataSourceRequest$IndexId": "

The identifier of the index that should be associated with this data source.

", + "CreateExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "CreateFaqRequest$IndexId": "

The identifier of the index that contains the FAQ.

", "CreateIndexResponse$Id": "

The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

", "CreateQuerySuggestionsBlockListRequest$IndexId": "

The identifier of the index you want to create a query suggestions block list for.

", "CreateThesaurusRequest$IndexId": "

The unique identifier of the index for the new thesaurus.

", "DeleteDataSourceRequest$IndexId": "

The unique identifier of the index associated with the data source.

", + "DeleteExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience you want to delete.

", "DeleteFaqRequest$IndexId": "

The index to remove the FAQ from.

", "DeleteIndexRequest$Id": "

The identifier of the index to delete.

", "DeletePrincipalMappingRequest$IndexId": "

The identifier of the index you want to delete a group from.

", @@ -1312,6 +1655,8 @@ "DeleteThesaurusRequest$IndexId": "

The identifier of the index associated with the thesaurus to delete.

", "DescribeDataSourceRequest$IndexId": "

The identifier of the index that contains the data source.

", "DescribeDataSourceResponse$IndexId": "

The identifier of the index that contains the data source.

", + "DescribeExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience you want to get information on.

", + "DescribeExperienceResponse$IndexId": "

Shows the identifier of the index for your Amazon Kendra experience.

", "DescribeFaqRequest$IndexId": "

The identifier of the index that contains the FAQ.

", "DescribeFaqResponse$IndexId": "

The identifier of the index that contains the FAQ.

", "DescribeIndexRequest$Id": "

The name of the index to describe.

", @@ -1323,10 +1668,16 @@ "DescribeQuerySuggestionsConfigRequest$IndexId": "

The identifier of the index you want to describe query suggestions settings for.

", "DescribeThesaurusRequest$IndexId": "

The identifier of the index associated with the thesaurus to describe.

", "DescribeThesaurusResponse$IndexId": "

The identifier of the index associated with the thesaurus to describe.

", + "DisassociateEntitiesFromExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", + "DisassociatePersonasFromEntitiesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "GetQuerySuggestionsRequest$IndexId": "

The identifier of the index you want to get query suggestions from.

", + "GetSnapshotsRequest$IndexId": "

The identifier of the index to get search metrics data.

", "IndexConfigurationSummary$Id": "

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

", "ListDataSourceSyncJobsRequest$IndexId": "

The identifier of the index that contains the data source.

", "ListDataSourcesRequest$IndexId": "

The identifier of the index that contains the data source.

", + "ListEntityPersonasRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", + "ListExperienceEntitiesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", + "ListExperiencesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "ListFaqsRequest$IndexId": "

The index that contains the FAQ lists.

", "ListGroupsOlderThanOrderingIdRequest$IndexId": "

The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.

", "ListQuerySuggestionsBlockListsRequest$IndexId": "

The identifier of the index for a list of all block lists that exist for that index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

", @@ -1337,6 +1688,7 @@ "StopDataSourceSyncJobRequest$IndexId": "

The identifier of the index that contains the data source.

", "SubmitFeedbackRequest$IndexId": "

The identifier of the index that was queried.

", "UpdateDataSourceRequest$IndexId": "

The identifier of the index that contains the data source to update.

", + "UpdateExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience you want to update.

", "UpdateIndexRequest$Id": "

The identifier of the index to update.

", "UpdateQuerySuggestionsBlockListRequest$IndexId": "

The identifier of the index for a block list.

", "UpdateQuerySuggestionsConfigRequest$IndexId": "

The identifier of the index you want to update query suggestions settings for.

", @@ -1383,6 +1735,18 @@ "TextDocumentStatistics$IndexedTextDocumentsCount": "

The number of text documents indexed.

" } }, + "InlineCustomDocumentEnrichmentConfiguration": { + "base": "

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration.

For more information, see Customizing document metadata during the ingestion process.

", + "refs": { + "InlineCustomDocumentEnrichmentConfigurationList$member": null + } + }, + "InlineCustomDocumentEnrichmentConfigurationList": { + "base": null, + "refs": { + "CustomDocumentEnrichmentConfiguration$InlineConfigurations": "

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

" + } + }, "Integer": { "base": null, "refs": { @@ -1391,6 +1755,7 @@ "DescribeQuerySuggestionsConfigResponse$TotalSuggestionsCount": "

Shows the current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

", "DocumentAttributeValueCountPair$Count": "

The number of documents in the response that have the attribute value for the key.

", "GetQuerySuggestionsRequest$MaxSuggestionsCount": "

The maximum number of query suggestions you want to show to your users.

", + "GetSnapshotsRequest$MaxResults": "

The maximum number of returned data for the metric.

", "Highlight$BeginOffset": "

The zero-based location in the response string where the highlight starts.

", "Highlight$EndOffset": "

The zero-based location in the response string where the highlight ends.

", "QueryRequest$PageNumber": "

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

", @@ -1407,6 +1772,17 @@ "refs": { } }, + "Interval": { + "base": null, + "refs": { + "GetSnapshotsRequest$Interval": "

The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:

" + } + }, + "InvalidRequestException": { + "base": "

The input to the request is not valid.

", + "refs": { + } + }, "Issuer": { "base": null, "refs": { @@ -1437,6 +1813,12 @@ "ServerSideEncryptionConfiguration$KmsKeyId": "

The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

" } }, + "LambdaArn": { + "base": null, + "refs": { + "HookConfiguration$LambdaArn": "

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.

" + } + }, "LanguageCode": { "base": "

The code for a language. The default language is English. For more information on supported languages, including their codes, see Adding documents in languages other than English.

", "refs": { @@ -1469,6 +1851,36 @@ "refs": { } }, + "ListEntityPersonasRequest": { + "base": null, + "refs": { + } + }, + "ListEntityPersonasResponse": { + "base": null, + "refs": { + } + }, + "ListExperienceEntitiesRequest": { + "base": null, + "refs": { + } + }, + "ListExperienceEntitiesResponse": { + "base": null, + "refs": { + } + }, + "ListExperiencesRequest": { + "base": null, + "refs": { + } + }, + "ListExperiencesResponse": { + "base": null, + "refs": { + } + }, "ListFaqsRequest": { "base": null, "refs": { @@ -1569,6 +1981,18 @@ "ListDataSourcesRequest$MaxResults": "

The maximum number of data sources to return.

" } }, + "MaxResultsIntegerForListEntityPersonasRequest": { + "base": null, + "refs": { + "ListEntityPersonasRequest$MaxResults": "

The maximum number of returned users or groups.

" + } + }, + "MaxResultsIntegerForListExperiencesRequest": { + "base": null, + "refs": { + "ListExperiencesRequest$MaxResults": "

The maximum number of returned Amazon Kendra experiences.

" + } + }, "MaxResultsIntegerForListFaqsRequest": { "base": null, "refs": { @@ -1629,6 +2053,12 @@ "GroupMembers$MemberUsers": "

A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.

" } }, + "MetricType": { + "base": null, + "refs": { + "GetSnapshotsRequest$MetricType": "

The metric you want to retrieve. You can specify only one metric per call.

For more information about the metrics you can view, see Gaining insights with search analytics.

" + } + }, "MetricValue": { "base": null, "refs": { @@ -1666,13 +2096,31 @@ "UpdateQuerySuggestionsConfigRequest$Mode": "

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

" } }, + "NameType": { + "base": null, + "refs": { + "EntityDisplayData$UserName": "

The name of the user.

", + "EntityDisplayData$GroupName": "

The name of the group.

", + "EntityDisplayData$IdentifiedUserName": "

The user name of the user.

", + "EntityDisplayData$FirstName": "

The first name of the user.

", + "EntityDisplayData$LastName": "

The last name of the user.

" + } + }, "NextToken": { "base": null, "refs": { + "GetSnapshotsRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

", + "GetSnapshotsResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

", "ListDataSourceSyncJobsRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

", "ListDataSourceSyncJobsResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of jobs.

", "ListDataSourcesRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data sources (DataSourceSummaryItems).

", "ListDataSourcesResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.

", + "ListEntityPersonasRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.

", + "ListEntityPersonasResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

", + "ListExperienceEntitiesRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.

", + "ListExperienceEntitiesResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

", + "ListExperiencesRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra experiences.

", + "ListExperiencesResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.

", "ListFaqsRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.

", "ListFaqsResponse$NextToken": "

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

", "ListGroupsOlderThanOrderingIdRequest$NextToken": "

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.

", @@ -1725,7 +2173,26 @@ "OrganizationId": { "base": null, "refs": { - "WorkDocsConfiguration$OrganizationId": "

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

" + "WorkDocsConfiguration$OrganizationId": "

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

" + } + }, + "Persona": { + "base": null, + "refs": { + "EntityPersonaConfiguration$Persona": "

The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

", + "PersonasSummary$Persona": "

The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

" + } + }, + "PersonasSummary": { + "base": "

Summary information for users or groups in your Amazon Web Services SSO identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", + "refs": { + "PersonasSummaryList$member": null + } + }, + "PersonasSummaryList": { + "base": null, + "refs": { + "ListEntityPersonasResponse$SummaryItems": "

An array of summary information for one or more users or groups.

" } }, "Port": { @@ -1782,7 +2249,7 @@ "ProxyConfiguration": { "base": "

Provides the configuration information for a web proxy to connect to website hosts.

", "refs": { - "WebCrawlerConfiguration$ProxyConfiguration": "

Provides configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.

" + "WebCrawlerConfiguration$ProxyConfiguration": "

Provides configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

" } }, "PutPrincipalMappingRequest": { @@ -1960,18 +2427,22 @@ "refs": { "BatchPutDocumentRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

", "CreateDataSourceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

", + "CreateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", "CreateFaqRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

", "CreateIndexRequest$RoleArn": "

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

", "CreateQuerySuggestionsBlockListRequest$RoleArn": "

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

", - "CreateThesaurusRequest$RoleArn": "

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

", + "CreateThesaurusRequest$RoleArn": "

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

", + "CustomDocumentEnrichmentConfiguration$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

", "DescribeDataSourceResponse$RoleArn": "

The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

", + "DescribeExperienceResponse$RoleArn": "

Shows the Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information.

", "DescribeFaqResponse$RoleArn": "

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

", "DescribeIndexResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

", "DescribeQuerySuggestionsBlockListResponse$RoleArn": "

Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

", - "DescribeThesaurusResponse$RoleArn": "

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

", + "DescribeThesaurusResponse$RoleArn": "

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

", "JwtTokenTypeConfiguration$SecretManagerArn": "

The Amazon Resource Name (arn) of the secret.

", "PutPrincipalMappingRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see IAM roles for Amazon Kendra.

", "UpdateDataSourceRequest$RoleArn": "

The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.

", + "UpdateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", "UpdateIndexRequest$RoleArn": "

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

", "UpdateQuerySuggestionsBlockListRequest$RoleArn": "

The IAM (Identity and Access Management) role used to access the block list text file in S3.

", "UpdateThesaurusRequest$RoleArn": "

The updated role ARN of the thesaurus.

" @@ -1980,6 +2451,7 @@ "S3BucketName": { "base": null, "refs": { + "HookConfiguration$S3Bucket": "

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

", "S3DataSourceConfiguration$BucketName": "

The name of the bucket that contains the documents.

", "S3Path$Bucket": "

The name of the S3 bucket that contains the file.

" } @@ -2134,15 +2606,15 @@ "SecretArn": { "base": null, "refs": { - "BasicAuthenticationConfiguration$Credentials": "

Your secret ARN, which you can create in AWS Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

", - "ConfluenceConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

", + "BasicAuthenticationConfiguration$Credentials": "

Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

", + "ConfluenceConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

", "ConnectionConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

", "GoogleDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

", "OneDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

", - "ProxyConfiguration$Credentials": "

Your secret ARN, which you can create in AWS Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

", + "ProxyConfiguration$Credentials": "

Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

", "SalesforceConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

", "ServiceNowConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

", - "SharePointConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

" + "SharePointConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.

" } }, "SecurityGroupIdList": { @@ -2158,7 +2630,7 @@ } }, "SeedUrlConfiguration": { - "base": "

Provides the configuration information of the seed or starting point URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

", + "base": "

Provides the configuration information of the seed or starting point URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

", "refs": { "Urls$SeedUrlConfiguration": "

Provides the configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

You can list up to 100 seed URLs.

" } @@ -2179,7 +2651,7 @@ "ServiceNowAuthenticationType": { "base": null, "refs": { - "ServiceNowConfiguration$AuthenticationType": "

Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

" + "ServiceNowConfiguration$AuthenticationType": "

Determines the type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

" } }, "ServiceNowBuildVersionType": { @@ -2254,7 +2726,7 @@ } }, "SiteMapsConfiguration": { - "base": "

Provides the configuration information of the sitemap URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

", + "base": "

Provides the configuration information of the sitemap URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

", "refs": { "Urls$SiteMapsConfiguration": "

Provides the configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

" } @@ -2265,6 +2737,24 @@ "SiteMapsConfiguration$SiteMaps": "

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

" } }, + "SnapshotsDataHeaderFields": { + "base": null, + "refs": { + "GetSnapshotsResponse$SnapshotsDataHeader": "

The column headers for the search metrics data.

" + } + }, + "SnapshotsDataRecord": { + "base": null, + "refs": { + "SnapshotsDataRecords$member": null + } + }, + "SnapshotsDataRecords": { + "base": null, + "refs": { + "GetSnapshotsResponse$SnapshotsData": "

The search metrics data. The data returned depends on the metric type you requested.

" + } + }, "SortOrder": { "base": null, "refs": { @@ -2319,6 +2809,8 @@ "DocumentAttributeStringListValue$member": null, "JsonTokenTypeConfiguration$UserNameAttributeField": "

The user name attribute field.

", "JsonTokenTypeConfiguration$GroupAttributeField": "

The group attribute field.

", + "SnapshotsDataHeaderFields$member": null, + "SnapshotsDataRecord$member": null, "StartDataSourceSyncJobResponse$ExecutionId": "

Identifies a particular synchronization job.

", "Status$FailureCode": "

Indicates the source of the error.

", "Status$FailureReason": "

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

", @@ -2505,6 +2997,7 @@ "TimeRange": { "base": "

Provides a range of time.

", "refs": { + "GetSnapshotsResponse$SnapShotTimeFilter": "

The date-time for the beginning and end of the time window for the search metrics data.

", "ListDataSourceSyncJobsRequest$StartTimeFilter": "

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

" } }, @@ -2518,6 +3011,8 @@ "DataSourceSyncJob$EndTime": "

The UNIX datetime that the synchronization job was completed.

", "DescribeDataSourceResponse$CreatedAt": "

The Unix timestamp of when the data source was created.

", "DescribeDataSourceResponse$UpdatedAt": "

The Unix timestamp of when the data source was last updated.

", + "DescribeExperienceResponse$CreatedAt": "

Shows the date-time your Amazon Kendra experience was created.

", + "DescribeExperienceResponse$UpdatedAt": "

Shows the date-time your Amazon Kendra experience was last updated.

", "DescribeFaqResponse$CreatedAt": "

The date and time that the FAQ was created.

", "DescribeFaqResponse$UpdatedAt": "

The date and time that the FAQ was last updated.

", "DescribeIndexResponse$CreatedAt": "

The Unix datetime that the index was created.

", @@ -2529,12 +3024,15 @@ "DescribeThesaurusResponse$CreatedAt": "

The Unix datetime that the thesaurus was created.

", "DescribeThesaurusResponse$UpdatedAt": "

The Unix datetime that the thesaurus was last updated.

", "DocumentAttributeValue$DateValue": "

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

", + "ExperiencesSummary$CreatedAt": "

The date-time your Amazon Kendra experience was created.

", "FaqSummary$CreatedAt": "

The UNIX datetime that the FAQ was added to the index.

", "FaqSummary$UpdatedAt": "

The UNIX datetime that the FAQ was last updated.

", "GroupOrderingIdSummary$LastUpdatedAt": "

The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

", "GroupOrderingIdSummary$ReceivedAt": "

The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

", "IndexConfigurationSummary$CreatedAt": "

The Unix timestamp when the index was created.

", "IndexConfigurationSummary$UpdatedAt": "

The Unix timestamp when the index was last updated by the UpdateIndex operation.

", + "PersonasSummary$CreatedAt": "

The date-time the summary information was created.

", + "PersonasSummary$UpdatedAt": "

The date-time the summary information was last updated.

", "QuerySuggestionsBlockListSummary$CreatedAt": "

The date-time summary information for a query suggestions block list was last created.

", "QuerySuggestionsBlockListSummary$UpdatedAt": "

The date-time the block list was last updated.

", "ThesaurusSummary$CreatedAt": "

The Unix datetime that the thesaurus was created.

", @@ -2570,6 +3068,11 @@ "refs": { } }, + "UpdateExperienceRequest": { + "base": null, + "refs": { + } + }, "UpdateIndexRequest": { "base": null, "refs": { @@ -2601,9 +3104,9 @@ } }, "Urls": { - "base": "

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

", + "base": "

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

", "refs": { - "WebCrawlerConfiguration$Urls": "

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

" + "WebCrawlerConfiguration$Urls": "

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

" } }, "UserAccount": { @@ -2627,17 +3130,17 @@ } }, "UserGroupResolutionConfiguration": { - "base": "

Provides the configuration information to fetch access levels of groups and users from an AWS Single Sign-On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.

To set up an AWS SSO identity source in the console to use with Amazon Kendra, see Getting started with an AWS SSO identity source. You must also grant the required permissions to use AWS SSO with Amazon Kendra. For more information, see IAM roles for AWS Single Sign-On.

", + "base": "

Provides the configuration information to fetch access levels of groups and users from an Amazon Web Services Single Sign On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.

To set up an Amazon Web Services SSO identity source in the console to use with Amazon Kendra, see Getting started with an Amazon Web Services SSO identity source. You must also grant the required permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see IAM roles for Amazon Web Services SSO.

", "refs": { - "CreateIndexRequest$UserGroupResolutionConfiguration": "

Enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration.

", - "DescribeIndexResponse$UserGroupResolutionConfiguration": "

Shows whether you have enabled the configuration for fetching access levels of groups and users from an AWS Single Sign-On identity source.

", - "UpdateIndexRequest$UserGroupResolutionConfiguration": "

Enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration.

" + "CreateIndexRequest$UserGroupResolutionConfiguration": "

Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.

", + "DescribeIndexResponse$UserGroupResolutionConfiguration": "

Shows whether you have enabled the configuration for fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source.

", + "UpdateIndexRequest$UserGroupResolutionConfiguration": "

Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.

" } }, "UserGroupResolutionMode": { "base": null, "refs": { - "UserGroupResolutionConfiguration$UserGroupResolutionMode": "

The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode.

" + "UserGroupResolutionConfiguration$UserGroupResolutionMode": "

The identity store provider (mode) you want to use to fetch access levels of groups and users. Amazon Web Services Single Sign On is currently the only available mode. Your users and groups must exist in an Amazon Web Services SSO identity source in order to use this mode.

" } }, "UserId": { @@ -2646,6 +3149,12 @@ "MemberUser$UserId": "

The identifier of the user you want to map to a group.

" } }, + "UserIdentityConfiguration": { + "base": "

Configuration information for the identifiers of your users.

", + "refs": { + "ExperienceConfiguration$UserIdentityConfiguration": "

The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.

" + } + }, "UserNameAttributeField": { "base": null, "refs": { @@ -2696,7 +3205,7 @@ } }, "WebCrawlerConfiguration": { - "base": "

Provides the configuration information required for Amazon Kendra web crawler.

", + "base": "

Provides the configuration information required for Amazon Kendra Web Crawler.

", "refs": { "DataSourceConfiguration$WebCrawlerConfiguration": null } diff --git a/models/apis/kendra/2019-02-03/paginators-1.json b/models/apis/kendra/2019-02-03/paginators-1.json index 2170bfc57ce..cdd20f2b041 100644 --- a/models/apis/kendra/2019-02-03/paginators-1.json +++ b/models/apis/kendra/2019-02-03/paginators-1.json @@ -10,6 +10,20 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListEntityPersonas": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListExperienceEntities": { + "input_token": "NextToken", + "output_token": "NextToken" + }, + "ListExperiences": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListIndices": { "input_token": "NextToken", "output_token": "NextToken", 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 6dd8ad82ec4..8f0b02196cf 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 @@ -484,6 +484,22 @@ {"shape":"InternalServerException"} ] }, + "DescribeBotRecommendation":{ + "name":"DescribeBotRecommendation", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeBotRecommendationRequest"}, + "output":{"shape":"DescribeBotRecommendationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeBotVersion":{ "name":"DescribeBotVersion", "http":{ @@ -647,6 +663,22 @@ {"shape":"InternalServerException"} ] }, + "ListBotRecommendations":{ + "name":"ListBotRecommendations", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/", + "responseCode":200 + }, + "input":{"shape":"ListBotRecommendationsRequest"}, + "output":{"shape":"ListBotRecommendationsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListBotVersions":{ "name":"ListBotVersions", "http":{ @@ -757,6 +789,23 @@ {"shape":"InternalServerException"} ] }, + "ListRecommendedIntents":{ + "name":"ListRecommendedIntents", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents", + "responseCode":200 + }, + "input":{"shape":"ListRecommendedIntentsRequest"}, + "output":{"shape":"ListRecommendedIntentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListSlotTypes":{ "name":"ListSlotTypes", "http":{ @@ -805,6 +854,43 @@ {"shape":"ValidationException"} ] }, + "SearchAssociatedTranscripts":{ + "name":"SearchAssociatedTranscripts", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts", + "responseCode":200 + }, + "input":{"shape":"SearchAssociatedTranscriptsRequest"}, + "output":{"shape":"SearchAssociatedTranscriptsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StartBotRecommendation":{ + "name":"StartBotRecommendation", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/", + "responseCode":202 + }, + "input":{"shape":"StartBotRecommendationRequest"}, + "output":{"shape":"StartBotRecommendationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "StartImport":{ "name":"StartImport", "http":{ @@ -909,6 +995,26 @@ {"shape":"InternalServerException"} ] }, + "UpdateBotRecommendation":{ + "name":"UpdateBotRecommendation", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateBotRecommendationRequest"}, + "output":{"shape":"UpdateBotRecommendationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateExport":{ "name":"UpdateExport", "http":{ @@ -1069,6 +1175,40 @@ "max":1011, "min":1 }, + "AssociatedTranscript":{ + "type":"structure", + "members":{ + "transcript":{"shape":"Transcript"} + } + }, + "AssociatedTranscriptFilter":{ + "type":"structure", + "required":[ + "name", + "values" + ], + "members":{ + "name":{"shape":"AssociatedTranscriptFilterName"}, + "values":{"shape":"FilterValues"} + } + }, + "AssociatedTranscriptFilterName":{ + "type":"string", + "enum":[ + "IntentId", + "SlotTypeId" + ] + }, + "AssociatedTranscriptFilters":{ + "type":"list", + "member":{"shape":"AssociatedTranscriptFilter"}, + "max":1, + "min":1 + }, + "AssociatedTranscriptList":{ + "type":"list", + "member":{"shape":"AssociatedTranscript"} + }, "AttachmentTitle":{ "type":"string", "max":250, @@ -1317,7 +1457,8 @@ "Failed", "Deleting", "NotBuilt", - "Importing" + "Importing", + "Processing" ] }, "BotLocaleSummary":{ @@ -1335,6 +1476,50 @@ "type":"list", "member":{"shape":"BotLocaleSummary"} }, + "BotRecommendationResultStatistics":{ + "type":"structure", + "members":{ + "intents":{"shape":"IntentStatistics"}, + "slotTypes":{"shape":"SlotTypeStatistics"} + } + }, + "BotRecommendationResults":{ + "type":"structure", + "members":{ + "botLocaleExportUrl":{"shape":"PresignedS3Url"}, + "associatedTranscriptsUrl":{"shape":"PresignedS3Url"}, + "statistics":{"shape":"BotRecommendationResultStatistics"} + } + }, + "BotRecommendationStatus":{ + "type":"string", + "enum":[ + "Processing", + "Deleting", + "Deleted", + "Downloading", + "Updating", + "Available", + "Failed" + ] + }, + "BotRecommendationSummary":{ + "type":"structure", + "required":[ + "botRecommendationStatus", + "botRecommendationId" + ], + "members":{ + "botRecommendationStatus":{"shape":"BotRecommendationStatus"}, + "botRecommendationId":{"shape":"Id"}, + "creationDateTime":{"shape":"Timestamp"}, + "lastUpdatedDateTime":{"shape":"Timestamp"} + } + }, + "BotRecommendationSummaryList":{ + "type":"list", + "member":{"shape":"BotRecommendationSummary"} + }, "BotSortAttribute":{ "type":"string", "enum":["BotName"] @@ -1643,6 +1828,7 @@ "audioLogSettings":{"shape":"AudioLogSettingsList"} } }, + "Count":{"type":"integer"}, "CreateBotAliasRequest":{ "type":"structure", "required":[ @@ -2050,6 +2236,17 @@ "childDirected":{"shape":"ChildDirected"} } }, + "DateRangeFilter":{ + "type":"structure", + "required":[ + "startDateTime", + "endDateTime" + ], + "members":{ + "startDateTime":{"shape":"Timestamp"}, + "endDateTime":{"shape":"Timestamp"} + } + }, "DeleteBotAliasRequest":{ "type":"structure", "required":[ @@ -2472,6 +2669,53 @@ "botLocaleHistoryEvents":{"shape":"BotLocaleHistoryEventsList"} } }, + "DescribeBotRecommendationRequest":{ + "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" + } + } + }, + "DescribeBotRecommendationResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationStatus":{"shape":"BotRecommendationStatus"}, + "botRecommendationId":{"shape":"Id"}, + "failureReasons":{"shape":"FailureReasons"}, + "creationDateTime":{"shape":"Timestamp"}, + "lastUpdatedDateTime":{"shape":"Timestamp"}, + "transcriptSourceSetting":{"shape":"TranscriptSourceSetting"}, + "encryptionSetting":{"shape":"EncryptionSetting"}, + "botRecommendationResults":{"shape":"BotRecommendationResults"} + } + }, "DescribeBotRequest":{ "type":"structure", "required":["botId"], @@ -2780,6 +3024,14 @@ "Deny" ] }, + "EncryptionSetting":{ + "type":"structure", + "members":{ + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "botLocaleExportPassword":{"shape":"FilePassword"}, + "associatedTranscriptsPassword":{"shape":"FilePassword"} + } + }, "ExceptionMessage":{"type":"string"}, "ExportFilter":{ "type":"structure", @@ -2862,6 +3114,12 @@ "type":"list", "member":{"shape":"FailureReason"} }, + "FilePassword":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, "FilterValue":{ "type":"string", "max":100, @@ -3124,6 +3382,12 @@ "order":{"shape":"SortOrder"} } }, + "IntentStatistics":{ + "type":"structure", + "members":{ + "discoveredIntentCount":{"shape":"Count"} + } + }, "IntentSummary":{ "type":"structure", "members":{ @@ -3187,6 +3451,12 @@ "codeHookInterfaceVersion":{"shape":"CodeHookInterfaceVersion"} } }, + "LexTranscriptFilter":{ + "type":"structure", + "members":{ + "dateRangeFilter":{"shape":"DateRangeFilter"} + } + }, "ListAggregatedUtterancesRequest":{ "type":"structure", "required":[ @@ -3278,6 +3548,43 @@ "botLocaleSummaries":{"shape":"BotLocaleSummaryList"} } }, + "ListBotRecommendationsRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListBotRecommendationsResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationSummaries":{"shape":"BotRecommendationSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListBotVersionsRequest":{ "type":"structure", "required":["botId"], @@ -3439,6 +3746,50 @@ "nextToken":{"shape":"NextToken"} } }, + "ListRecommendedIntentsRequest":{ + "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" + }, + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListRecommendedIntentsResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationId":{"shape":"Id"}, + "summaryList":{"shape":"RecommendedIntentSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListSlotTypesRequest":{ "type":"structure", "required":[ @@ -3557,7 +3908,8 @@ "type":"string", "enum":[ "Overwrite", - "FailOnConflict" + "FailOnConflict", + "Append" ] }, "Message":{ @@ -3602,6 +3954,12 @@ "min":1, "pattern":"^([0-9a-zA-Z][_-]?)+$" }, + "NextIndex":{ + "type":"integer", + "box":true, + "max":10000000, + "min":0 + }, "NextToken":{"type":"string"}, "NumericalBotVersion":{ "type":"string", @@ -3623,6 +3981,17 @@ "DefaultObfuscation" ] }, + "ObjectPrefix":{ + "type":"string", + "min":1, + "pattern":"^[\\/]?+[a-zA-Z0-9!_.*'()-]+(\\/[a-zA-Z0-9!_.*'()-]+)*$" + }, + "ObjectPrefixes":{ + "type":"list", + "member":{"shape":"ObjectPrefix"}, + "max":2, + "min":1 + }, "Operation":{ "type":"string", "max":50, @@ -3652,6 +4021,12 @@ "max":10, "min":0 }, + "PathFormat":{ + "type":"structure", + "members":{ + "objectPrefixes":{"shape":"ObjectPrefixes"} + } + }, "PlainTextMessage":{ "type":"structure", "required":["value"], @@ -3733,6 +4108,18 @@ "max":5000, "min":1 }, + "RecommendedIntentSummary":{ + "type":"structure", + "members":{ + "intentId":{"shape":"Id"}, + "intentName":{"shape":"Name"}, + "sampleUtterancesCount":{"shape":"SampleUtterancesCount"} + } + }, + "RecommendedIntentSummaryList":{ + "type":"list", + "member":{"shape":"RecommendedIntentSummary"} + }, "RegexPattern":{ "type":"string", "max":300, @@ -3797,6 +4184,26 @@ "logPrefix":{"shape":"LogPrefix"} } }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + }, + "S3BucketTranscriptSource":{ + "type":"structure", + "required":[ + "s3BucketName", + "transcriptFormat" + ], + "members":{ + "s3BucketName":{"shape":"S3BucketName"}, + "pathFormat":{"shape":"PathFormat"}, + "transcriptFormat":{"shape":"TranscriptFormat"}, + "transcriptFilter":{"shape":"TranscriptFilter"}, + "kmsKeyArn":{"shape":"KmsKeyArn"} + } + }, "SSMLMessage":{ "type":"structure", "required":["value"], @@ -3816,6 +4223,7 @@ "utterance":{"shape":"Utterance"} } }, + "SampleUtterancesCount":{"type":"integer"}, "SampleUtterancesList":{ "type":"list", "member":{"shape":"SampleUtterance"} @@ -3827,6 +4235,61 @@ "value":{"shape":"Value"} } }, + "SearchAssociatedTranscriptsRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "botRecommendationId", + "filters" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + }, + "botRecommendationId":{ + "shape":"Id", + "location":"uri", + "locationName":"botRecommendationId" + }, + "searchOrder":{"shape":"SearchOrder"}, + "filters":{"shape":"AssociatedTranscriptFilters"}, + "maxResults":{"shape":"MaxResults"}, + "nextIndex":{"shape":"NextIndex"} + } + }, + "SearchAssociatedTranscriptsResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"BotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationId":{"shape":"Id"}, + "nextIndex":{"shape":"NextIndex"}, + "associatedTranscripts":{"shape":"AssociatedTranscriptList"}, + "totalResults":{"shape":"MaxResults"} + } + }, + "SearchOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, "SentimentAnalysisSettings":{ "type":"structure", "required":["detectSentiment"], @@ -4020,6 +4483,12 @@ "order":{"shape":"SortOrder"} } }, + "SlotTypeStatistics":{ + "type":"structure", + "members":{ + "discoveredSlotTypeCount":{"shape":"Count"} + } + }, "SlotTypeSummary":{ "type":"structure", "members":{ @@ -4087,6 +4556,47 @@ "Descending" ] }, + "StartBotRecommendationRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "transcriptSourceSetting" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + }, + "transcriptSourceSetting":{"shape":"TranscriptSourceSetting"}, + "encryptionSetting":{"shape":"EncryptionSetting"} + } + }, + "StartBotRecommendationResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationStatus":{"shape":"BotRecommendationStatus"}, + "botRecommendationId":{"shape":"Id"}, + "creationDateTime":{"shape":"Timestamp"}, + "transcriptSourceSetting":{"shape":"TranscriptSourceSetting"}, + "encryptionSetting":{"shape":"EncryptionSetting"} + } + }, "StartImportRequest":{ "type":"structure", "required":[ @@ -4235,6 +4745,28 @@ "min":1 }, "Timestamp":{"type":"timestamp"}, + "Transcript":{ + "type":"string", + "max":6000000, + "min":1, + "pattern":".*" + }, + "TranscriptFilter":{ + "type":"structure", + "members":{ + "lexTranscriptFilter":{"shape":"LexTranscriptFilter"} + } + }, + "TranscriptFormat":{ + "type":"string", + "enum":["Lex"] + }, + "TranscriptSourceSetting":{ + "type":"structure", + "members":{ + "s3BucketTranscriptSource":{"shape":"S3BucketTranscriptSource"} + } + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -4346,6 +4878,53 @@ "lastUpdatedDateTime":{"shape":"Timestamp"} } }, + "UpdateBotRecommendationRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "botRecommendationId", + "encryptionSetting" + ], + "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" + }, + "encryptionSetting":{"shape":"EncryptionSetting"} + } + }, + "UpdateBotRecommendationResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationStatus":{"shape":"BotRecommendationStatus"}, + "botRecommendationId":{"shape":"Id"}, + "creationDateTime":{"shape":"Timestamp"}, + "lastUpdatedDateTime":{"shape":"Timestamp"}, + "transcriptSourceSetting":{"shape":"TranscriptSourceSetting"}, + "encryptionSetting":{"shape":"EncryptionSetting"} + } + }, "UpdateBotRequest":{ "type":"structure", "required":[ 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 2fe2e3a1808..3839692359c 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 @@ -29,6 +29,7 @@ "DescribeBot": "

Provides metadata information about a bot.

", "DescribeBotAlias": "

Get information about a specific bot alias.

", "DescribeBotLocale": "

Describes the settings that a bot has for a specific locale.

", + "DescribeBotRecommendation": "

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

", "DescribeBotVersion": "

Provides metadata about a version of a bot.

", "DescribeExport": "

Gets information about a specific export.

", "DescribeImport": "

Gets information about a specific import.

", @@ -39,6 +40,7 @@ "ListAggregatedUtterances": "

Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase \"I want to order pizza\" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

", "ListBotAliases": "

Gets a list of aliases for the specified bot.

", "ListBotLocales": "

Gets a list of locales for the specified bot.

", + "ListBotRecommendations": "

Get a list of bot recommendations that meet the specified criteria.

", "ListBotVersions": "

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

", "ListBots": "

Gets a list of available bots.

", "ListBuiltInIntents": "

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

", @@ -46,15 +48,19 @@ "ListExports": "

Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.

", "ListImports": "

Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.

", "ListIntents": "

Get a list of intents that meet the specified criteria.

", + "ListRecommendedIntents": "

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.

", "ListSlotTypes": "

Gets a list of slot types that match the specified criteria.

", "ListSlots": "

Gets a list of slots that match the specified criteria.

", "ListTagsForResource": "

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

", + "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 or bot locale from a zip archive that you uploaded to an S3 bucket.

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

", "UpdateBotAlias": "

Updates the configuration of an existing bot alias.

", "UpdateBotLocale": "

Updates the settings that a bot has for a specific locale.

", + "UpdateBotRecommendation": "

Updates an existing bot recommendation request.

", "UpdateExport": "

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

", "UpdateIntent": "

Updates the settings for an intent.

", "UpdateResourcePolicy": "

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

", @@ -130,6 +136,36 @@ "UpdateResourcePolicyResponse$resourceArn": "

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

" } }, + "AssociatedTranscript": { + "base": "

The object containing information that associates the recommended intent/slot type with a conversation.

", + "refs": { + "AssociatedTranscriptList$member": null + } + }, + "AssociatedTranscriptFilter": { + "base": "

Filters to search for the associated transcript.

", + "refs": { + "AssociatedTranscriptFilters$member": null + } + }, + "AssociatedTranscriptFilterName": { + "base": null, + "refs": { + "AssociatedTranscriptFilter$name": "

The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.

" + } + }, + "AssociatedTranscriptFilters": { + "base": null, + "refs": { + "SearchAssociatedTranscriptsRequest$filters": "

A list of filter objects.

" + } + }, + "AssociatedTranscriptList": { + "base": null, + "refs": { + "SearchAssociatedTranscriptsResponse$associatedTranscripts": "

The object that contains the associated transcript that meet the criteria you specified.

" + } + }, "AttachmentTitle": { "base": null, "refs": { @@ -364,6 +400,39 @@ "ListBotLocalesResponse$botLocaleSummaries": "

Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.

" } }, + "BotRecommendationResultStatistics": { + "base": "

A statistical summary of the bot recommendation results.

", + "refs": { + "BotRecommendationResults$statistics": "

The statistical summary of the bot recommendation results.

" + } + }, + "BotRecommendationResults": { + "base": "

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

", + "refs": { + "DescribeBotRecommendationResponse$botRecommendationResults": "

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

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

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

" + } + }, + "BotRecommendationSummary": { + "base": "

A summary of the bot recommendation.

", + "refs": { + "BotRecommendationSummaryList$member": null + } + }, + "BotRecommendationSummaryList": { + "base": null, + "refs": { + "ListBotRecommendationsResponse$botRecommendationSummaries": "

Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.

" + } + }, "BotSortAttribute": { "base": null, "refs": { @@ -431,6 +500,8 @@ "ListSlotTypesResponse$botVersion": "

The version of the bot that contains the slot types.

", "ListSlotsRequest$botVersion": "

The version of the bot that contains the slot.

", "ListSlotsResponse$botVersion": "

The version of the bot that contains the slots.

", + "SearchAssociatedTranscriptsRequest$botVersion": "

The version of the bot containing the transcripts that you are searching.

", + "SearchAssociatedTranscriptsResponse$botVersion": "

The version of the bot containing the transcripts that you are searching.

", "UpdateBotAliasRequest$botVersion": "

The new bot version to assign to the bot alias.

", "UpdateBotAliasResponse$botVersion": "

The updated version of the bot that the alias points to.

" } @@ -685,6 +756,13 @@ "UpdateBotAliasResponse$conversationLogSettings": "

The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

" } }, + "Count": { + "base": null, + "refs": { + "IntentStatistics$discoveredIntentCount": "

The number of recommended intents associated with the bot recommendation.

", + "SlotTypeStatistics$discoveredSlotTypeCount": "

The number of recommended slot types associated with the bot recommendation.

" + } + }, "CreateBotAliasRequest": { "base": null, "refs": { @@ -819,6 +897,12 @@ "UpdateBotResponse$dataPrivacy": "

The data privacy settings for the bot after the update.

" } }, + "DateRangeFilter": { + "base": "

The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.

", + "refs": { + "LexTranscriptFilter$dateRangeFilter": "

The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.

" + } + }, "DeleteBotAliasRequest": { "base": null, "refs": { @@ -944,6 +1028,16 @@ "refs": { } }, + "DescribeBotRecommendationRequest": { + "base": null, + "refs": { + } + }, + "DescribeBotRecommendationResponse": { + "base": null, + "refs": { + } + }, "DescribeBotRequest": { "base": null, "refs": { @@ -1100,11 +1194,21 @@ "DeleteIntentRequest$botVersion": "

The version of the bot associated with the intent.

", "DeleteSlotRequest$botVersion": "

The version of the bot associated with the slot to delete.

", "DeleteSlotTypeRequest$botVersion": "

The version of the bot associated with the slot type.

", + "DescribeBotRecommendationRequest$botVersion": "

The version of the bot associated with the bot recommendation.

", + "DescribeBotRecommendationResponse$botVersion": "

The version of the bot associated with the bot recommendation.

", "DescribeIntentResponse$botVersion": "

The version of the bot associated with the intent.

", + "ListBotRecommendationsRequest$botVersion": "

The version of the bot that contains the bot recommendation list.

", + "ListBotRecommendationsResponse$botVersion": "

The version of the bot that contains the bot recommendation list.

", "ListImportsRequest$botVersion": "

The version of the bot to list imports for.

", "ListImportsResponse$botVersion": "

The version of the bot that was imported. It will always be DRAFT.

", + "ListRecommendedIntentsRequest$botVersion": "

The version of the bot that contains the recommended intents.

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

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

", + "UpdateBotRecommendationResponse$botVersion": "

The version of the bot containing the bot recommendation that has been updated.

", "UpdateIntentRequest$botVersion": "

The version of the bot that contains the intent. Must be DRAFT.

", "UpdateIntentResponse$botVersion": "

The version of the bot that contains the intent. Will always be DRAFT.

", "UpdateSlotRequest$botVersion": "

The version of the bot that contains the slot. Must always be DRAFT.

", @@ -1119,6 +1223,16 @@ "CreateResourcePolicyStatementRequest$effect": "

Determines whether the statement allows or denies access to the resource.

" } }, + "EncryptionSetting": { + "base": "

The object representing the passwords that were used to encrypt the data related to the bot recommendation, as well as the KMS key ARN used to encrypt the associated metadata.

", + "refs": { + "DescribeBotRecommendationResponse$encryptionSetting": "

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

", + "StartBotRecommendationRequest$encryptionSetting": "

The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

", + "StartBotRecommendationResponse$encryptionSetting": "

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

", + "UpdateBotRecommendationRequest$encryptionSetting": "

The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

", + "UpdateBotRecommendationResponse$encryptionSetting": "

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

" + } + }, "ExceptionMessage": { "base": null, "refs": { @@ -1209,12 +1323,20 @@ "base": null, "refs": { "DescribeBotLocaleResponse$failureReasons": "

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

", + "DescribeBotRecommendationResponse$failureReasons": "

If botRecommendationStatus is Failed, Amazon Lex explains why.

", "DescribeBotVersionResponse$failureReasons": "

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

", "DescribeExportResponse$failureReasons": "

If the exportStatus is failed, contains one or more reasons why the export could not be completed.

", "DescribeImportResponse$failureReasons": "

If the importStatus field is Failed, this provides one or more reasons for the failure.

", "UpdateBotLocaleResponse$failureReasons": "

If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

" } }, + "FilePassword": { + "base": null, + "refs": { + "EncryptionSetting$botLocaleExportPassword": "

The password used to encrypt the recommended bot recommendation file.

", + "EncryptionSetting$associatedTranscriptsPassword": "

The password used to encrypt the associated transcript file.

" + } + }, "FilterValue": { "base": null, "refs": { @@ -1225,6 +1347,7 @@ "base": null, "refs": { "AggregatedUtterancesFilter$values": "

The value to use for filtering the list of bots.

", + "AssociatedTranscriptFilter$values": "

The values to use to filter the transcript.

", "BotFilter$values": "

The value to use for filtering the list of bots.

", "BotLocaleFilter$values": "

The value to use for filtering the list of bots.

", "ExportFilter$values": "

The values to use to filter the response.

", @@ -1292,6 +1415,7 @@ "BotExportSpecification$botId": "

The identifier of the bot assigned by Amazon Lex.

", "BotLocaleExportSpecification$botId": "

The identifier of the bot to create the locale for.

", "BotLocaleImportSpecification$botId": "

The identifier of the bot to import the locale to.

", + "BotRecommendationSummary$botRecommendationId": "

The unique identifier of the bot recommendation to be updated.

", "BotSummary$botId": "

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

", "BuildBotLocaleRequest$botId": "

The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.

", "BuildBotLocaleResponse$botId": "

The identifier of the specified bot.

", @@ -1339,6 +1463,10 @@ "DescribeBotAliasResponse$botId": "

The identifier of the bot associated with the bot alias.

", "DescribeBotLocaleRequest$botId": "

The identifier of the bot associated with the locale.

", "DescribeBotLocaleResponse$botId": "

The identifier of the bot associated with the locale.

", + "DescribeBotRecommendationRequest$botId": "

The unique identifier of the bot associated with the bot recommendation.

", + "DescribeBotRecommendationRequest$botRecommendationId": "

The identifier of the bot recommendation to describe.

", + "DescribeBotRecommendationResponse$botId": "

The identifier of the bot associated with the bot recommendation.

", + "DescribeBotRecommendationResponse$botRecommendationId": "

The identifier of the bot recommendation being described.

", "DescribeBotRequest$botId": "

The unique identifier of the bot to describe.

", "DescribeBotResponse$botId": "

The unique identifier of the bot.

", "DescribeBotVersionRequest$botId": "

The identifier of the bot containing the version to return metadata for.

", @@ -1370,6 +1498,8 @@ "ListBotAliasesResponse$botId": "

The identifier of the bot associated with the aliases.

", "ListBotLocalesRequest$botId": "

The identifier of the bot to list locales for.

", "ListBotLocalesResponse$botId": "

The identifier of the bot to list locales for.

", + "ListBotRecommendationsRequest$botId": "

The unique identifier of the bot that contains the bot recommendation list.

", + "ListBotRecommendationsResponse$botId": "

The unique identifier of the bot that contains the bot recommendation list.

", "ListBotVersionsRequest$botId": "

The identifier of the bot to list versions for.

", "ListBotVersionsResponse$botId": "

The identifier of the bot to list versions for.

", "ListExportsRequest$botId": "

The unique identifier that Amazon Lex assigned to the bot.

", @@ -1378,21 +1508,37 @@ "ListImportsResponse$botId": "

The unique identifier assigned by Amazon Lex to the bot.

", "ListIntentsRequest$botId": "

The unique identifier of the bot that contains the intent.

", "ListIntentsResponse$botId": "

The identifier of the bot that contains the intent.

", + "ListRecommendedIntentsRequest$botId": "

The unique identifier of the bot associated with the recommended intents.

", + "ListRecommendedIntentsRequest$botRecommendationId": "

The identifier of the bot recommendation that contains the recommended intents.

", + "ListRecommendedIntentsResponse$botId": "

The unique identifier of the bot associated with the recommended intent.

", + "ListRecommendedIntentsResponse$botRecommendationId": "

The identifier of the bot recommendation that contains the recommended intent.

", "ListSlotTypesRequest$botId": "

The unique identifier of the bot that contains the slot types.

", "ListSlotTypesResponse$botId": "

The identifier of the bot that contains the slot types.

", "ListSlotsRequest$botId": "

The identifier of the bot that contains the slot.

", "ListSlotsRequest$intentId": "

The unique identifier of the intent that contains the slot.

", "ListSlotsResponse$botId": "

The identifier of the bot that contains the slots.

", "ListSlotsResponse$intentId": "

The identifier of the intent that contains the slots.

", + "RecommendedIntentSummary$intentId": "

The unique identifier of a recommended intent associated with the bot recommendation.

", + "SearchAssociatedTranscriptsRequest$botId": "

The unique identifier of the bot associated with the transcripts that you are searching.

", + "SearchAssociatedTranscriptsRequest$botRecommendationId": "

The unique identifier of the bot recommendation associated with the transcripts to search.

", + "SearchAssociatedTranscriptsResponse$botId": "

The unique identifier of the bot associated with the transcripts that you are searching.

", + "SearchAssociatedTranscriptsResponse$botRecommendationId": "

The unique identifier of the bot recommendation associated with the transcripts to search.

", "SlotPriority$slotId": "

The unique identifier of the slot.

", "SlotSummary$slotId": "

The unique identifier of the slot.

", "SlotTypeSummary$slotTypeId": "

The unique identifier assigned to the slot type.

", + "StartBotRecommendationRequest$botId": "

The unique identifier of the bot containing the bot recommendation.

", + "StartBotRecommendationResponse$botId": "

The unique identifier of the bot containing the bot recommendation.

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

", "UpdateBotAliasRequest$botId": "

The identifier of the bot with the updated alias.

", "UpdateBotAliasResponse$botId": "

The identifier of the bot with the updated alias.

", "UpdateBotLocaleRequest$botId": "

The unique identifier of the bot that contains the locale.

", "UpdateBotLocaleResponse$botId": "

The identifier of the bot that contains the updated locale.

", + "UpdateBotRecommendationRequest$botId": "

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

", + "UpdateBotRecommendationRequest$botRecommendationId": "

The unique identifier of the bot recommendation to be updated.

", + "UpdateBotRecommendationResponse$botId": "

The unique identifier of the bot containing the bot recommendation that has been updated.

", + "UpdateBotRecommendationResponse$botRecommendationId": "

The unique identifier of the bot recommendation to be updated.

", "UpdateBotRequest$botId": "

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

", "UpdateBotResponse$botId": "

The unique identifier of the bot that was updated.

", "UpdateExportRequest$exportId": "

The unique identifier Amazon Lex assigned to the export.

", @@ -1594,6 +1740,12 @@ "ListIntentsRequest$sortBy": "

Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

" } }, + "IntentStatistics": { + "base": "

The object that contains the statistical summary of recommended intents associated with the bot recommendation.

", + "refs": { + "BotRecommendationResultStatistics$intents": "

Statistical information about about the intents associated with the bot recommendation results.

" + } + }, "IntentSummary": { "base": "

Summary information about an intent returned by the ListIntents operation.

", "refs": { @@ -1630,7 +1782,9 @@ "KmsKeyArn": { "base": null, "refs": { - "S3BucketLogDestination$kmsKeyArn": "

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

" + "EncryptionSetting$kmsKeyArn": "

The KMS key ARN used to encrypt the metadata associated with the bot recommendation.

", + "S3BucketLogDestination$kmsKeyArn": "

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

", + "S3BucketTranscriptSource$kmsKeyArn": "

The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

" } }, "LambdaARN": { @@ -1645,6 +1799,12 @@ "CodeHookSpecification$lambdaCodeHook": null } }, + "LexTranscriptFilter": { + "base": "

The object that contains transcript filter details that are associated with a bot recommendation.

", + "refs": { + "TranscriptFilter$lexTranscriptFilter": "

The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.

" + } + }, "ListAggregatedUtterancesRequest": { "base": null, "refs": { @@ -1675,6 +1835,16 @@ "refs": { } }, + "ListBotRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "ListBotRecommendationsResponse": { + "base": null, + "refs": { + } + }, "ListBotVersionsRequest": { "base": null, "refs": { @@ -1745,6 +1915,16 @@ "refs": { } }, + "ListRecommendedIntentsRequest": { + "base": null, + "refs": { + } + }, + "ListRecommendedIntentsResponse": { + "base": null, + "refs": { + } + }, "ListSlotTypesRequest": { "base": null, "refs": { @@ -1801,6 +1981,8 @@ "DeleteUtterancesRequest$localeId": "

The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.

", "DescribeBotLocaleRequest$localeId": "

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

", "DescribeBotLocaleResponse$localeId": "

The unique identifier of the described locale.

", + "DescribeBotRecommendationRequest$localeId": "

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

", + "DescribeBotRecommendationResponse$localeId": "

The identifier of the language and locale of the bot recommendation to describe.

", "DescribeIntentRequest$localeId": "

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

", "DescribeIntentResponse$localeId": "

The language and locale specified for the intent.

", "DescribeSlotRequest$localeId": "

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

", @@ -1809,18 +1991,28 @@ "DescribeSlotTypeResponse$localeId": "

The language and locale specified for the slot type.

", "ListAggregatedUtterancesRequest$localeId": "

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

", "ListAggregatedUtterancesResponse$localeId": "

The identifier of the language and locale that the utterances are in.

", + "ListBotRecommendationsRequest$localeId": "

The identifier of the language and locale of the bot recommendation list.

", + "ListBotRecommendationsResponse$localeId": "

The identifier of the language and locale of the bot recommendation list.

", "ListBuiltInIntentsRequest$localeId": "

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

", "ListBuiltInIntentsResponse$localeId": "

The language and locale of the intents in the list.

", "ListBuiltInSlotTypesRequest$localeId": "

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

", "ListBuiltInSlotTypesResponse$localeId": "

The language and locale of the slot types in the list.

", "ListIntentsRequest$localeId": "

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

", "ListIntentsResponse$localeId": "

The language and locale of the intents in the list.

", + "ListRecommendedIntentsRequest$localeId": "

The identifier of the language and locale of the recommended intents.

", + "ListRecommendedIntentsResponse$localeId": "

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

", "ListSlotTypesRequest$localeId": "

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

", "ListSlotTypesResponse$localeId": "

The language and local of the slot types in the list.

", "ListSlotsRequest$localeId": "

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

", "ListSlotsResponse$localeId": "

The language and locale of the slots in the list.

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

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

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

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

", "UpdateIntentRequest$localeId": "

The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

", "UpdateIntentResponse$localeId": "

The updated language and locale of the intent.

", "UpdateSlotRequest$localeId": "

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

", @@ -1851,13 +2043,17 @@ "ListAggregatedUtterancesRequest$maxResults": "

The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.

", "ListBotAliasesRequest$maxResults": "

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotLocalesRequest$maxResults": "

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", + "ListBotRecommendationsRequest$maxResults": "

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotVersionsRequest$maxResults": "

The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotsRequest$maxResults": "

The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

", "ListExportsRequest$maxResults": "

The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListImportsRequest$maxResults": "

The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListIntentsRequest$maxResults": "

The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", + "ListRecommendedIntentsRequest$maxResults": "

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListSlotTypesRequest$maxResults": "

The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", - "ListSlotsRequest$maxResults": "

The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

" + "ListSlotsRequest$maxResults": "

The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", + "SearchAssociatedTranscriptsRequest$maxResults": "

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", + "SearchAssociatedTranscriptsResponse$totalResults": "

The total number of transcripts returned by the search.

" } }, "MergeStrategy": { @@ -1944,6 +2140,7 @@ "InputContext$name": "

The name of the context.

", "IntentSummary$intentName": "

The name of the intent.

", "OutputContext$name": "

The name of the output context.

", + "RecommendedIntentSummary$intentName": "

The name of a recommended intent associated with the bot recommendation.

", "SlotSummary$slotName": "

The name given to the slot.

", "SlotTypeSummary$slotTypeName": "

The name of the slot type.

", "UpdateBotAliasRequest$botAliasName": "

The new name to assign to the bot alias.

", @@ -1958,6 +2155,13 @@ "UpdateSlotTypeResponse$slotTypeName": "

The updated name of the slot type.

" } }, + "NextIndex": { + "base": null, + "refs": { + "SearchAssociatedTranscriptsRequest$nextIndex": "

If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

", + "SearchAssociatedTranscriptsResponse$nextIndex": "

A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.

" + } + }, "NextToken": { "base": null, "refs": { @@ -1967,6 +2171,8 @@ "ListBotAliasesResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotAliases operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

", "ListBotLocalesRequest$nextToken": "

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

", "ListBotLocalesResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.

", + "ListBotRecommendationsRequest$nextToken": "

If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", + "ListBotRecommendationsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.

", "ListBotVersionsRequest$nextToken": "

If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListBotVersionsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

", "ListBotsRequest$nextToken": "

If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", @@ -1981,6 +2187,8 @@ "ListImportsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListImports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListImports operation request to get the next page of results.

", "ListIntentsRequest$nextToken": "

If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListIntentsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

", + "ListRecommendedIntentsRequest$nextToken": "

If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", + "ListRecommendedIntentsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.

", "ListSlotTypesRequest$nextToken": "

If the response from the ListSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListSlotTypesResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlotTypes operation request to get the next page of results.

", "ListSlotsRequest$nextToken": "

If the response from the ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", @@ -2016,6 +2224,18 @@ "ObfuscationSetting$obfuscationSettingType": "

Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

" } }, + "ObjectPrefix": { + "base": null, + "refs": { + "ObjectPrefixes$member": null + } + }, + "ObjectPrefixes": { + "base": null, + "refs": { + "PathFormat$objectPrefixes": "

A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.

" + } + }, "Operation": { "base": null, "refs": { @@ -2045,6 +2265,12 @@ "UpdateIntentResponse$outputContexts": "

The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

" } }, + "PathFormat": { + "base": "

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

", + "refs": { + "S3BucketTranscriptSource$pathFormat": "

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

" + } + }, "PlainTextMessage": { "base": "

Defines an ASCII text message to send to the user.

", "refs": { @@ -2079,6 +2305,8 @@ "PresignedS3Url": { "base": null, "refs": { + "BotRecommendationResults$botLocaleExportUrl": "

The presigned URL link of the recommended bot definition.

", + "BotRecommendationResults$associatedTranscriptsUrl": "

The presigned url link of the associated transcript.

", "CreateUploadUrlResponse$uploadUrl": "

A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.

", "DescribeExportResponse$downloadUrl": "

A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

" } @@ -2127,6 +2355,18 @@ "KendraConfiguration$queryFilterString": "

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

" } }, + "RecommendedIntentSummary": { + "base": "

An object that contains a summary of a recommended intent.

", + "refs": { + "RecommendedIntentSummaryList$member": null + } + }, + "RecommendedIntentSummaryList": { + "base": null, + "refs": { + "ListRecommendedIntentsResponse$summaryList": "

Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

" + } + }, "RegexPattern": { "base": null, "refs": { @@ -2208,6 +2448,18 @@ "AudioLogDestination$s3Bucket": "

The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

" } }, + "S3BucketName": { + "base": null, + "refs": { + "S3BucketTranscriptSource$s3BucketName": "

The name of the bucket containing the transcript and the associated metadata.

" + } + }, + "S3BucketTranscriptSource": { + "base": "

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

", + "refs": { + "TranscriptSourceSetting$s3BucketTranscriptSource": "

Indicates the setting of the Amazon S3 bucket where the transcript is stored.

" + } + }, "SSMLMessage": { "base": "

Defines a Speech Synthesis Markup Language (SSML) prompt.

", "refs": { @@ -2226,6 +2478,12 @@ "SampleUtterancesList$member": null } }, + "SampleUtterancesCount": { + "base": null, + "refs": { + "RecommendedIntentSummary$sampleUtterancesCount": "

The count of sample utterances of a recommended intent that is associated with a bot recommendation.

" + } + }, "SampleUtterancesList": { "base": null, "refs": { @@ -2244,6 +2502,22 @@ "SynonymList$member": null } }, + "SearchAssociatedTranscriptsRequest": { + "base": null, + "refs": { + } + }, + "SearchAssociatedTranscriptsResponse": { + "base": null, + "refs": { + } + }, + "SearchOrder": { + "base": null, + "refs": { + "SearchAssociatedTranscriptsRequest$searchOrder": "

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

" + } + }, "SentimentAnalysisSettings": { "base": "

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

", "refs": { @@ -2433,6 +2707,12 @@ "ListSlotTypesRequest$sortBy": "

Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.

" } }, + "SlotTypeStatistics": { + "base": "

The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.

", + "refs": { + "BotRecommendationResultStatistics$slotTypes": "

Statistical information about the slot types associated with the bot recommendation results.

" + } + }, "SlotTypeSummary": { "base": "

Provides summary information about a slot type.

", "refs": { @@ -2509,6 +2789,16 @@ "SlotTypeSortBy$order": "

The order to sort the list. You can say ascending or descending.

" } }, + "StartBotRecommendationRequest": { + "base": null, + "refs": { + } + }, + "StartBotRecommendationResponse": { + "base": null, + "refs": { + } + }, "StartImportRequest": { "base": null, "refs": { @@ -2634,6 +2924,8 @@ "BotLocaleHistoryEvent$eventDate": "

A timestamp of the date and time that the event occurred.

", "BotLocaleSummary$lastUpdatedDateTime": "

A timestamp of the date and time that the bot locale was last updated.

", "BotLocaleSummary$lastBuildSubmittedDateTime": "

A timestamp of the date and time that the bot locale was last built.

", + "BotRecommendationSummary$creationDateTime": "

A timestamp of the date and time that the bot recommendation was created.

", + "BotRecommendationSummary$lastUpdatedDateTime": "

A timestamp of the date and time that the bot recommendation was last updated.

", "BotSummary$lastUpdatedDateTime": "

The date and time that the bot was last updated.

", "BotVersionSummary$creationDateTime": "

A timestamp of the date and time that the version was created.

", "BuildBotLocaleResponse$lastBuildSubmittedDateTime": "

A timestamp indicating the date and time that the bot was last built for this locale.

", @@ -2645,11 +2937,15 @@ "CreateIntentResponse$creationDateTime": "

A timestamp of the date and time that the intent was created.

", "CreateSlotResponse$creationDateTime": "

The timestamp of the date and time that the slot was created.

", "CreateSlotTypeResponse$creationDateTime": "

A timestamp of the date and time that the slot type was created.

", + "DateRangeFilter$startDateTime": "

A timestamp indicating the start date for the date range filter.

", + "DateRangeFilter$endDateTime": "

A timestamp indicating the end date for the date range filter.

", "DescribeBotAliasResponse$creationDateTime": "

A timestamp of the date and time that the alias was created.

", "DescribeBotAliasResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the alias was last updated.

", "DescribeBotLocaleResponse$creationDateTime": "

The date and time that the locale was created.

", "DescribeBotLocaleResponse$lastUpdatedDateTime": "

The date and time that the locale was last updated.

", "DescribeBotLocaleResponse$lastBuildSubmittedDateTime": "

The date and time that the locale was last submitted for building.

", + "DescribeBotRecommendationResponse$creationDateTime": "

The date and time that the bot recommendation was created.

", + "DescribeBotRecommendationResponse$lastUpdatedDateTime": "

The date and time that the bot recommendation was last updated.

", "DescribeBotResponse$creationDateTime": "

A timestamp of the date and time that the bot was created.

", "DescribeBotResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the bot was last updated.

", "DescribeBotVersionResponse$creationDateTime": "

A timestamp of the date and time that the bot version was created.

", @@ -2673,11 +2969,14 @@ "ListAggregatedUtterancesResponse$aggregationLastRefreshedDateTime": "

The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

", "SlotSummary$lastUpdatedDateTime": "

The timestamp of the last date and time that the slot was updated.

", "SlotTypeSummary$lastUpdatedDateTime": "

A timestamp of the date and time that the slot type was last updated.

", + "StartBotRecommendationResponse$creationDateTime": "

A timestamp of the date and time that the bot recommendation was created.

", "StartImportResponse$creationDateTime": "

The date and time that the import request was created.

", "UpdateBotAliasResponse$creationDateTime": "

A timestamp of the date and time that the bot was created.

", "UpdateBotAliasResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the bot was last updated.

", "UpdateBotLocaleResponse$creationDateTime": "

A timestamp of the date and time that the locale was created.

", "UpdateBotLocaleResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the locale was last updated.

", + "UpdateBotRecommendationResponse$creationDateTime": "

A timestamp of the date and time that the bot recommendation was created.

", + "UpdateBotRecommendationResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the bot recommendation was last updated.

", "UpdateBotResponse$creationDateTime": "

A timestamp of the date and time that the bot was created.

", "UpdateBotResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the bot was last updated.

", "UpdateExportResponse$creationDateTime": "

The date and time that the export was created.

", @@ -2690,6 +2989,33 @@ "UpdateSlotTypeResponse$lastUpdatedDateTime": "

A timestamp of the date and time that the slot type was last updated.

" } }, + "Transcript": { + "base": null, + "refs": { + "AssociatedTranscript$transcript": "

The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.

" + } + }, + "TranscriptFilter": { + "base": "

The object representing the filter that Amazon Lex will use to select the appropriate transcript.

", + "refs": { + "S3BucketTranscriptSource$transcriptFilter": "

The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

" + } + }, + "TranscriptFormat": { + "base": null, + "refs": { + "S3BucketTranscriptSource$transcriptFormat": "

The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

" + } + }, + "TranscriptSourceSetting": { + "base": "

Indicates the setting of the location where the transcript is stored.

", + "refs": { + "DescribeBotRecommendationResponse$transcriptSourceSetting": "

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

", + "StartBotRecommendationRequest$transcriptSourceSetting": "

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

", + "StartBotRecommendationResponse$transcriptSourceSetting": "

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

", + "UpdateBotRecommendationResponse$transcriptSourceSetting": "

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -2720,6 +3046,16 @@ "refs": { } }, + "UpdateBotRecommendationRequest": { + "base": null, + "refs": { + } + }, + "UpdateBotRecommendationResponse": { + "base": null, + "refs": { + } + }, "UpdateBotRequest": { "base": null, "refs": { diff --git a/models/apis/models.lex.v2/2020-08-07/paginators-1.json b/models/apis/models.lex.v2/2020-08-07/paginators-1.json index a05bc8545b7..e5e50b9277a 100644 --- a/models/apis/models.lex.v2/2020-08-07/paginators-1.json +++ b/models/apis/models.lex.v2/2020-08-07/paginators-1.json @@ -15,6 +15,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListBotRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListBotVersions": { "input_token": "nextToken", "output_token": "nextToken", @@ -50,6 +55,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListRecommendedIntents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListSlotTypes": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/runtime.sagemaker/2017-05-13/api-2.json b/models/apis/runtime.sagemaker/2017-05-13/api-2.json index 271beb53f59..39d886a5fbb 100644 --- a/models/apis/runtime.sagemaker/2017-05-13/api-2.json +++ b/models/apis/runtime.sagemaker/2017-05-13/api-2.json @@ -24,7 +24,9 @@ {"shape":"InternalFailure"}, {"shape":"ServiceUnavailable"}, {"shape":"ValidationError"}, - {"shape":"ModelError"} + {"shape":"ModelError"}, + {"shape":"InternalDependencyException"}, + {"shape":"ModelNotReadyException"} ] }, "InvokeEndpointAsync":{ @@ -77,6 +79,16 @@ "min":1, "pattern":"^(https|s3)://([^/]+)/?(.*)$" }, + "InternalDependencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "error":{"httpStatusCode":530}, + "exception":true, + "fault":true, + "synthetic":true + }, "InternalFailure":{ "type":"structure", "members":{ @@ -232,6 +244,15 @@ "error":{"httpStatusCode":424}, "exception":true }, + "ModelNotReadyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "error":{"httpStatusCode":429}, + "exception":true, + "synthetic":true + }, "RequestTTLSecondsHeader":{ "type":"integer", "max":21600, diff --git a/models/apis/runtime.sagemaker/2017-05-13/docs-2.json b/models/apis/runtime.sagemaker/2017-05-13/docs-2.json index 434123bb2a8..36f8bdbcd49 100644 --- a/models/apis/runtime.sagemaker/2017-05-13/docs-2.json +++ b/models/apis/runtime.sagemaker/2017-05-13/docs-2.json @@ -2,8 +2,8 @@ "version": "2.0", "service": "

The Amazon SageMaker runtime API.

", "operations": { - "InvokeEndpoint": "

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

", - "InvokeEndpointAsync": "

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before the you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointAsync are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.

" + "InvokeEndpoint": "

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

", + "InvokeEndpointAsync": "

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before the you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

" }, "shapes": { "BodyBlob": { @@ -16,9 +16,9 @@ "CustomAttributesHeader": { "base": null, "refs": { - "InvokeEndpointAsyncInput$CustomAttributes": "

Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

", - "InvokeEndpointInput$CustomAttributes": "

Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

", - "InvokeEndpointOutput$CustomAttributes": "

Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

" + "InvokeEndpointAsyncInput$CustomAttributes": "

Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

", + "InvokeEndpointInput$CustomAttributes": "

Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

", + "InvokeEndpointOutput$CustomAttributes": "

Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

" } }, "EndpointName": { @@ -54,6 +54,11 @@ "InvokeEndpointAsyncInput$InputLocation": "

The Amazon S3 URI where the inference request payload is stored.

" } }, + "InternalDependencyException": { + "base": "

Your request caused an exception with an internal dependency. Contact customer support.

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

An internal failure occurred.

", "refs": { @@ -88,9 +93,11 @@ "Message": { "base": null, "refs": { + "InternalDependencyException$Message": null, "InternalFailure$Message": null, "ModelError$Message": null, "ModelError$OriginalMessage": "

Original message.

", + "ModelNotReadyException$Message": null, "ServiceUnavailable$Message": null, "ValidationError$Message": null } @@ -100,6 +107,11 @@ "refs": { } }, + "ModelNotReadyException": { + "base": "

Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.

", + "refs": { + } + }, "RequestTTLSecondsHeader": { "base": null, "refs": { diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 678d619ad55..01eafc2b5c9 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -327,6 +327,19 @@ {"shape":"ResourceNotFound"} ] }, + "CreateInferenceRecommendationsJob":{ + "name":"CreateInferenceRecommendationsJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInferenceRecommendationsJobRequest"}, + "output":{"shape":"CreateInferenceRecommendationsJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ] + }, "CreateLabelingJob":{ "name":"CreateLabelingJob", "http":{ @@ -1295,6 +1308,18 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeInferenceRecommendationsJob":{ + "name":"DescribeInferenceRecommendationsJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInferenceRecommendationsJobRequest"}, + "output":{"shape":"DescribeInferenceRecommendationsJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeLabelingJob":{ "name":"DescribeLabelingJob", "http":{ @@ -1307,6 +1332,18 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeLineageGroup":{ + "name":"DescribeLineageGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLineageGroupRequest"}, + "output":{"shape":"DescribeLineageGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeModel":{ "name":"DescribeModel", "http":{ @@ -1595,6 +1632,18 @@ "input":{"shape":"GetDeviceFleetReportRequest"}, "output":{"shape":"GetDeviceFleetReportResponse"} }, + "GetLineageGroupPolicy":{ + "name":"GetLineageGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLineageGroupPolicyRequest"}, + "output":{"shape":"GetLineageGroupPolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "GetModelPackageGroupPolicy":{ "name":"GetModelPackageGroupPolicy", "http":{ @@ -1865,6 +1914,15 @@ "input":{"shape":"ListImagesRequest"}, "output":{"shape":"ListImagesResponse"} }, + "ListInferenceRecommendationsJobs":{ + "name":"ListInferenceRecommendationsJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInferenceRecommendationsJobsRequest"}, + "output":{"shape":"ListInferenceRecommendationsJobsResponse"} + }, "ListLabelingJobs":{ "name":"ListLabelingJobs", "http":{ @@ -1886,6 +1944,15 @@ {"shape":"ResourceNotFound"} ] }, + "ListLineageGroups":{ + "name":"ListLineageGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLineageGroupsRequest"}, + "output":{"shape":"ListLineageGroupsResponse"} + }, "ListModelBiasJobDefinitions":{ "name":"ListModelBiasJobDefinitions", "http":{ @@ -1904,6 +1971,15 @@ "input":{"shape":"ListModelExplainabilityJobDefinitionsRequest"}, "output":{"shape":"ListModelExplainabilityJobDefinitionsResponse"} }, + "ListModelMetadata":{ + "name":"ListModelMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelMetadataRequest"}, + "output":{"shape":"ListModelMetadataResponse"} + }, "ListModelPackageGroups":{ "name":"ListModelPackageGroups", "http":{ @@ -2159,6 +2235,18 @@ "input":{"shape":"PutModelPackageGroupPolicyInput"}, "output":{"shape":"PutModelPackageGroupPolicyOutput"} }, + "QueryLineage":{ + "name":"QueryLineage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"QueryLineageRequest"}, + "output":{"shape":"QueryLineageResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "RegisterDevices":{ "name":"RegisterDevices", "http":{ @@ -2307,6 +2395,17 @@ {"shape":"ResourceNotFound"} ] }, + "StopInferenceRecommendationsJob":{ + "name":"StopInferenceRecommendationsJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInferenceRecommendationsJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "StopLabelingJob":{ "name":"StopLabelingJob", "http":{ @@ -2770,6 +2869,28 @@ "member":{"shape":"CodeRepositoryNameOrUrl"}, "max":3 }, + "AdditionalInferenceSpecificationDefinition":{ + "type":"structure", + "required":[ + "Name", + "Containers" + ], + "members":{ + "Name":{"shape":"EntityName"}, + "Description":{"shape":"EntityDescription"}, + "Containers":{"shape":"ModelPackageContainerDefinitionList"}, + "SupportedTransformInstanceTypes":{"shape":"TransformInstanceTypes"}, + "SupportedRealtimeInferenceInstanceTypes":{"shape":"RealtimeInferenceInstanceTypes"}, + "SupportedContentTypes":{"shape":"ContentTypes"}, + "SupportedResponseMIMETypes":{"shape":"ResponseMIMETypes"} + } + }, + "AdditionalInferenceSpecifications":{ + "type":"list", + "member":{"shape":"AdditionalInferenceSpecificationDefinition"}, + "max":15, + "min":1 + }, "AgentVersion":{ "type":"structure", "required":[ @@ -3660,7 +3781,9 @@ "Bias":{ "type":"structure", "members":{ - "Report":{"shape":"MetricsSource"} + "Report":{"shape":"MetricsSource"}, + "PreTrainingReport":{"shape":"MetricsSource"}, + "PostTrainingReport":{"shape":"MetricsSource"} } }, "BillableTimeInSeconds":{ @@ -3840,6 +3963,17 @@ "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, + "CategoricalParameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"String64"}, + "Value":{"shape":"CategoricalParameterRangeValues"} + } + }, "CategoricalParameterRange":{ "type":"structure", "required":[ @@ -3858,12 +3992,24 @@ "Values":{"shape":"ParameterValues"} } }, + "CategoricalParameterRangeValues":{ + "type":"list", + "member":{"shape":"String128"}, + "max":3, + "min":1 + }, "CategoricalParameterRanges":{ "type":"list", "member":{"shape":"CategoricalParameterRange"}, "max":20, "min":0 }, + "CategoricalParameters":{ + "type":"list", + "member":{"shape":"CategoricalParameter"}, + "max":5, + "min":1 + }, "Cents":{ "type":"integer", "max":99, @@ -3932,6 +4078,19 @@ "type":"list", "member":{"shape":"Cidr"} }, + "ClarifyCheckStepMetadata":{ + "type":"structure", + "members":{ + "CheckType":{"shape":"String256"}, + "BaselineUsedForDriftCheckConstraints":{"shape":"String1024"}, + "CalculatedBaselineConstraints":{"shape":"String1024"}, + "ModelPackageGroupName":{"shape":"String256"}, + "ViolationReport":{"shape":"String1024"}, + "CheckJobArn":{"shape":"String256"}, + "SkipCheck":{"shape":"Boolean"}, + "RegisterNewBaseline":{"shape":"Boolean"} + } + }, "ClientId":{ "type":"string", "max":1024, @@ -4181,6 +4340,7 @@ "ModelDataUrl":{"shape":"Url"}, "Environment":{"shape":"EnvironmentMap"}, "ModelPackageName":{"shape":"VersionedArnOrName"}, + "InferenceSpecificationName":{"shape":"InferenceSpecificationName"}, "MultiModelConfig":{"shape":"MultiModelConfig"} } }, @@ -4461,13 +4621,13 @@ "required":[ "CompilationJobName", "RoleArn", - "InputConfig", "OutputConfig", "StoppingCondition" ], "members":{ "CompilationJobName":{"shape":"EntityName"}, "RoleArn":{"shape":"RoleArn"}, + "ModelPackageVersionArn":{"shape":"ModelPackageArn"}, "InputConfig":{"shape":"InputConfig"}, "OutputConfig":{"shape":"OutputConfig"}, "VpcConfig":{"shape":"NeoVpcConfig"}, @@ -4797,6 +4957,31 @@ "ImageVersionArn":{"shape":"ImageVersionArn"} } }, + "CreateInferenceRecommendationsJobRequest":{ + "type":"structure", + "required":[ + "JobName", + "JobType", + "RoleArn", + "InputConfig" + ], + "members":{ + "JobName":{"shape":"RecommendationJobName"}, + "JobType":{"shape":"RecommendationJobType"}, + "RoleArn":{"shape":"RoleArn"}, + "InputConfig":{"shape":"RecommendationJobInputConfig"}, + "JobDescription":{"shape":"RecommendationJobDescription"}, + "StoppingConditions":{"shape":"RecommendationJobStoppingConditions"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateInferenceRecommendationsJobResponse":{ + "type":"structure", + "required":["JobArn"], + "members":{ + "JobArn":{"shape":"RecommendationJobArn"} + } + }, "CreateLabelingJobRequest":{ "type":"structure", "required":[ @@ -4945,7 +5130,12 @@ "shape":"ClientToken", "idempotencyToken":true }, - "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"} + "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"}, + "DriftCheckBaselines":{"shape":"DriftCheckBaselines"}, + "Domain":{"shape":"String"}, + "Task":{"shape":"String"}, + "SamplePayloadUrl":{"shape":"S3Uri"}, + "AdditionalInferenceSpecifications":{"shape":"AdditionalInferenceSpecifications"} } }, "CreateModelPackageOutput":{ @@ -6020,7 +6210,7 @@ "DescribeActionResponse":{ "type":"structure", "members":{ - "ActionName":{"shape":"ExperimentEntityName"}, + "ActionName":{"shape":"ExperimentEntityNameOrArn"}, "ActionArn":{"shape":"ActionArn"}, "Source":{"shape":"ActionSource"}, "ActionType":{"shape":"String256"}, @@ -6031,7 +6221,8 @@ "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{"shape":"Timestamp"}, "LastModifiedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"} + "MetadataProperties":{"shape":"MetadataProperties"}, + "LineageGroupArn":{"shape":"LineageGroupArn"} } }, "DescribeAlgorithmInput":{ @@ -6123,7 +6314,7 @@ "DescribeArtifactResponse":{ "type":"structure", "members":{ - "ArtifactName":{"shape":"ExperimentEntityName"}, + "ArtifactName":{"shape":"ExperimentEntityNameOrArn"}, "ArtifactArn":{"shape":"ArtifactArn"}, "Source":{"shape":"ArtifactSource"}, "ArtifactType":{"shape":"String256"}, @@ -6132,7 +6323,8 @@ "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{"shape":"Timestamp"}, "LastModifiedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"} + "MetadataProperties":{"shape":"MetadataProperties"}, + "LineageGroupArn":{"shape":"LineageGroupArn"} } }, "DescribeAutoMLJobRequest":{ @@ -6232,6 +6424,7 @@ "CompilationEndTime":{"shape":"Timestamp"}, "StoppingCondition":{"shape":"StoppingCondition"}, "InferenceImage":{"shape":"InferenceImage"}, + "ModelPackageVersionArn":{"shape":"ModelPackageArn"}, "CreationTime":{"shape":"CreationTime"}, "LastModifiedTime":{"shape":"LastModifiedTime"}, "FailureReason":{"shape":"FailureReason"}, @@ -6247,7 +6440,7 @@ "type":"structure", "required":["ContextName"], "members":{ - "ContextName":{"shape":"ExperimentEntityName"} + "ContextName":{"shape":"ExperimentEntityNameOrArn"} } }, "DescribeContextResponse":{ @@ -6262,7 +6455,8 @@ "CreationTime":{"shape":"Timestamp"}, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{"shape":"Timestamp"}, - "LastModifiedBy":{"shape":"UserContext"} + "LastModifiedBy":{"shape":"UserContext"}, + "LineageGroupArn":{"shape":"LineageGroupArn"} } }, "DescribeDataQualityJobDefinitionRequest":{ @@ -6673,6 +6867,41 @@ "Version":{"shape":"ImageVersionNumber"} } }, + "DescribeInferenceRecommendationsJobRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{"shape":"RecommendationJobName"} + } + }, + "DescribeInferenceRecommendationsJobResponse":{ + "type":"structure", + "required":[ + "JobName", + "JobType", + "JobArn", + "RoleArn", + "Status", + "CreationTime", + "LastModifiedTime", + "InputConfig" + ], + "members":{ + "JobName":{"shape":"RecommendationJobName"}, + "JobDescription":{"shape":"RecommendationJobDescription"}, + "JobType":{"shape":"RecommendationJobType"}, + "JobArn":{"shape":"RecommendationJobArn"}, + "RoleArn":{"shape":"RoleArn"}, + "Status":{"shape":"RecommendationJobStatus"}, + "CreationTime":{"shape":"CreationTime"}, + "CompletionTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"LastModifiedTime"}, + "FailureReason":{"shape":"FailureReason"}, + "InputConfig":{"shape":"RecommendationJobInputConfig"}, + "StoppingConditions":{"shape":"RecommendationJobStoppingConditions"}, + "InferenceRecommendations":{"shape":"InferenceRecommendations"} + } + }, "DescribeLabelingJobRequest":{ "type":"structure", "required":["LabelingJobName"], @@ -6716,6 +6945,26 @@ "LabelingJobOutput":{"shape":"LabelingJobOutput"} } }, + "DescribeLineageGroupRequest":{ + "type":"structure", + "required":["LineageGroupName"], + "members":{ + "LineageGroupName":{"shape":"ExperimentEntityName"} + } + }, + "DescribeLineageGroupResponse":{ + "type":"structure", + "members":{ + "LineageGroupName":{"shape":"ExperimentEntityName"}, + "LineageGroupArn":{"shape":"LineageGroupArn"}, + "DisplayName":{"shape":"ExperimentEntityName"}, + "Description":{"shape":"ExperimentDescription"}, + "CreationTime":{"shape":"Timestamp"}, + "CreatedBy":{"shape":"UserContext"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "LastModifiedBy":{"shape":"UserContext"} + } + }, "DescribeModelBiasJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], @@ -6870,7 +7119,12 @@ "LastModifiedTime":{"shape":"Timestamp"}, "LastModifiedBy":{"shape":"UserContext"}, "ApprovalDescription":{"shape":"ApprovalDescription"}, - "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"} + "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"}, + "DriftCheckBaselines":{"shape":"DriftCheckBaselines"}, + "Domain":{"shape":"String"}, + "Task":{"shape":"String"}, + "SamplePayloadUrl":{"shape":"String"}, + "AdditionalInferenceSpecifications":{"shape":"AdditionalInferenceSpecifications"} } }, "DescribeModelQualityJobDefinitionRequest":{ @@ -7260,7 +7514,7 @@ "type":"structure", "required":["TrialComponentName"], "members":{ - "TrialComponentName":{"shape":"ExperimentEntityName"} + "TrialComponentName":{"shape":"ExperimentEntityNameOrArn"} } }, "DescribeTrialComponentResponse":{ @@ -7281,7 +7535,8 @@ "InputArtifacts":{"shape":"TrialComponentArtifacts"}, "OutputArtifacts":{"shape":"TrialComponentArtifacts"}, "MetadataProperties":{"shape":"MetadataProperties"}, - "Metrics":{"shape":"TrialComponentMetricSummaries"} + "Metrics":{"shape":"TrialComponentMetricSummaries"}, + "LineageGroupArn":{"shape":"LineageGroupArn"} } }, "DescribeTrialRequest":{ @@ -7504,6 +7759,14 @@ "Disabled" ] }, + "Direction":{ + "type":"string", + "enum":[ + "Both", + "Ascendants", + "Descendants" + ] + }, "DirectoryPath":{ "type":"string", "max":4096, @@ -7608,6 +7871,52 @@ ] }, "DoubleParameterValue":{"type":"double"}, + "DriftCheckBaselines":{ + "type":"structure", + "members":{ + "Bias":{"shape":"DriftCheckBias"}, + "Explainability":{"shape":"DriftCheckExplainability"}, + "ModelQuality":{"shape":"DriftCheckModelQuality"}, + "ModelDataQuality":{"shape":"DriftCheckModelDataQuality"} + } + }, + "DriftCheckBias":{ + "type":"structure", + "members":{ + "ConfigFile":{"shape":"FileSource"}, + "PreTrainingConstraints":{"shape":"MetricsSource"}, + "PostTrainingConstraints":{"shape":"MetricsSource"} + } + }, + "DriftCheckExplainability":{ + "type":"structure", + "members":{ + "Constraints":{"shape":"MetricsSource"}, + "ConfigFile":{"shape":"FileSource"} + } + }, + "DriftCheckModelDataQuality":{ + "type":"structure", + "members":{ + "Statistics":{"shape":"MetricsSource"}, + "Constraints":{"shape":"MetricsSource"} + } + }, + "DriftCheckModelQuality":{ + "type":"structure", + "members":{ + "Statistics":{"shape":"MetricsSource"}, + "Constraints":{"shape":"MetricsSource"} + } + }, + "Edge":{ + "type":"structure", + "members":{ + "SourceArn":{"shape":"AssociationEntityArn"}, + "DestinationArn":{"shape":"AssociationEntityArn"}, + "AssociationType":{"shape":"AssociationEdgeType"} + } + }, "EdgeModel":{ "type":"structure", "required":[ @@ -7744,6 +8053,10 @@ "min":1, "pattern":"[a-zA-Z0-9\\ \\_\\.]+" }, + "Edges":{ + "type":"list", + "member":{"shape":"Edge"} + }, "EfsUid":{ "type":"string", "max":10, @@ -7850,6 +8163,21 @@ "EndTimeOffset":{"shape":"MonitoringTimeOffsetString"} } }, + "EndpointInputConfiguration":{ + "type":"structure", + "required":["InstanceType"], + "members":{ + "InstanceType":{"shape":"ProductionVariantInstanceType"}, + "InferenceSpecificationName":{"shape":"InferenceSpecificationName"}, + "EnvironmentParameterRanges":{"shape":"EnvironmentParameterRanges"} + } + }, + "EndpointInputConfigurations":{ + "type":"list", + "member":{"shape":"EndpointInputConfiguration"}, + "max":10, + "min":1 + }, "EndpointName":{ "type":"string", "max":63, @@ -7860,6 +8188,21 @@ "max":63, "pattern":"[a-zA-Z0-9-]+" }, + "EndpointOutputConfiguration":{ + "type":"structure", + "required":[ + "EndpointName", + "VariantName", + "InstanceType", + "InitialInstanceCount" + ], + "members":{ + "EndpointName":{"shape":"String"}, + "VariantName":{"shape":"String"}, + "InstanceType":{"shape":"ProductionVariantInstanceType"}, + "InitialInstanceCount":{"shape":"Integer"} + } + }, "EndpointSortKey":{ "type":"string", "enum":[ @@ -7924,6 +8267,31 @@ "value":{"shape":"EnvironmentValue"}, "max":16 }, + "EnvironmentParameter":{ + "type":"structure", + "required":[ + "Key", + "ValueType", + "Value" + ], + "members":{ + "Key":{"shape":"String"}, + "ValueType":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "EnvironmentParameterRanges":{ + "type":"structure", + "members":{ + "CategoricalParameterRanges":{"shape":"CategoricalParameters"} + } + }, + "EnvironmentParameters":{ + "type":"list", + "member":{"shape":"EnvironmentParameter"}, + "max":10, + "min":1 + }, "EnvironmentValue":{ "type":"string", "max":1024, @@ -7985,6 +8353,12 @@ "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" }, + "ExperimentEntityNameOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})" + }, "ExperimentSource":{ "type":"structure", "required":["SourceArn"], @@ -8144,6 +8518,15 @@ "String" ] }, + "FileSource":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "ContentType":{"shape":"ContentType"}, + "ContentDigest":{"shape":"ContentDigest"}, + "S3Uri":{"shape":"S3Uri"} + } + }, "FileSystemAccessMode":{ "type":"string", "enum":[ @@ -8376,6 +8759,20 @@ "ModelStats":{"shape":"EdgeModelStats"} } }, + "GetLineageGroupPolicyRequest":{ + "type":"structure", + "required":["LineageGroupName"], + "members":{ + "LineageGroupName":{"shape":"LineageGroupNameOrArn"} + } + }, + "GetLineageGroupPolicyResponse":{ + "type":"structure", + "members":{ + "LineageGroupArn":{"shape":"LineageGroupArn"}, + "ResourcePolicy":{"shape":"ResourcePolicyString"} + } + }, "GetModelPackageGroupPolicyInput":{ "type":"structure", "required":["ModelPackageGroupName"], @@ -9009,10 +9406,58 @@ "type":"string", "max":256 }, - "InferenceSpecification":{ + "InferenceRecommendation":{ "type":"structure", "required":[ - "Containers", + "Metrics", + "EndpointConfiguration", + "ModelConfiguration" + ], + "members":{ + "Metrics":{"shape":"RecommendationMetrics"}, + "EndpointConfiguration":{"shape":"EndpointOutputConfiguration"}, + "ModelConfiguration":{"shape":"ModelConfiguration"} + } + }, + "InferenceRecommendations":{ + "type":"list", + "member":{"shape":"InferenceRecommendation"}, + "max":10, + "min":1 + }, + "InferenceRecommendationsJob":{ + "type":"structure", + "required":[ + "JobName", + "JobDescription", + "JobType", + "JobArn", + "Status", + "CreationTime", + "RoleArn", + "LastModifiedTime" + ], + "members":{ + "JobName":{"shape":"RecommendationJobName"}, + "JobDescription":{"shape":"RecommendationJobDescription"}, + "JobType":{"shape":"RecommendationJobType"}, + "JobArn":{"shape":"RecommendationJobArn"}, + "Status":{"shape":"RecommendationJobStatus"}, + "CreationTime":{"shape":"CreationTime"}, + "CompletionTime":{"shape":"Timestamp"}, + "RoleArn":{"shape":"RoleArn"}, + "LastModifiedTime":{"shape":"LastModifiedTime"}, + "FailureReason":{"shape":"FailureReason"} + } + }, + "InferenceRecommendationsJobs":{ + "type":"list", + "member":{"shape":"InferenceRecommendationsJob"} + }, + "InferenceSpecification":{ + "type":"structure", + "required":[ + "Containers", "SupportedContentTypes", "SupportedResponseMIMETypes" ], @@ -9024,6 +9469,16 @@ "SupportedResponseMIMETypes":{"shape":"ResponseMIMETypes"} } }, + "InferenceSpecificationName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + }, + "InitialNumberOfUsers":{ + "type":"integer", + "min":1 + }, "InitialTaskCount":{ "type":"integer", "min":1 @@ -9172,6 +9627,10 @@ "type":"string", "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, + "JobDurationInSeconds":{ + "type":"integer", + "min":1 + }, "JobReferenceCode":{ "type":"string", "min":1, @@ -9460,6 +9919,40 @@ "value":{"shape":"StringParameterValue"}, "max":30 }, + "LineageGroupArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*" + }, + "LineageGroupNameOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})" + }, + "LineageGroupSummaries":{ + "type":"list", + "member":{"shape":"LineageGroupSummary"} + }, + "LineageGroupSummary":{ + "type":"structure", + "members":{ + "LineageGroupArn":{"shape":"LineageGroupArn"}, + "LineageGroupName":{"shape":"ExperimentEntityName"}, + "DisplayName":{"shape":"ExperimentEntityName"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"} + } + }, + "LineageType":{ + "type":"string", + "enum":[ + "TrialComponent", + "Artifact", + "Context", + "Action" + ] + }, "ListActionsRequest":{ "type":"structure", "members":{ @@ -10031,6 +10524,37 @@ "NextToken":{"shape":"NextToken"} } }, + "ListInferenceRecommendationsJobsRequest":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{"shape":"CreationTime"}, + "CreationTimeBefore":{"shape":"CreationTime"}, + "LastModifiedTimeAfter":{"shape":"LastModifiedTime"}, + "LastModifiedTimeBefore":{"shape":"LastModifiedTime"}, + "NameContains":{"shape":"NameContains"}, + "StatusEquals":{"shape":"RecommendationJobStatus"}, + "SortBy":{"shape":"ListInferenceRecommendationsJobsSortBy"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "ListInferenceRecommendationsJobsResponse":{ + "type":"structure", + "required":["InferenceRecommendationsJobs"], + "members":{ + "InferenceRecommendationsJobs":{"shape":"InferenceRecommendationsJobs"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListInferenceRecommendationsJobsSortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, "ListLabelingJobsForWorkteamRequest":{ "type":"structure", "required":["WorkteamArn"], @@ -10083,6 +10607,24 @@ "type":"list", "member":{"shape":"StringParameterValue"} }, + "ListLineageGroupsRequest":{ + "type":"structure", + "members":{ + "CreatedAfter":{"shape":"Timestamp"}, + "CreatedBefore":{"shape":"Timestamp"}, + "SortBy":{"shape":"SortLineageGroupsBy"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "ListLineageGroupsResponse":{ + "type":"structure", + "members":{ + "LineageGroupSummaries":{"shape":"LineageGroupSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListMaxResults":{ "type":"integer", "max":100 @@ -10129,6 +10671,22 @@ "NextToken":{"shape":"NextToken"} } }, + "ListModelMetadataRequest":{ + "type":"structure", + "members":{ + "SearchExpression":{"shape":"ModelMetadataSearchExpression"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "ListModelMetadataResponse":{ + "type":"structure", + "required":["ModelMetadataSummaries"], + "members":{ + "ModelMetadataSummaries":{"shape":"ModelMetadataSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListModelPackageGroupsInput":{ "type":"structure", "members":{ @@ -10709,10 +11267,18 @@ "type":"integer", "min":1 }, + "MaxNumberOfTests":{ + "type":"integer", + "min":1 + }, "MaxNumberOfTrainingJobs":{ "type":"integer", "min":1 }, + "MaxParallelOfTests":{ + "type":"integer", + "min":1 + }, "MaxParallelTrainingJobs":{ "type":"integer", "min":1 @@ -10922,6 +11488,13 @@ "InvocationsMaxRetries":{"shape":"InvocationsMaxRetries"} } }, + "ModelConfiguration":{ + "type":"structure", + "members":{ + "InferenceSpecificationName":{"shape":"InferenceSpecificationName"}, + "EnvironmentParameters":{"shape":"EnvironmentParameters"} + } + }, "ModelDataQuality":{ "type":"structure", "members":{ @@ -10974,6 +11547,79 @@ "EndpointInput":{"shape":"EndpointInput"} } }, + "ModelInput":{ + "type":"structure", + "required":["DataInputConfig"], + "members":{ + "DataInputConfig":{"shape":"DataInputConfig"} + } + }, + "ModelLatencyThreshold":{ + "type":"structure", + "members":{ + "Percentile":{"shape":"String64"}, + "ValueInMilliseconds":{"shape":"Integer"} + } + }, + "ModelLatencyThresholds":{ + "type":"list", + "member":{"shape":"ModelLatencyThreshold"}, + "max":1, + "min":1 + }, + "ModelMetadataFilter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"ModelMetadataFilterType"}, + "Value":{"shape":"String256"} + } + }, + "ModelMetadataFilterType":{ + "type":"string", + "enum":[ + "Domain", + "Framework", + "Task", + "FrameworkVersion" + ] + }, + "ModelMetadataFilters":{ + "type":"list", + "member":{"shape":"ModelMetadataFilter"}, + "max":4, + "min":1 + }, + "ModelMetadataSearchExpression":{ + "type":"structure", + "members":{ + "Filters":{"shape":"ModelMetadataFilters"} + } + }, + "ModelMetadataSummaries":{ + "type":"list", + "member":{"shape":"ModelMetadataSummary"} + }, + "ModelMetadataSummary":{ + "type":"structure", + "required":[ + "Domain", + "Framework", + "Task", + "Model", + "FrameworkVersion" + ], + "members":{ + "Domain":{"shape":"String"}, + "Framework":{"shape":"String"}, + "Task":{"shape":"String"}, + "Model":{"shape":"String"}, + "FrameworkVersion":{"shape":"String"} + } + }, "ModelMetrics":{ "type":"structure", "members":{ @@ -11015,8 +11661,13 @@ "LastModifiedTime":{"shape":"Timestamp"}, "LastModifiedBy":{"shape":"UserContext"}, "ApprovalDescription":{"shape":"ApprovalDescription"}, + "Domain":{"shape":"String"}, + "Task":{"shape":"String"}, + "SamplePayloadUrl":{"shape":"String"}, + "AdditionalInferenceSpecifications":{"shape":"AdditionalInferenceSpecifications"}, "Tags":{"shape":"TagList"}, - "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"} + "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"}, + "DriftCheckBaselines":{"shape":"DriftCheckBaselines"} } }, "ModelPackageArn":{ @@ -11040,7 +11691,11 @@ "ImageDigest":{"shape":"ImageDigest"}, "ModelDataUrl":{"shape":"Url"}, "ProductId":{"shape":"ProductId"}, - "Environment":{"shape":"EnvironmentMap"} + "Environment":{"shape":"EnvironmentMap"}, + "ModelInput":{"shape":"ModelInput"}, + "Framework":{"shape":"String"}, + "FrameworkVersion":{"shape":"FrameworkVersion"}, + "NearestModelName":{"shape":"String"} } }, "ModelPackageContainerDefinitionList":{ @@ -12141,7 +12796,9 @@ "DesiredInstanceCount":{"shape":"TaskCount"}, "InstanceType":{"shape":"ProductionVariantInstanceType"}, "AcceleratorType":{"shape":"ProductionVariantAcceleratorType"}, - "VariantStatus":{"shape":"ProductionVariantStatusList"} + "VariantStatus":{"shape":"ProductionVariantStatusList"}, + "CurrentServerlessConfig":{"shape":"ProductionVariantServerlessConfig"}, + "DesiredServerlessConfig":{"shape":"ProductionVariantServerlessConfig"} } }, "PendingProductionVariantSummaryList":{ @@ -12149,6 +12806,19 @@ "member":{"shape":"PendingProductionVariantSummary"}, "min":1 }, + "Phase":{ + "type":"structure", + "members":{ + "InitialNumberOfUsers":{"shape":"InitialNumberOfUsers"}, + "SpawnRate":{"shape":"SpawnRate"}, + "DurationInSeconds":{"shape":"TrafficDurationInSeconds"} + } + }, + "Phases":{ + "type":"list", + "member":{"shape":"Phase"}, + "min":1 + }, "Pipeline":{ "type":"structure", "members":{ @@ -12261,7 +12931,9 @@ "RegisterModel":{"shape":"RegisterModelStepMetadata"}, "Condition":{"shape":"ConditionStepMetadata"}, "Callback":{"shape":"CallbackStepMetadata"}, - "Lambda":{"shape":"LambdaStepMetadata"} + "Lambda":{"shape":"LambdaStepMetadata"}, + "QualityCheck":{"shape":"QualityCheckStepMetadata"}, + "ClarifyCheck":{"shape":"ClarifyCheckStepMetadata"} } }, "PipelineExecutionSummary":{ @@ -12656,9 +13328,7 @@ "type":"structure", "required":[ "VariantName", - "ModelName", - "InitialInstanceCount", - "InstanceType" + "ModelName" ], "members":{ "VariantName":{"shape":"VariantName"}, @@ -12667,7 +13337,8 @@ "InstanceType":{"shape":"ProductionVariantInstanceType"}, "InitialVariantWeight":{"shape":"VariantWeight"}, "AcceleratorType":{"shape":"ProductionVariantAcceleratorType"}, - "CoreDumpConfig":{"shape":"ProductionVariantCoreDumpConfig"} + "CoreDumpConfig":{"shape":"ProductionVariantCoreDumpConfig"}, + "ServerlessConfig":{"shape":"ProductionVariantServerlessConfig"} } }, "ProductionVariantAcceleratorType":{ @@ -12766,6 +13437,17 @@ "max":10, "min":1 }, + "ProductionVariantServerlessConfig":{ + "type":"structure", + "required":[ + "MemorySizeInMB", + "MaxConcurrency" + ], + "members":{ + "MemorySizeInMB":{"shape":"ServerlessMemorySizeInMB"}, + "MaxConcurrency":{"shape":"ServerlessMaxConcurrency"} + } + }, "ProductionVariantStatus":{ "type":"structure", "required":["Status"], @@ -12791,7 +13473,9 @@ "DesiredWeight":{"shape":"VariantWeight"}, "CurrentInstanceCount":{"shape":"TaskCount"}, "DesiredInstanceCount":{"shape":"TaskCount"}, - "VariantStatus":{"shape":"ProductionVariantStatusList"} + "VariantStatus":{"shape":"ProductionVariantStatusList"}, + "CurrentServerlessConfig":{"shape":"ProductionVariantServerlessConfig"}, + "DesiredServerlessConfig":{"shape":"ProductionVariantServerlessConfig"} } }, "ProductionVariantSummaryList":{ @@ -13029,6 +13713,84 @@ "ModelPackageGroupArn":{"shape":"ModelPackageGroupArn"} } }, + "QualityCheckStepMetadata":{ + "type":"structure", + "members":{ + "CheckType":{"shape":"String256"}, + "BaselineUsedForDriftCheckStatistics":{"shape":"String1024"}, + "BaselineUsedForDriftCheckConstraints":{"shape":"String1024"}, + "CalculatedBaselineStatistics":{"shape":"String1024"}, + "CalculatedBaselineConstraints":{"shape":"String1024"}, + "ModelPackageGroupName":{"shape":"String256"}, + "ViolationReport":{"shape":"String1024"}, + "CheckJobArn":{"shape":"String256"}, + "SkipCheck":{"shape":"Boolean"}, + "RegisterNewBaseline":{"shape":"Boolean"} + } + }, + "QueryFilters":{ + "type":"structure", + "members":{ + "Types":{"shape":"QueryTypes"}, + "LineageTypes":{"shape":"QueryLineageTypes"}, + "CreatedBefore":{"shape":"Timestamp"}, + "CreatedAfter":{"shape":"Timestamp"}, + "ModifiedBefore":{"shape":"Timestamp"}, + "ModifiedAfter":{"shape":"Timestamp"}, + "Properties":{"shape":"QueryProperties"} + } + }, + "QueryLineageMaxDepth":{ + "type":"integer", + "max":10 + }, + "QueryLineageMaxResults":{ + "type":"integer", + "max":50 + }, + "QueryLineageRequest":{ + "type":"structure", + "required":["StartArns"], + "members":{ + "StartArns":{"shape":"QueryLineageStartArns"}, + "Direction":{"shape":"Direction"}, + "IncludeEdges":{"shape":"Boolean"}, + "Filters":{"shape":"QueryFilters"}, + "MaxDepth":{"shape":"QueryLineageMaxDepth"}, + "MaxResults":{"shape":"QueryLineageMaxResults"}, + "NextToken":{"shape":"String8192"} + } + }, + "QueryLineageResponse":{ + "type":"structure", + "members":{ + "Vertices":{"shape":"Vertices"}, + "Edges":{"shape":"Edges"}, + "NextToken":{"shape":"String8192"} + } + }, + "QueryLineageStartArns":{ + "type":"list", + "member":{"shape":"AssociationEntityArn"}, + "max":1, + "min":1 + }, + "QueryLineageTypes":{ + "type":"list", + "member":{"shape":"LineageType"}, + "max":4 + }, + "QueryProperties":{ + "type":"map", + "key":{"shape":"String256"}, + "value":{"shape":"String256"}, + "max":5 + }, + "QueryTypes":{ + "type":"list", + "member":{"shape":"String40"}, + "max":5 + }, "RSessionAppSettings":{ "type":"structure", "members":{ @@ -13077,6 +13839,79 @@ "type":"list", "member":{"shape":"ProductionVariantInstanceType"} }, + "RecommendationJobArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*" + }, + "RecommendationJobDescription":{ + "type":"string", + "max":128 + }, + "RecommendationJobInputConfig":{ + "type":"structure", + "required":["ModelPackageVersionArn"], + "members":{ + "ModelPackageVersionArn":{"shape":"ModelPackageArn"}, + "JobDurationInSeconds":{"shape":"JobDurationInSeconds"}, + "TrafficPattern":{"shape":"TrafficPattern"}, + "ResourceLimit":{"shape":"RecommendationJobResourceLimit"}, + "EndpointConfigurations":{"shape":"EndpointInputConfigurations"} + } + }, + "RecommendationJobName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" + }, + "RecommendationJobResourceLimit":{ + "type":"structure", + "members":{ + "MaxNumberOfTests":{"shape":"MaxNumberOfTests"}, + "MaxParallelOfTests":{"shape":"MaxParallelOfTests"} + } + }, + "RecommendationJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "STOPPING", + "STOPPED" + ] + }, + "RecommendationJobStoppingConditions":{ + "type":"structure", + "members":{ + "MaxInvocations":{"shape":"Integer"}, + "ModelLatencyThresholds":{"shape":"ModelLatencyThresholds"} + } + }, + "RecommendationJobType":{ + "type":"string", + "enum":[ + "Default", + "Advanced" + ] + }, + "RecommendationMetrics":{ + "type":"structure", + "required":[ + "CostPerHour", + "CostPerInference", + "MaxInvocations", + "ModelLatency" + ], + "members":{ + "CostPerHour":{"shape":"Float"}, + "CostPerInference":{"shape":"Float"}, + "MaxInvocations":{"shape":"Integer"}, + "ModelLatency":{"shape":"Integer"} + } + }, "RecordWrapper":{ "type":"string", "enum":[ @@ -13295,6 +14130,11 @@ }, "exception":true }, + "ResourcePolicyString":{ + "type":"string", + "max":20480, + "pattern":".*(?:[ \\r\\n\\t].*)*" + }, "ResourcePropertyName":{ "type":"string", "max":255, @@ -13642,6 +14482,16 @@ "PipelineExecutionArn":{"shape":"PipelineExecutionArn"} } }, + "ServerlessMaxConcurrency":{ + "type":"integer", + "max":50, + "min":1 + }, + "ServerlessMemorySizeInMB":{ + "type":"integer", + "max":6144, + "min":1024 + }, "ServiceCatalogEntityId":{ "type":"string", "max":100, @@ -13744,6 +14594,13 @@ "CreationTime" ] }, + "SortLineageGroupsBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, "SortOrder":{ "type":"string", "enum":[ @@ -13816,6 +14673,10 @@ "max":2048, "pattern":".*" }, + "SpawnRate":{ + "type":"integer", + "min":0 + }, "SplitType":{ "type":"string", "enum":[ @@ -13912,6 +14773,13 @@ "HyperParameterTuningJobName":{"shape":"HyperParameterTuningJobName"} } }, + "StopInferenceRecommendationsJobRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{"shape":"RecommendationJobName"} + } + }, "StopLabelingJobRequest":{ "type":"structure", "required":["LabelingJobName"], @@ -13986,6 +14854,10 @@ "type":"string", "max":1024 }, + "String128":{ + "type":"string", + "max":128 + }, "String200":{ "type":"string", "max":200, @@ -14000,10 +14872,18 @@ "type":"string", "max":256 }, + "String40":{ + "type":"string", + "max":40 + }, "String64":{ "type":"string", "max":64 }, + "String8192":{ + "type":"string", + "max":8192 + }, "StringParameterValue":{ "type":"string", "max":256, @@ -14294,6 +15174,17 @@ "pattern":"[a-zA-Z0-9:_-]+" }, "Timestamp":{"type":"timestamp"}, + "TrafficDurationInSeconds":{ + "type":"integer", + "min":1 + }, + "TrafficPattern":{ + "type":"structure", + "members":{ + "TrafficType":{"shape":"TrafficType"}, + "Phases":{"shape":"Phases"} + } + }, "TrafficRoutingConfig":{ "type":"structure", "required":[ @@ -14315,6 +15206,10 @@ "LINEAR" ] }, + "TrafficType":{ + "type":"string", + "enum":["PHASES"] + }, "TrainingEnvironmentKey":{ "type":"string", "max":512, @@ -14797,6 +15692,7 @@ "Metrics":{"shape":"TrialComponentMetricSummaries"}, "MetadataProperties":{"shape":"MetadataProperties"}, "SourceDetail":{"shape":"TrialComponentSourceDetail"}, + "LineageGroupArn":{"shape":"LineageGroupArn"}, "Tags":{"shape":"TagList"}, "Parents":{"shape":"Parents"} } @@ -15212,7 +16108,8 @@ "ModelApprovalStatus":{"shape":"ModelApprovalStatus"}, "ApprovalDescription":{"shape":"ApprovalDescription"}, "CustomerMetadataProperties":{"shape":"CustomerMetadataMap"}, - "CustomerMetadataPropertiesToRemove":{"shape":"CustomerMetadataKeyList"} + "CustomerMetadataPropertiesToRemove":{"shape":"CustomerMetadataKeyList"}, + "AdditionalInferenceSpecificationsToAdd":{"shape":"AdditionalInferenceSpecifications"} } }, "UpdateModelPackageOutput":{ @@ -15550,6 +16447,18 @@ "min":1, "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

", "CreateImage": "

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.

", "CreateImageVersion": "

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.

", + "CreateInferenceRecommendationsJob": "

Starts a recommendation job. You can create either an instance recommendation or load test job.

", "CreateLabelingJob": "

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

", "CreateModel": "

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the CreateModel request, you must define a container with the PrimaryContainer parameter.

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

", "CreateModelBiasJobDefinition": "

Creates the definition for a model bias job.

", @@ -113,7 +114,9 @@ "DescribeHyperParameterTuningJob": "

Gets a description of a hyperparameter tuning job.

", "DescribeImage": "

Describes a SageMaker image.

", "DescribeImageVersion": "

Describes a version of a SageMaker image.

", + "DescribeInferenceRecommendationsJob": "

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

", "DescribeLabelingJob": "

Gets information about a labeling job.

", + "DescribeLineageGroup": "

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

", "DescribeModel": "

Describes a model that you created using the CreateModel API.

", "DescribeModelBiasJobDefinition": "

Returns a description of a model bias job definition.

", "DescribeModelExplainabilityJobDefinition": "

Returns a description of a model explainability job definition.

", @@ -141,6 +144,7 @@ "DisassociateTrialComponent": "

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

", "EnableSagemakerServicecatalogPortfolio": "

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", "GetDeviceFleetReport": "

Describes a fleet.

", + "GetLineageGroupPolicy": "

The resource policy for the lineage group.

", "GetModelPackageGroupPolicy": "

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

", "GetSagemakerServicecatalogPortfolioStatus": "

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", "GetSearchSuggestions": "

An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

", @@ -169,10 +173,13 @@ "ListHyperParameterTuningJobs": "

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

", "ListImageVersions": "

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

", "ListImages": "

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

", + "ListInferenceRecommendationsJobs": "

Lists recommendation jobs that satisfy various filters.

", "ListLabelingJobs": "

Gets a list of labeling jobs.

", "ListLabelingJobsForWorkteam": "

Gets a list of labeling jobs assigned to a specified work team.

", + "ListLineageGroups": "

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

", "ListModelBiasJobDefinitions": "

Lists model bias jobs definitions that satisfy various filters.

", "ListModelExplainabilityJobDefinitions": "

Lists model explainability job definitions that satisfy various filters.

", + "ListModelMetadata": "

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

", "ListModelPackageGroups": "

Gets a list of the model groups in your Amazon Web Services account.

", "ListModelPackages": "

Lists the model packages that have been created.

", "ListModelQualityJobDefinitions": "

Gets a list of model quality monitoring job definitions in your account.

", @@ -199,6 +206,7 @@ "ListWorkforces": "

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

", "ListWorkteams": "

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

", "PutModelPackageGroupPolicy": "

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

", + "QueryLineage": "

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

", "RegisterDevices": "

Register devices.

", "RenderUiTemplate": "

Renders the UI template so that you can preview the worker's experience.

", "RetryPipelineExecution": "

Retry the execution of the pipeline.

", @@ -212,6 +220,7 @@ "StopCompilationJob": "

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

", "StopEdgePackagingJob": "

Request to stop an edge packaging job.

", "StopHyperParameterTuningJob": "

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

", + "StopInferenceRecommendationsJob": "

Stops an Inference Recommender job.

", "StopLabelingJob": "

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

", "StopMonitoringSchedule": "

Stops a previously started monitoring schedule.

", "StopNotebookInstance": "

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

", @@ -326,6 +335,21 @@ "UpdateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

" } }, + "AdditionalInferenceSpecificationDefinition": { + "base": "

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

", + "refs": { + "AdditionalInferenceSpecifications$member": null + } + }, + "AdditionalInferenceSpecifications": { + "base": null, + "refs": { + "CreateModelPackageInput$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

", + "DescribeModelPackageOutput$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

", + "ModelPackage$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects.

", + "UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd": "

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" + } + }, "AgentVersion": { "base": "

Edge Manager agent version.

", "refs": { @@ -677,6 +701,7 @@ "refs": { "AddAssociationRequest$AssociationType": "

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

", "AssociationSummary$AssociationType": "

The type of the association.

", + "Edge$AssociationType": "

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

", "ListAssociationsRequest$AssociationType": "

A filter that returns only associations of the specified type.

" } }, @@ -693,8 +718,12 @@ "DeleteAssociationRequest$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", "DeleteAssociationResponse$SourceArn": "

The ARN of the source.

", "DeleteAssociationResponse$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", + "Edge$SourceArn": "

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

", + "Edge$DestinationArn": "

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

", "ListAssociationsRequest$SourceArn": "

A filter that returns only associations with the specified source ARN.

", - "ListAssociationsRequest$DestinationArn": "

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

" + "ListAssociationsRequest$DestinationArn": "

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

", + "QueryLineageStartArns$member": null, + "Vertex$Arn": "

The Amazon Resource Name (ARN) of the lineage entity resource.

" } }, "AssociationSummaries": { @@ -1099,6 +1128,8 @@ "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", "AutoMLSecurityConfig$EnableInterContainerTrafficEncryption": "

Whether to use traffic encryption between the container layers.

", "ChannelSpecification$IsRequired": "

Indicates whether the channel is required by the algorithm.

", + "ClarifyCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", + "ClarifyCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

", "CreateModelInput$EnableNetworkIsolation": "

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", "CreateTrainingJobRequest$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", "CreateTrainingJobRequest$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

", @@ -1118,6 +1149,9 @@ "NetworkConfig$EnableNetworkIsolation": "

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

", "OfflineStoreConfig$DisableGlueTableCreation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore.

", "OnlineStoreConfig$EnableOnlineStore": "

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

", + "QualityCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", + "QualityCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

", + "QueryLineageRequest$IncludeEdges": "

Setting this value to True will retrieve not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

", "TrainingJob$EnableNetworkIsolation": "

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

", "TrainingJob$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", "TrainingJob$EnableManagedSpotTraining": "

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

", @@ -1275,6 +1309,12 @@ "DataCatalogConfig$Catalog": "

The name of the Glue table catalog.

" } }, + "CategoricalParameter": { + "base": "

Environment parameters you want to benchmark your load test against.

", + "refs": { + "CategoricalParameters$member": null + } + }, "CategoricalParameterRange": { "base": "

A list of categorical hyperparameters to tune.

", "refs": { @@ -1287,12 +1327,24 @@ "ParameterRange$CategoricalParameterRangeSpecification": "

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

" } }, + "CategoricalParameterRangeValues": { + "base": null, + "refs": { + "CategoricalParameter$Value": "

The list of values you can pass.

" + } + }, "CategoricalParameterRanges": { "base": null, "refs": { "ParameterRanges$CategoricalParameterRanges": "

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

" } }, + "CategoricalParameters": { + "base": null, + "refs": { + "EnvironmentParameterRanges$CategoricalParameterRanges": "

Specified a list of parameters for each category.

" + } + }, "Cents": { "base": null, "refs": { @@ -1355,6 +1407,12 @@ "SourceIpConfig$Cidrs": "

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

" } }, + "ClarifyCheckStepMetadata": { + "base": "

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

", + "refs": { + "PipelineExecutionStepMetadata$ClarifyCheck": "

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

" + } + }, "ClientId": { "base": null, "refs": { @@ -1649,6 +1707,7 @@ "ContentDigest": { "base": null, "refs": { + "FileSource$ContentDigest": "

The digest of the file source.

", "MetricsSource$ContentDigest": "

" } }, @@ -1657,6 +1716,7 @@ "refs": { "Channel$ContentType": "

The MIME type of the data.

", "ContentTypes$member": null, + "FileSource$ContentType": "

The type of content stored in the file source.

", "MetricsSource$ContentType": "

", "TransformInput$ContentType": "

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

" } @@ -1664,6 +1724,7 @@ "ContentTypes": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$SupportedContentTypes": "

The supported MIME types for the input data.

", "ChannelSpecification$SupportedContentTypes": "

The supported MIME types for the data.

", "InferenceSpecification$SupportedContentTypes": "

The supported MIME types for the input data.

" } @@ -1926,6 +1987,16 @@ "refs": { } }, + "CreateInferenceRecommendationsJobRequest": { + "base": null, + "refs": { + } + }, + "CreateInferenceRecommendationsJobResponse": { + "base": null, + "refs": { + } + }, "CreateLabelingJobRequest": { "base": null, "refs": { @@ -2170,6 +2241,7 @@ "DescribeCompilationJobResponse$CreationTime": "

The time that the model compilation job was created.

", "DescribeDomainResponse$CreationTime": "

The creation time.

", "DescribeFeatureGroupResponse$CreationTime": "

A timestamp indicating when SageMaker created the FeatureGroup.

", + "DescribeInferenceRecommendationsJobResponse$CreationTime": "

A timestamp that shows when the job was created.

", "DescribeModelPackageGroupOutput$CreationTime": "

The time that the model group was created.

", "DescribeModelPackageOutput$CreationTime": "

A timestamp specifying when the model package was created.

", "DescribeNotebookInstanceLifecycleConfigOutput$CreationTime": "

A timestamp that tells when the lifecycle configuration was created.

", @@ -2177,6 +2249,7 @@ "DescribeUserProfileResponse$CreationTime": "

The creation time.

", "DomainDetails$CreationTime": "

The creation time.

", "FeatureGroup$CreationTime": "

The time a FeatureGroup was created.

", + "InferenceRecommendationsJob$CreationTime": "

A timestamp that shows when the job was created.

", "ListAlgorithmsInput$CreationTimeAfter": "

A filter that returns only algorithms created after the specified time (timestamp).

", "ListAlgorithmsInput$CreationTimeBefore": "

A filter that returns only algorithms created before the specified time (timestamp).

", "ListCodeRepositoriesInput$CreationTimeAfter": "

A filter that returns only Git repositories that were created after the specified time.

", @@ -2185,6 +2258,8 @@ "ListCompilationJobsRequest$CreationTimeBefore": "

A filter that returns the model compilation jobs that were created before a specified time.

", "ListFeatureGroupsRequest$CreationTimeAfter": "

Use this parameter to search for FeatureGroupss created after a specific date and time.

", "ListFeatureGroupsRequest$CreationTimeBefore": "

Use this parameter to search for FeatureGroupss created before a specific date and time.

", + "ListInferenceRecommendationsJobsRequest$CreationTimeAfter": "

A filter that returns only jobs created after the specified time (timestamp).

", + "ListInferenceRecommendationsJobsRequest$CreationTimeBefore": "

A filter that returns only jobs created before the specified time (timestamp).

", "ListModelPackageGroupsInput$CreationTimeAfter": "

A filter that returns only model groups created after the specified time.

", "ListModelPackageGroupsInput$CreationTimeBefore": "

A filter that returns only model groups created before the specified time.

", "ListModelPackagesInput$CreationTimeAfter": "

A filter that returns only model packages created after the specified time (timestamp).

", @@ -2289,7 +2364,8 @@ "DataInputConfig": { "base": null, "refs": { - "InputConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):

CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

" + "InputConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):

CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

", + "ModelInput$DataInputConfig": "

The input configuration object for the model.

" } }, "DataProcessing": { @@ -2907,6 +2983,16 @@ "refs": { } }, + "DescribeInferenceRecommendationsJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeInferenceRecommendationsJobResponse": { + "base": null, + "refs": { + } + }, "DescribeLabelingJobRequest": { "base": null, "refs": { @@ -2917,6 +3003,16 @@ "refs": { } }, + "DescribeLineageGroupRequest": { + "base": null, + "refs": { + } + }, + "DescribeLineageGroupResponse": { + "base": null, + "refs": { + } + }, "DescribeModelBiasJobDefinitionRequest": { "base": null, "refs": { @@ -3283,6 +3379,12 @@ "DescribeNotebookInstanceOutput$DirectInternetAccess": "

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

" } }, + "Direction": { + "base": null, + "refs": { + "QueryLineageRequest$Direction": "

Associations between lineage entities are directed. This parameter determines the direction from the StartArn(s) the query will look.

" + } + }, "DirectoryPath": { "base": null, "refs": { @@ -3435,6 +3537,44 @@ "TrialComponentParameterValue$NumberValue": "

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

" } }, + "DriftCheckBaselines": { + "base": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.

", + "refs": { + "CreateModelPackageInput$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

", + "DescribeModelPackageOutput$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

", + "ModelPackage$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.

" + } + }, + "DriftCheckBias": { + "base": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

", + "refs": { + "DriftCheckBaselines$Bias": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

" + } + }, + "DriftCheckExplainability": { + "base": "

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

", + "refs": { + "DriftCheckBaselines$Explainability": "

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

" + } + }, + "DriftCheckModelDataQuality": { + "base": "

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

", + "refs": { + "DriftCheckBaselines$ModelDataQuality": "

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

" + } + }, + "DriftCheckModelQuality": { + "base": "

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

", + "refs": { + "DriftCheckBaselines$ModelQuality": "

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

" + } + }, + "Edge": { + "base": "

A directed edge connecting two lineage entities.

", + "refs": { + "Edges$member": null + } + }, "EdgeModel": { "base": "

The model on the edge device.

", "refs": { @@ -3548,6 +3688,12 @@ "EdgePackagingJobSummary$ModelVersion": "

The version of the model.

" } }, + "Edges": { + "base": null, + "refs": { + "QueryLineageResponse$Edges": "

A list of edges that connect vertices in the response.

" + } + }, "EfsUid": { "base": null, "refs": { @@ -3652,6 +3798,18 @@ "MonitoringInput$EndpointInput": "

The endpoint for a monitoring job.

" } }, + "EndpointInputConfiguration": { + "base": "

The endpoint configuration for the load test.

", + "refs": { + "EndpointInputConfigurations$member": null + } + }, + "EndpointInputConfigurations": { + "base": null, + "refs": { + "RecommendationJobInputConfig$EndpointConfigurations": "

Specifies the endpoint configuration to use for a job.

" + } + }, "EndpointName": { "base": null, "refs": { @@ -3685,6 +3843,12 @@ "ListEndpointsInput$NameContains": "

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

" } }, + "EndpointOutputConfiguration": { + "base": "

The endpoint configuration made by Inference Recommender during a recommendation job.

", + "refs": { + "InferenceRecommendation$EndpointConfiguration": "

Defines the endpoint configuration parameters.

" + } + }, "EndpointSortKey": { "base": null, "refs": { @@ -3715,6 +3879,7 @@ "EntityDescription": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$Description": "

A description of the additional Inference specification

", "AlgorithmSummary$AlgorithmDescription": "

A brief description of the algorithm.

", "BatchDescribeModelPackageSummary$ModelPackageDescription": "

The description of the model package.

", "ChannelSpecification$Description": "

A brief description of the channel.

", @@ -3739,6 +3904,7 @@ "EntityName": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$Name": "

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

", "AlgorithmStatusItem$Name": "

The name of the algorithm for which the overall status is being reported.

", "AlgorithmSummary$AlgorithmName": "

The name of the algorithm that is described by the summary.

", "AlgorithmValidationProfile$ProfileName": "

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

", @@ -3822,6 +3988,24 @@ "ModelPackageContainerDefinition$Environment": "

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

" } }, + "EnvironmentParameter": { + "base": "

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

", + "refs": { + "EnvironmentParameters$member": null + } + }, + "EnvironmentParameterRanges": { + "base": "

Specifies the range of environment parameters

", + "refs": { + "EndpointInputConfiguration$EnvironmentParameterRanges": "

The parameter you want to benchmark against.

" + } + }, + "EnvironmentParameters": { + "base": null, + "refs": { + "ModelConfiguration$EnvironmentParameters": "

Defines the environment parameters that includes key, value types, and values.

" + } + }, "EnvironmentValue": { "base": null, "refs": { @@ -3883,6 +4067,7 @@ "DescribeActionResponse$Description": "

The description of the action.

", "DescribeContextResponse$Description": "

The description of the context.

", "DescribeExperimentResponse$Description": "

The description of the experiment.

", + "DescribeLineageGroupResponse$Description": "

The description of the lineage group.

", "Experiment$Description": "

The description of the experiment.

", "UpdateActionRequest$Description": "

The new description for the action.

", "UpdateContextRequest$Description": "

The new description for the context.

", @@ -3915,14 +4100,13 @@ "DeleteTrialComponentRequest$TrialComponentName": "

The name of the component to delete.

", "DeleteTrialRequest$TrialName": "

The name of the trial to delete.

", "DescribeActionRequest$ActionName": "

The name of the action to describe.

", - "DescribeActionResponse$ActionName": "

The name of the action.

", - "DescribeArtifactResponse$ArtifactName": "

The name of the artifact.

", - "DescribeContextRequest$ContextName": "

The name of the context to describe.

", "DescribeContextResponse$ContextName": "

The name of the context.

", "DescribeExperimentRequest$ExperimentName": "

The name of the experiment to describe.

", "DescribeExperimentResponse$ExperimentName": "

The name of the experiment.

", "DescribeExperimentResponse$DisplayName": "

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

", - "DescribeTrialComponentRequest$TrialComponentName": "

The name of the trial component to describe.

", + "DescribeLineageGroupRequest$LineageGroupName": "

The name of the lineage group.

", + "DescribeLineageGroupResponse$LineageGroupName": "

The name of the lineage group.

", + "DescribeLineageGroupResponse$DisplayName": "

The display name of the lineage group.

", "DescribeTrialComponentResponse$TrialComponentName": "

The name of the trial component.

", "DescribeTrialComponentResponse$DisplayName": "

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

", "DescribeTrialRequest$TrialName": "

The name of the trial to describe.

", @@ -3938,6 +4122,8 @@ "ExperimentConfig$TrialComponentDisplayName": "

The display name for the trial component. If this key isn't specified, the display name is the trial component name.

", "ExperimentSummary$ExperimentName": "

The name of the experiment.

", "ExperimentSummary$DisplayName": "

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

", + "LineageGroupSummary$LineageGroupName": "

The name or Amazon Resource Name (ARN) of the lineage group.

", + "LineageGroupSummary$DisplayName": "

The display name of the lineage group summary.

", "ListTrialComponentsRequest$ExperimentName": "

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

", "ListTrialComponentsRequest$TrialName": "

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

", "ListTrialsRequest$ExperimentName": "

A filter that returns only trials that are part of the specified experiment.

", @@ -3967,6 +4153,15 @@ "UpdateTrialRequest$DisplayName": "

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

" } }, + "ExperimentEntityNameOrArn": { + "base": null, + "refs": { + "DescribeActionResponse$ActionName": "

The name of the action.

", + "DescribeArtifactResponse$ArtifactName": "

The name of the artifact.

", + "DescribeContextRequest$ContextName": "

The name of the context to describe.

", + "DescribeTrialComponentRequest$TrialComponentName": "

The name of the trial component to describe.

" + } + }, "ExperimentSource": { "base": "

The source of the experiment.

", "refs": { @@ -4024,6 +4219,7 @@ "DescribeHyperParameterTuningJobResponse$FailureReason": "

If the tuning job failed, the reason it failed.

", "DescribeImageResponse$FailureReason": "

When a create, update, or delete operation fails, the reason for the failure.

", "DescribeImageVersionResponse$FailureReason": "

When a create or delete operation fails, the reason for the failure.

", + "DescribeInferenceRecommendationsJobResponse$FailureReason": "

If the job fails, provides information why the job failed.

", "DescribeLabelingJobResponse$FailureReason": "

If the job failed, the reason that it failed.

", "DescribeMonitoringScheduleResponse$FailureReason": "

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

", "DescribeNotebookInstanceOutput$FailureReason": "

If status is Failed, the reason it failed.

", @@ -4037,6 +4233,7 @@ "HyperParameterTrainingJobSummary$FailureReason": "

The reason that the training job failed.

", "Image$FailureReason": "

When a create, update, or delete operation fails, the reason for the failure.

", "ImageVersion$FailureReason": "

When a create or delete operation fails, the reason for the failure.

", + "InferenceRecommendationsJob$FailureReason": "

If the job fails, provides information why the job failed.

", "LabelingJobSummary$FailureReason": "

If the LabelingJobStatus field is Failed, this field contains a description of the error.

", "MonitoringExecutionSummary$FailureReason": "

Contains the reason a monitoring job failed, if it failed.

", "MonitoringSchedule$FailureReason": "

If the monitoring schedule failed, the reason it failed.

", @@ -4155,6 +4352,13 @@ "FeatureDefinition$FeatureType": "

The value type of a feature. Valid values are Integral, Fractional, or String.

" } }, + "FileSource": { + "base": "

Contains details regarding the file source.

", + "refs": { + "DriftCheckBias$ConfigFile": "

The bias config file for a model.

", + "DriftCheckExplainability$ConfigFile": "

The explainability config file for the model.

" + } + }, "FileSystemAccessMode": { "base": null, "refs": { @@ -4227,7 +4431,9 @@ "base": null, "refs": { "MetricData$Value": "

The value of the metric.

", - "MetricDatum$Value": "

The value of the metric.

" + "MetricDatum$Value": "

The value of the metric.

", + "RecommendationMetrics$CostPerHour": "

Defines the cost per hour for the instance.

", + "RecommendationMetrics$CostPerInference": "

Defines the cost per inference for the instance .

" } }, "FlowDefinitionArn": { @@ -4325,7 +4531,8 @@ "FrameworkVersion": { "base": null, "refs": { - "InputConfig$FrameworkVersion": "

Specifies the framework version to use.

This API field is only supported for PyTorch framework versions 1.4, 1.5, and 1.6 for cloud instance target devices: ml_c4, ml_c5, ml_m4, ml_m5, ml_p2, ml_p3, and ml_g4dn.

" + "InputConfig$FrameworkVersion": "

Specifies the framework version to use.

This API field is only supported for PyTorch framework versions 1.4, 1.5, and 1.6 for cloud instance target devices: ml_c4, ml_c5, ml_m4, ml_m5, ml_p2, ml_p3, and ml_g4dn.

", + "ModelPackageContainerDefinition$FrameworkVersion": "

The framework version of the Model Package Container Image.

" } }, "GenerateCandidateDefinitionsOnly": { @@ -4345,6 +4552,16 @@ "refs": { } }, + "GetLineageGroupPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetLineageGroupPolicyResponse": { + "base": null, + "refs": { + } + }, "GetModelPackageGroupPolicyInput": { "base": null, "refs": { @@ -4888,6 +5105,30 @@ "DescribeCompilationJobResponse$InferenceImage": "

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

" } }, + "InferenceRecommendation": { + "base": "

A list of recommendations made by Amazon SageMaker Inference Recommender.

", + "refs": { + "InferenceRecommendations$member": null + } + }, + "InferenceRecommendations": { + "base": null, + "refs": { + "DescribeInferenceRecommendationsJobResponse$InferenceRecommendations": "

The recommendations made by Inference Recommender.

" + } + }, + "InferenceRecommendationsJob": { + "base": "

A structure that contains a list of recommendation jobs.

", + "refs": { + "InferenceRecommendationsJobs$member": null + } + }, + "InferenceRecommendationsJobs": { + "base": null, + "refs": { + "ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs": "

The recommendations created from the Amazon SageMaker Inference Recommender job.

" + } + }, "InferenceSpecification": { "base": "

Defines how to perform inference generation after a training job is run.

", "refs": { @@ -4899,6 +5140,20 @@ "ModelPackage$InferenceSpecification": null } }, + "InferenceSpecificationName": { + "base": null, + "refs": { + "ContainerDefinition$InferenceSpecificationName": "

The inference specification name in the model package version.

", + "EndpointInputConfiguration$InferenceSpecificationName": "

The inference specification name in the model package version.

", + "ModelConfiguration$InferenceSpecificationName": "

The inference specification name in the model package version.

" + } + }, + "InitialNumberOfUsers": { + "base": null, + "refs": { + "Phase$InitialNumberOfUsers": "

Specifies how many concurrent users to start with.

" + } + }, "InitialTaskCount": { "base": null, "refs": { @@ -4946,7 +5201,12 @@ "Integer": { "base": null, "refs": { - "DescribeDeviceResponse$MaxModels": "

The maximum number of models.

" + "DescribeDeviceResponse$MaxModels": "

The maximum number of models.

", + "EndpointOutputConfiguration$InitialInstanceCount": "

The number of instances recommended to launch initially.

", + "ModelLatencyThreshold$ValueInMilliseconds": "

The model latency percentile value in milliseconds.

", + "RecommendationJobStoppingConditions$MaxInvocations": "

The maximum number of requests per minute expected for the endpoint.

", + "RecommendationMetrics$MaxInvocations": "

The expected maximum number of requests per minute for the instance.

", + "RecommendationMetrics$ModelLatency": "

The expected model latency at maximum invocation per minute for the instance.

" } }, "IntegerParameterRange": { @@ -4985,6 +5245,12 @@ "DescribeDeviceFleetResponse$IotRoleAlias": "

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

" } }, + "JobDurationInSeconds": { + "base": null, + "refs": { + "RecommendationJobInputConfig$JobDurationInSeconds": "

Specifies the maximum duration of the job, in seconds.>

" + } + }, "JobReferenceCode": { "base": null, "refs": { @@ -5290,12 +5556,16 @@ "DescribeCodeRepositoryOutput$LastModifiedTime": "

The date and time that the repository was last changed.

", "DescribeCompilationJobResponse$LastModifiedTime": "

The time that the status of the model compilation job was last modified.

", "DescribeDomainResponse$LastModifiedTime": "

The last modified time.

", + "DescribeInferenceRecommendationsJobResponse$LastModifiedTime": "

A timestamp that shows when the job was last modified.

", "DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime": "

A timestamp that tells when the lifecycle configuration was last modified.

", "DescribeNotebookInstanceOutput$LastModifiedTime": "

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

", "DescribeUserProfileResponse$LastModifiedTime": "

The last modified time.

", "DomainDetails$LastModifiedTime": "

The last modified time.

", + "InferenceRecommendationsJob$LastModifiedTime": "

A timestamp that shows when the job was last modified.

", "ListCompilationJobsRequest$LastModifiedTimeAfter": "

A filter that returns the model compilation jobs that were modified after a specified time.

", "ListCompilationJobsRequest$LastModifiedTimeBefore": "

A filter that returns the model compilation jobs that were modified before a specified time.

", + "ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter": "

A filter that returns only jobs that were last modified after the specified time (timestamp).

", + "ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore": "

A filter that returns only jobs that were last modified before the specified time (timestamp).

", "ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore": "

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

", "ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter": "

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

", "ListNotebookInstancesInput$LastModifiedTimeBefore": "

A filter that returns only notebook instances that were modified before the specified time (timestamp).

", @@ -5326,6 +5596,44 @@ "UpdateContextRequest$Properties": "

The new list of properties. Overwrites the current property list.

" } }, + "LineageGroupArn": { + "base": null, + "refs": { + "DescribeActionResponse$LineageGroupArn": "

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

", + "DescribeArtifactResponse$LineageGroupArn": "

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

", + "DescribeContextResponse$LineageGroupArn": "

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

", + "DescribeLineageGroupResponse$LineageGroupArn": "

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

", + "DescribeTrialComponentResponse$LineageGroupArn": "

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

", + "GetLineageGroupPolicyResponse$LineageGroupArn": "

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

", + "LineageGroupSummary$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group resource.

", + "TrialComponent$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group resource.

" + } + }, + "LineageGroupNameOrArn": { + "base": null, + "refs": { + "GetLineageGroupPolicyRequest$LineageGroupName": "

The name or Amazon Resource Name (ARN) of the lineage group.

" + } + }, + "LineageGroupSummaries": { + "base": null, + "refs": { + "ListLineageGroupsResponse$LineageGroupSummaries": "

A list of lineage groups and their properties.

" + } + }, + "LineageGroupSummary": { + "base": "

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

", + "refs": { + "LineageGroupSummaries$member": null + } + }, + "LineageType": { + "base": null, + "refs": { + "QueryLineageTypes$member": null, + "Vertex$LineageType": "

The type of resource of the lineage entity.

" + } + }, "ListActionsRequest": { "base": null, "refs": { @@ -5594,6 +5902,22 @@ "refs": { } }, + "ListInferenceRecommendationsJobsRequest": { + "base": null, + "refs": { + } + }, + "ListInferenceRecommendationsJobsResponse": { + "base": null, + "refs": { + } + }, + "ListInferenceRecommendationsJobsSortBy": { + "base": null, + "refs": { + "ListInferenceRecommendationsJobsRequest$SortBy": "

The parameter by which to sort the results.

" + } + }, "ListLabelingJobsForWorkteamRequest": { "base": null, "refs": { @@ -5628,6 +5952,16 @@ "UpdateContextRequest$PropertiesToRemove": "

A list of properties to remove.

" } }, + "ListLineageGroupsRequest": { + "base": null, + "refs": { + } + }, + "ListLineageGroupsResponse": { + "base": null, + "refs": { + } + }, "ListMaxResults": { "base": null, "refs": { @@ -5656,6 +5990,16 @@ "refs": { } }, + "ListModelMetadataRequest": { + "base": null, + "refs": { + } + }, + "ListModelMetadataResponse": { + "base": null, + "refs": { + } + }, "ListModelPackageGroupsInput": { "base": null, "refs": { @@ -5983,12 +6327,24 @@ "LabelingJobStoppingConditions$MaxHumanLabeledObjectCount": "

The maximum number of objects that can be labeled by human workers.

" } }, + "MaxNumberOfTests": { + "base": null, + "refs": { + "RecommendationJobResourceLimit$MaxNumberOfTests": "

Defines the maximum number of load tests.

" + } + }, "MaxNumberOfTrainingJobs": { "base": null, "refs": { "ResourceLimits$MaxNumberOfTrainingJobs": "

The maximum number of training jobs that a hyperparameter tuning job can launch.

" } }, + "MaxParallelOfTests": { + "base": null, + "refs": { + "RecommendationJobResourceLimit$MaxParallelOfTests": "

Defines the maximum number of parallel load tests.

" + } + }, "MaxParallelTrainingJobs": { "base": null, "refs": { @@ -6032,10 +6388,13 @@ "ListHyperParameterTuningJobsRequest$MaxResults": "

The maximum number of tuning jobs to return. The default value is 10.

", "ListImageVersionsRequest$MaxResults": "

The maximum number of versions to return in the response. The default value is 10.

", "ListImagesRequest$MaxResults": "

The maximum number of images to return in the response. The default value is 10.

", + "ListInferenceRecommendationsJobsRequest$MaxResults": "

The maximum number of recommendations to return in the response.

", "ListLabelingJobsForWorkteamRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", "ListLabelingJobsRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", + "ListLineageGroupsRequest$MaxResults": "

The maximum number of endpoints to return in the response. This value defaults to 10.

", "ListModelBiasJobDefinitionsRequest$MaxResults": "

The maximum number of model bias jobs to return in the response. The default value is 10.

", "ListModelExplainabilityJobDefinitionsRequest$MaxResults": "

The maximum number of jobs to return in the response. The default value is 10.

", + "ListModelMetadataRequest$MaxResults": "

The maximum number of models to return in the response.

", "ListModelPackageGroupsInput$MaxResults": "

The maximum number of results to return in the response.

", "ListModelPackagesInput$MaxResults": "

The maximum number of model packages to return in the response.

", "ListModelQualityJobDefinitionsRequest$MaxResults": "

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

", @@ -6205,6 +6564,15 @@ "base": "

", "refs": { "Bias$Report": "

The bias report for a model

", + "Bias$PreTrainingReport": null, + "Bias$PostTrainingReport": null, + "DriftCheckBias$PreTrainingConstraints": null, + "DriftCheckBias$PostTrainingConstraints": null, + "DriftCheckExplainability$Constraints": null, + "DriftCheckModelDataQuality$Statistics": null, + "DriftCheckModelDataQuality$Constraints": null, + "DriftCheckModelQuality$Statistics": null, + "DriftCheckModelQuality$Constraints": null, "Explainability$Report": "

The explainability report for a model.

", "ModelDataQuality$Statistics": "

Data quality statistics for a model.

", "ModelDataQuality$Constraints": "

Data quality constraints for a model.

", @@ -6277,6 +6645,12 @@ "TransformJob$ModelClientConfig": null } }, + "ModelConfiguration": { + "base": "

Defines the model configuration. Includes the specification name and environment parameters.

", + "refs": { + "InferenceRecommendation$ModelConfiguration": "

Defines the model configuration.

" + } + }, "ModelDataQuality": { "base": "

Data quality constraints and statistics for a model.

", "refs": { @@ -6323,6 +6697,60 @@ "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput": "

Inputs for the model explainability job.

" } }, + "ModelInput": { + "base": "

Input object for the model.

", + "refs": { + "ModelPackageContainerDefinition$ModelInput": "

A structure with Model Input details.

" + } + }, + "ModelLatencyThreshold": { + "base": "

The model latency threshold.

", + "refs": { + "ModelLatencyThresholds$member": null + } + }, + "ModelLatencyThresholds": { + "base": null, + "refs": { + "RecommendationJobStoppingConditions$ModelLatencyThresholds": "

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

" + } + }, + "ModelMetadataFilter": { + "base": "

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

", + "refs": { + "ModelMetadataFilters$member": null + } + }, + "ModelMetadataFilterType": { + "base": null, + "refs": { + "ModelMetadataFilter$Name": "

The name of the of the model to filter by.

" + } + }, + "ModelMetadataFilters": { + "base": null, + "refs": { + "ModelMetadataSearchExpression$Filters": "

A list of filter objects.

" + } + }, + "ModelMetadataSearchExpression": { + "base": "

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results

", + "refs": { + "ListModelMetadataRequest$SearchExpression": "

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

" + } + }, + "ModelMetadataSummaries": { + "base": null, + "refs": { + "ListModelMetadataResponse$ModelMetadataSummaries": "

A structure that holds model metadata.

" + } + }, + "ModelMetadataSummary": { + "base": "

A summary of the model metadata.

", + "refs": { + "ModelMetadataSummaries$member": null + } + }, "ModelMetrics": { "base": "

Contains metrics captured from a model.

", "refs": { @@ -6362,12 +6790,15 @@ "refs": { "BatchDescribeModelPackageErrorMap$key": null, "BatchDescribeModelPackageSummary$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", + "CreateCompilationJobRequest$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

", "CreateModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the new model package.

", + "DescribeCompilationJobResponse$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

", "DescribeModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", "ModelPackage$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", "ModelPackageArnList$member": null, "ModelPackageSummaries$key": null, "ModelPackageSummary$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", + "RecommendationJobInputConfig$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of a versioned model package.

", "UpdateModelPackageInput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", "UpdateModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model.

" } @@ -6387,6 +6818,7 @@ "ModelPackageContainerDefinitionList": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$Containers": "

The Amazon ECR registry path of the Docker image that contains the inference code.

", "InferenceSpecification$Containers": "

The Amazon ECR registry path of the Docker image that contains the inference code.

" } }, @@ -6934,6 +7366,7 @@ "ListEdgePackagingJobsRequest$NameContains": "

Filter for jobs containing this name in their packaging job name.

", "ListEdgePackagingJobsRequest$ModelNameContains": "

Filter for jobs where the model name contains this string.

", "ListHyperParameterTuningJobsRequest$NameContains": "

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

", + "ListInferenceRecommendationsJobsRequest$NameContains": "

A string in the job name. This filter returns only recommendations whose name contains the specified string.

", "ListLabelingJobsRequest$NameContains": "

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

", "ListModelBiasJobDefinitionsRequest$NameContains": "

Filter for model bias jobs whose name contains a specified string.

", "ListModelExplainabilityJobDefinitionsRequest$NameContains": "

Filter for model explainability jobs whose name contains a specified string.

", @@ -7056,14 +7489,20 @@ "ListImageVersionsResponse$NextToken": "

A token for getting the next set of versions, if there are any.

", "ListImagesRequest$NextToken": "

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

", "ListImagesResponse$NextToken": "

A token for getting the next set of images, if there are any.

", + "ListInferenceRecommendationsJobsRequest$NextToken": "

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

", + "ListInferenceRecommendationsJobsResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", "ListLabelingJobsForWorkteamRequest$NextToken": "

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", "ListLabelingJobsForWorkteamResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", "ListLabelingJobsRequest$NextToken": "

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", "ListLabelingJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", + "ListLineageGroupsRequest$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", + "ListLineageGroupsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", "ListModelBiasJobDefinitionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", "ListModelBiasJobDefinitionsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

", "ListModelExplainabilityJobDefinitionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", "ListModelExplainabilityJobDefinitionsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

", + "ListModelMetadataRequest$NextToken": "

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

", + "ListModelMetadataResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", "ListModelPackageGroupsInput$NextToken": "

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

", "ListModelPackageGroupsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

", "ListModelPackagesInput$NextToken": "

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

", @@ -7594,6 +8033,18 @@ "PendingDeploymentSummary$ProductionVariants": "

List of PendingProductionVariantSummary objects.

" } }, + "Phase": { + "base": "

Defines the traffic pattern.

", + "refs": { + "Phases$member": null + } + }, + "Phases": { + "base": null, + "refs": { + "TrafficPattern$Phases": "

Defines the phases traffic specification.

" + } + }, "Pipeline": { "base": "

A SageMaker Model Building Pipeline instance.

", "refs": { @@ -8076,6 +8527,8 @@ "ProductionVariantInstanceType": { "base": null, "refs": { + "EndpointInputConfiguration$InstanceType": "

The instance types to use for the load test.

", + "EndpointOutputConfiguration$InstanceType": "

The instance type recommended by Amazon SageMaker Inference Recommender.

", "PendingProductionVariantSummary$InstanceType": "

The type of instances associated with the variant.

", "ProductionVariant$InstanceType": "

The ML compute instance type.

", "RealtimeInferenceInstanceTypes$member": null @@ -8088,6 +8541,16 @@ "DescribeEndpointConfigOutput$ProductionVariants": "

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

" } }, + "ProductionVariantServerlessConfig": { + "base": "

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

Specifies the serverless configuration for an endpoint variant.

", + "refs": { + "PendingProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", + "PendingProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", + "ProductionVariant$ServerlessConfig": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", + "ProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", + "ProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for the endpoint update.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

" + } + }, "ProductionVariantStatus": { "base": "

Describes the status of the production variant.

", "refs": { @@ -8315,6 +8778,64 @@ "refs": { } }, + "QualityCheckStepMetadata": { + "base": "

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

", + "refs": { + "PipelineExecutionStepMetadata$QualityCheck": "

The configurations and outcomes of the check step execution. This includes:

" + } + }, + "QueryFilters": { + "base": "

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

", + "refs": { + "QueryLineageRequest$Filters": "

A set of filtering parameters that allow you to specify which entities should be returned.

" + } + }, + "QueryLineageMaxDepth": { + "base": null, + "refs": { + "QueryLineageRequest$MaxDepth": "

The maximum depth in lineage relationships from the StartArns that will be traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

" + } + }, + "QueryLineageMaxResults": { + "base": null, + "refs": { + "QueryLineageRequest$MaxResults": "

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

" + } + }, + "QueryLineageRequest": { + "base": null, + "refs": { + } + }, + "QueryLineageResponse": { + "base": null, + "refs": { + } + }, + "QueryLineageStartArns": { + "base": null, + "refs": { + "QueryLineageRequest$StartArns": "

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

" + } + }, + "QueryLineageTypes": { + "base": null, + "refs": { + "QueryFilters$LineageTypes": "

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

" + } + }, + "QueryProperties": { + "base": null, + "refs": { + "QueryFilters$Properties": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity will be included in the results if it matches any of the provided pairs.

" + } + }, + "QueryTypes": { + "base": null, + "refs": { + "QueryFilters$Types": "

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

" + } + }, "RSessionAppSettings": { "base": "

A collection of settings that apply to an RSessionGateway app.

", "refs": { @@ -8354,9 +8875,78 @@ "RealtimeInferenceInstanceTypes": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

", "InferenceSpecification$SupportedRealtimeInferenceInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

" } }, + "RecommendationJobArn": { + "base": null, + "refs": { + "CreateInferenceRecommendationsJobResponse$JobArn": "

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

", + "DescribeInferenceRecommendationsJobResponse$JobArn": "

The Amazon Resource Name (ARN) of the job.

", + "InferenceRecommendationsJob$JobArn": "

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

" + } + }, + "RecommendationJobDescription": { + "base": null, + "refs": { + "CreateInferenceRecommendationsJobRequest$JobDescription": "

Description of the recommendation job.

", + "DescribeInferenceRecommendationsJobResponse$JobDescription": "

The job description that you provided when you initiated the job.

", + "InferenceRecommendationsJob$JobDescription": "

The job description.

" + } + }, + "RecommendationJobInputConfig": { + "base": "

The input configuration of the recommendation job.

", + "refs": { + "CreateInferenceRecommendationsJobRequest$InputConfig": "

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

", + "DescribeInferenceRecommendationsJobResponse$InputConfig": "

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

" + } + }, + "RecommendationJobName": { + "base": null, + "refs": { + "CreateInferenceRecommendationsJobRequest$JobName": "

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

", + "DescribeInferenceRecommendationsJobRequest$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", + "DescribeInferenceRecommendationsJobResponse$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", + "InferenceRecommendationsJob$JobName": "

The name of the job.

", + "StopInferenceRecommendationsJobRequest$JobName": "

The name of the job you want to stop.

" + } + }, + "RecommendationJobResourceLimit": { + "base": "

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

", + "refs": { + "RecommendationJobInputConfig$ResourceLimit": "

Defines the resource limit of the job.

" + } + }, + "RecommendationJobStatus": { + "base": null, + "refs": { + "DescribeInferenceRecommendationsJobResponse$Status": "

The status of the job.

", + "InferenceRecommendationsJob$Status": "

The status of the job.

", + "ListInferenceRecommendationsJobsRequest$StatusEquals": "

A filter that retrieves only inference recommendations jobs with a specific status.

" + } + }, + "RecommendationJobStoppingConditions": { + "base": "

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

", + "refs": { + "CreateInferenceRecommendationsJobRequest$StoppingConditions": "

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

", + "DescribeInferenceRecommendationsJobResponse$StoppingConditions": "

The stopping conditions that you provided when you initiated the job.

" + } + }, + "RecommendationJobType": { + "base": null, + "refs": { + "CreateInferenceRecommendationsJobRequest$JobType": "

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

", + "DescribeInferenceRecommendationsJobResponse$JobType": "

The job type that you provided when you initiated the job.

", + "InferenceRecommendationsJob$JobType": "

The recommendation job type.

" + } + }, + "RecommendationMetrics": { + "base": "

The metrics of recommendations.

", + "refs": { + "InferenceRecommendation$Metrics": "

The metrics used to decide what recommendation to make.

" + } + }, "RecordWrapper": { "base": null, "refs": { @@ -8514,6 +9104,12 @@ "refs": { } }, + "ResourcePolicyString": { + "base": null, + "refs": { + "GetLineageGroupPolicyResponse$ResourcePolicy": "

The resource policy that gives access to the lineage group in another account.

" + } + }, "ResourcePropertyName": { "base": null, "refs": { @@ -8551,6 +9147,7 @@ "ResponseMIMETypes": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes": "

The supported MIME types for the output data.

", "InferenceSpecification$SupportedResponseMIMETypes": "

The supported MIME types for the output data.

" } }, @@ -8597,6 +9194,7 @@ "CreateFeatureGroupRequest$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

", "CreateFlowDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

", "CreateImageRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", + "CreateInferenceRecommendationsJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", "CreateLabelingJobRequest$RoleArn": "

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

", "CreateModelBiasJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", "CreateModelExplainabilityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", @@ -8614,6 +9212,7 @@ "DescribeFeatureGroupResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

", "DescribeFlowDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

", "DescribeImageResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", + "DescribeInferenceRecommendationsJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

", "DescribeLabelingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

", "DescribeModelBiasJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeModelExplainabilityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", @@ -8625,6 +9224,7 @@ "DescribeTrainingJobResponse$RoleArn": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

", "FeatureGroup$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

", "HyperParameterTrainingJobDefinition$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

", + "InferenceRecommendationsJob$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", "ModelPackageValidationSpecification$ValidationRole": "

The IAM roles to be used for the validation of the model package.

", "MonitoringJobDefinition$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", "Pipeline$RoleArn": "

The Amazon Resource Name (ARN) of the role that created the pipeline.

", @@ -8706,6 +9306,7 @@ "AutoMLS3DataSource$S3Uri": "

The URL to the Amazon S3 data source.

", "CheckpointConfig$S3Uri": "

Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

", "CreateLabelingJobRequest$LabelCategoryConfigS3Uri": "

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to \"labels\", you must provide worker instructions in the label category configuration file using the \"instructions\" parameter: \"instructions\": {\"shortInstruction\":\"<h1>Add header</h1><p>Add Instructions</p>\", \"fullInstruction\":\"<p>Add additional instructions.</p>\"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

\"document-version\": \"2018-11-28\",

\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]

}

Note the following about the label category configuration file:

", + "CreateModelPackageInput$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", "DataQualityAppSpecification$RecordPreprocessorSourceUri": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

", "DataQualityAppSpecification$PostAnalyticsProcessorSourceUri": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

", "DebugHookConfig$S3OutputPath": "

Path to Amazon S3 storage location for metrics and tensors.

", @@ -8713,6 +9314,7 @@ "DescribeEdgePackagingJobResponse$ModelArtifact": "

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

", "DescribeLabelingJobResponse$LabelCategoryConfigS3Uri": "

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

The file is a JSON structure in the following format:

{

\"document-version\": \"2018-11-28\"

\"labels\": [

{

\"label\": \"label 1\"

},

{

\"label\": \"label 2\"

},

...

{

\"label\": \"label n\"

}

]

}

", "EdgeOutputConfig$S3OutputLocation": "

The Amazon Simple Storage (S3) bucker URI.

", + "FileSource$S3Uri": "

The Amazon S3 URI for the file source.

", "FlowDefinitionOutputConfig$S3OutputPath": "

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

", "InputConfig$S3Uri": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", "LabelingJobOutput$OutputDatasetS3Uri": "

The Amazon S3 bucket location of the manifest file for labeled data.

", @@ -8892,6 +9494,18 @@ "refs": { } }, + "ServerlessMaxConcurrency": { + "base": null, + "refs": { + "ProductionVariantServerlessConfig$MaxConcurrency": "

The maximum number of concurrent invocations your serverless endpoint can process.

" + } + }, + "ServerlessMemorySizeInMB": { + "base": null, + "refs": { + "ProductionVariantServerlessConfig$MemorySizeInMB": "

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

" + } + }, "ServiceCatalogEntityId": { "base": null, "refs": { @@ -8997,6 +9611,12 @@ "ListExperimentsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" } }, + "SortLineageGroupsBy": { + "base": null, + "refs": { + "ListLineageGroupsRequest$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" + } + }, "SortOrder": { "base": null, "refs": { @@ -9015,8 +9635,10 @@ "ListFlowDefinitionsRequest$SortOrder": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

", "ListHumanTaskUisRequest$SortOrder": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

", "ListHyperParameterTuningJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", + "ListInferenceRecommendationsJobsRequest$SortOrder": "

The sort order for the results.

", "ListLabelingJobsForWorkteamRequest$SortOrder": "

The sort order for results. The default is Ascending.

", "ListLabelingJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", + "ListLineageGroupsRequest$SortOrder": "

The sort order for the results. The default is Ascending.

", "ListModelBiasJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", "ListModelExplainabilityJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", "ListModelPackageGroupsInput$SortOrder": "

The sort order for results. The default is Ascending.

", @@ -9107,6 +9729,12 @@ "ListContextsRequest$SourceUri": "

A filter that returns only contexts with the specified source URI.

" } }, + "SpawnRate": { + "base": null, + "refs": { + "Phase$SpawnRate": "

Specified how many new users to spawn in a minute.

" + } + }, "SplitType": { "base": null, "refs": { @@ -9178,6 +9806,11 @@ "refs": { } }, + "StopInferenceRecommendationsJobRequest": { + "base": null, + "refs": { + } + }, "StopLabelingJobRequest": { "base": null, "refs": { @@ -9236,14 +9869,34 @@ "AlgorithmStatusItem$FailureReason": "

if the overall status is Failed, the reason for the failure.

", "BatchDescribeModelPackageError$ErrorCode": "

", "BatchDescribeModelPackageError$ErrorResponse": "

", + "CreateModelPackageInput$Domain": "

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

", + "CreateModelPackageInput$Task": "

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

", "DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage": "

Returns a message describing the job status and error messages.

", "DescribeEdgePackagingJobResponse$ModelSignature": "

The signature document of files in the model artifact.

", + "DescribeModelPackageOutput$Domain": "

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

", + "DescribeModelPackageOutput$Task": "

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

", + "DescribeModelPackageOutput$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

", "EdgeOutputConfig$PresetDeploymentConfig": "

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

", "EdgePresetDeploymentOutput$StatusMessage": "

Returns a message describing the status of the deployed resource.

", "EndpointInput$FeaturesAttribute": "

The attributes of the input data that are the input features.

", "EndpointInput$InferenceAttribute": "

The attribute of the input data that represents the ground truth label.

", "EndpointInput$ProbabilityAttribute": "

In a classification problem, the attribute that represents the class probability.

", + "EndpointOutputConfiguration$EndpointName": "

The name of the endpoint made during a recommendation job.

", + "EndpointOutputConfiguration$VariantName": "

The name of the production variant (deployed model) made during a recommendation job.

", + "EnvironmentParameter$Key": "

The environment key suggested by the Amazon SageMaker Inference Recommender.

", + "EnvironmentParameter$ValueType": "

The value type suggested by the Amazon SageMaker Inference Recommender.

", + "EnvironmentParameter$Value": "

The value suggested by the Amazon SageMaker Inference Recommender.

", "ListProcessingJobsRequest$NameContains": "

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

", + "ModelMetadataSummary$Domain": "

The machine learning domain of the model.

", + "ModelMetadataSummary$Framework": "

The machine learning framework of the model.

", + "ModelMetadataSummary$Task": "

The machine learning task of the model.

", + "ModelMetadataSummary$Model": "

The name of the model.

", + "ModelMetadataSummary$FrameworkVersion": "

The framework version of the model.

", + "ModelPackage$Domain": "

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

", + "ModelPackage$Task": "

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

", + "ModelPackage$SamplePayloadUrl": "

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", + "ModelPackageContainerDefinition$Framework": "

The machine learning framework of the model package container image.

", + "ModelPackageContainerDefinition$NearestModelName": "

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

", "ModelPackageStatusItem$FailureReason": "

if the overall status is Failed, the reason for the failure.

", "ProcessingInput$InputName": "

The name for the processing job input.

", "ProcessingOutput$OutputName": "

The name for the processing job output.

", @@ -9265,11 +9918,25 @@ "String1024": { "base": null, "refs": { + "ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints": "

The Amazon S3 URI of baseline constraints file to be used for the drift check.

", + "ClarifyCheckStepMetadata$CalculatedBaselineConstraints": "

The Amazon S3 URI of the newly calculated baseline constraints file.

", + "ClarifyCheckStepMetadata$ViolationReport": "

The Amazon S3 URI of the violation report if violations are detected.

", "CreateDomainResponse$Url": "

The URL to the created domain.

", "DescribeDomainResponse$Url": "

The domain's URL.

", "DomainDetails$Url": "

The domain's URL.

", "OutputParameter$Value": "

The value of the output parameter.

", - "Parameter$Value": "

The literal value for the parameter.

" + "Parameter$Value": "

The literal value for the parameter.

", + "QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics": "

The Amazon S3 URI of the baseline statistics file used for the drift check.

", + "QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints": "

The Amazon S3 URI of the baseline constraints file used for the drift check.

", + "QualityCheckStepMetadata$CalculatedBaselineStatistics": "

The Amazon S3 URI of the newly calculated baseline statistics file.

", + "QualityCheckStepMetadata$CalculatedBaselineConstraints": "

The Amazon S3 URI of the newly calculated baseline constraints file.

", + "QualityCheckStepMetadata$ViolationReport": "

The Amazon S3 URI of violation report if violations are detected.

" + } + }, + "String128": { + "base": null, + "refs": { + "CategoricalParameterRangeValues$member": null } }, "String200": { @@ -9300,6 +9967,9 @@ "AssociationSummary$SourceType": "

The source type.

", "AssociationSummary$DestinationType": "

The destination type.

", "CallbackStepMetadata$SqsQueueUrl": "

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

", + "ClarifyCheckStepMetadata$CheckType": "

The type of the Clarify Check step

", + "ClarifyCheckStepMetadata$ModelPackageGroupName": "

The model package group name.

", + "ClarifyCheckStepMetadata$CheckJobArn": "

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

", "ContextSource$SourceType": "

The type of the source.

", "ContextSource$SourceId": "

The ID of the source.

", "ContextSummary$ContextType": "

The type of the context.

", @@ -9319,16 +9989,38 @@ "ListAssociationsRequest$DestinationType": "

A filter that returns only associations with the specified destination type.

", "ListContextsRequest$ContextType": "

A filter that returns only contexts of the specified type.

", "ListTrialComponentsRequest$SourceArn": "

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

", + "ModelMetadataFilter$Value": "

The value to filter the model metadata.

", "ModelStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the created model.

", "OutputParameter$Name": "

The name of the output parameter.

", + "QualityCheckStepMetadata$CheckType": "

The type of the Quality check step.

", + "QualityCheckStepMetadata$ModelPackageGroupName": "

The model package group name.

", + "QualityCheckStepMetadata$CheckJobArn": "

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

", + "QueryProperties$key": null, + "QueryProperties$value": null, "RegisterModelStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the model package.

", "SendPipelineExecutionStepFailureRequest$FailureReason": "

A message describing why the step failed.

" } }, + "String40": { + "base": null, + "refs": { + "QueryTypes$member": null, + "Vertex$Type": "

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

" + } + }, "String64": { "base": null, "refs": { - "ActionSummary$ActionType": "

The type of the action.

" + "ActionSummary$ActionType": "

The type of the action.

", + "CategoricalParameter$Name": "

The Name of the environment variable.

", + "ModelLatencyThreshold$Percentile": "

The model latency percentile threshold.

" + } + }, + "String8192": { + "base": null, + "refs": { + "QueryLineageRequest$NextToken": "

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

", + "QueryLineageResponse$NextToken": "

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

" } }, "StringParameterValue": { @@ -9487,6 +10179,7 @@ "CreateHumanTaskUiRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

", "CreateHyperParameterTuningJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

", "CreateImageRequest$Tags": "

A list of tags to apply to the image.

", + "CreateInferenceRecommendationsJobRequest$Tags": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

", "CreateLabelingJobRequest$Tags": "

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", "CreateModelBiasJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", "CreateModelExplainabilityJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", @@ -9581,7 +10274,7 @@ "TaskAvailabilityLifetimeInSeconds": { "base": null, "refs": { - "HumanTaskConfig$TaskAvailabilityLifetimeInSeconds": "

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

" + "HumanTaskConfig$TaskAvailabilityLifetimeInSeconds": "

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

" } }, "TaskCount": { @@ -9621,7 +10314,7 @@ "TaskTimeLimitInSeconds": { "base": null, "refs": { - "HumanTaskConfig$TaskTimeLimitInSeconds": "

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

" + "HumanTaskConfig$TaskTimeLimitInSeconds": "

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

" } }, "TaskTitle": { @@ -9742,8 +10435,11 @@ "DescribeImageResponse$LastModifiedTime": "

When the image was last modified.

", "DescribeImageVersionResponse$CreationTime": "

When the version was created.

", "DescribeImageVersionResponse$LastModifiedTime": "

When the version was last modified.

", + "DescribeInferenceRecommendationsJobResponse$CompletionTime": "

A timestamp that shows when the job completed.

", "DescribeLabelingJobResponse$CreationTime": "

The date and time that the labeling job was created.

", "DescribeLabelingJobResponse$LastModifiedTime": "

The date and time that the labeling job was last updated.

", + "DescribeLineageGroupResponse$CreationTime": "

The creation time of lineage group.

", + "DescribeLineageGroupResponse$LastModifiedTime": "

The last modified time of the lineage group.

", "DescribeModelBiasJobDefinitionResponse$CreationTime": "

The time at which the model bias job was created.

", "DescribeModelExplainabilityJobDefinitionResponse$CreationTime": "

The time at which the model explainability job was created.

", "DescribeModelOutput$CreationTime": "

A timestamp that shows when the model was created.

", @@ -9809,9 +10505,12 @@ "Image$LastModifiedTime": "

When the image was last modified.

", "ImageVersion$CreationTime": "

When the version was created.

", "ImageVersion$LastModifiedTime": "

When the version was last modified.

", + "InferenceRecommendationsJob$CompletionTime": "

A timestamp that shows when the job completed.

", "LabelingJobForWorkteamSummary$CreationTime": "

The date and time that the labeling job was created.

", "LabelingJobSummary$CreationTime": "

The date and time that the job was created (timestamp).

", "LabelingJobSummary$LastModifiedTime": "

The date and time that the job was last modified (timestamp).

", + "LineageGroupSummary$CreationTime": "

The creation time of the lineage group summary.

", + "LineageGroupSummary$LastModifiedTime": "

The last modified time of the lineage group summary.

", "ListActionsRequest$CreatedAfter": "

A filter that returns only actions created on or after the specified time.

", "ListActionsRequest$CreatedBefore": "

A filter that returns only actions created on or before the specified time.

", "ListAppImageConfigsRequest$CreationTimeBefore": "

A filter that returns only AppImageConfigs created on or before the specified time.

", @@ -9871,6 +10570,8 @@ "ListLabelingJobsRequest$CreationTimeBefore": "

A filter that returns only labeling jobs created before the specified time (timestamp).

", "ListLabelingJobsRequest$LastModifiedTimeAfter": "

A filter that returns only labeling jobs modified after the specified time (timestamp).

", "ListLabelingJobsRequest$LastModifiedTimeBefore": "

A filter that returns only labeling jobs modified before the specified time (timestamp).

", + "ListLineageGroupsRequest$CreatedAfter": "

A timestamp to filter against lineage groups created after a certain point in time.

", + "ListLineageGroupsRequest$CreatedBefore": "

A timestamp to filter against lineage groups created before a certain point in time.

", "ListModelBiasJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only model bias jobs created before a specified time.

", "ListModelBiasJobDefinitionsRequest$CreationTimeAfter": "

A filter that returns only model bias jobs created after a specified time.

", "ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only model explainability jobs created before a specified time.

", @@ -9950,6 +10651,10 @@ "Project$CreationTime": "

A timestamp specifying when the project was created.

", "Project$LastModifiedTime": "

A timestamp container for when the project was last modified.

", "ProjectSummary$CreationTime": "

The time that the project was created.

", + "QueryFilters$CreatedBefore": "

Filter the lineage entities connected to the StartArn(s) by created date.

", + "QueryFilters$CreatedAfter": "

Filter the lineage entities connected to the StartArn(s) after the create date.

", + "QueryFilters$ModifiedBefore": "

Filter the lineage entities connected to the StartArn(s) before the last modified date.

", + "QueryFilters$ModifiedAfter": "

Filter the lineage entities connected to the StartArn(s) after the last modified date.

", "SecondaryStatusTransition$StartTime": "

A timestamp that shows when the training job transitioned to the current secondary status state.

", "SecondaryStatusTransition$EndTime": "

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

", "StudioLifecycleConfigDetails$CreationTime": "

The creation time of the Studio Lifecycle Configuration.

", @@ -9989,6 +10694,18 @@ "Workteam$LastUpdatedDate": "

The date and time that the work team was last updated (timestamp).

" } }, + "TrafficDurationInSeconds": { + "base": null, + "refs": { + "Phase$DurationInSeconds": "

Specifies how long traffic phase should be.

" + } + }, + "TrafficPattern": { + "base": "

Defines the traffic pattern of the load test.

", + "refs": { + "RecommendationJobInputConfig$TrafficPattern": "

Specifies the traffic pattern of the job.

" + } + }, "TrafficRoutingConfig": { "base": "

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

", "refs": { @@ -10001,6 +10718,12 @@ "TrafficRoutingConfig$Type": "

Traffic routing strategy type.

" } }, + "TrafficType": { + "base": null, + "refs": { + "TrafficPattern$TrafficType": "

Defines the traffic patterns.

" + } + }, "TrainingEnvironmentKey": { "base": null, "refs": { @@ -10214,6 +10937,7 @@ "TransformInstanceTypes": { "base": null, "refs": { + "AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes": "

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

", "InferenceSpecification$SupportedTransformInstanceTypes": "

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

" } }, @@ -10789,7 +11513,7 @@ } }, "UserContext": { - "base": "

Information about the user who created or modified an experiment, trial, trial component, or project.

", + "base": "

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

", "refs": { "AssociationSummary$CreatedBy": null, "DescribeActionResponse$CreatedBy": null, @@ -10800,6 +11524,8 @@ "DescribeContextResponse$LastModifiedBy": null, "DescribeExperimentResponse$CreatedBy": "

Who created the experiment.

", "DescribeExperimentResponse$LastModifiedBy": "

Who last modified the experiment.

", + "DescribeLineageGroupResponse$CreatedBy": null, + "DescribeLineageGroupResponse$LastModifiedBy": null, "DescribeModelPackageGroupOutput$CreatedBy": null, "DescribeModelPackageOutput$CreatedBy": null, "DescribeModelPackageOutput$LastModifiedBy": null, @@ -10954,6 +11680,18 @@ "DescribeModelPackageInput$ModelPackageName": "

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" } }, + "Vertex": { + "base": "

A lineage entity connected to the starting entity(ies).

", + "refs": { + "Vertices$member": null + } + }, + "Vertices": { + "base": null, + "refs": { + "QueryLineageResponse$Vertices": "

A list of vertices connected to the start entity(ies) in the lineage graph.

" + } + }, "VolumeSizeInGB": { "base": null, "refs": { diff --git a/models/apis/sagemaker/2017-07-24/paginators-1.json b/models/apis/sagemaker/2017-07-24/paginators-1.json index 23a41036f50..dd67b25e3b4 100644 --- a/models/apis/sagemaker/2017-07-24/paginators-1.json +++ b/models/apis/sagemaker/2017-07-24/paginators-1.json @@ -150,6 +150,12 @@ "limit_key": "MaxResults", "result_key": "Images" }, + "ListInferenceRecommendationsJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InferenceRecommendationsJobs" + }, "ListLabelingJobs": { "input_token": "NextToken", "output_token": "NextToken", @@ -162,6 +168,12 @@ "limit_key": "MaxResults", "result_key": "LabelingJobSummaryList" }, + "ListLineageGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "LineageGroupSummaries" + }, "ListModelBiasJobDefinitions": { "input_token": "NextToken", "output_token": "NextToken", @@ -174,6 +186,12 @@ "limit_key": "MaxResults", "result_key": "JobDefinitionSummaries" }, + "ListModelMetadata": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ModelMetadataSummaries" + }, "ListModelPackageGroups": { "input_token": "NextToken", "output_token": "NextToken", @@ -323,6 +341,11 @@ "limit_key": "MaxResults", "result_key": "Workteams" }, + "QueryLineage": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "Search": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/shield/2016-06-02/api-2.json b/models/apis/shield/2016-06-02/api-2.json index 51fa8b4ebae..f0934bb2c99 100644 --- a/models/apis/shield/2016-06-02/api-2.json +++ b/models/apis/shield/2016-06-02/api-2.json @@ -62,7 +62,8 @@ {"shape":"LimitsExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, - {"shape":"OptimisticLockException"} + {"shape":"OptimisticLockException"}, + {"shape":"InvalidResourceException"} ] }, "AssociateProactiveEngagementDetails":{ @@ -264,6 +265,22 @@ {"shape":"ResourceNotFoundException"} ] }, + "DisableApplicationLayerAutomaticResponse":{ + "name":"DisableApplicationLayerAutomaticResponse", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableApplicationLayerAutomaticResponseRequest"}, + "output":{"shape":"DisableApplicationLayerAutomaticResponseResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OptimisticLockException"}, + {"shape":"InvalidOperationException"} + ] + }, "DisableProactiveEngagement":{ "name":"DisableProactiveEngagement", "http":{ @@ -324,7 +341,25 @@ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"OptimisticLockException"} + {"shape":"OptimisticLockException"}, + {"shape":"InvalidResourceException"} + ] + }, + "EnableApplicationLayerAutomaticResponse":{ + "name":"EnableApplicationLayerAutomaticResponse", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableApplicationLayerAutomaticResponseRequest"}, + "output":{"shape":"EnableApplicationLayerAutomaticResponseResponse"}, + "errors":[ + {"shape":"LimitsExceededException"}, + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OptimisticLockException"}, + {"shape":"InvalidOperationException"} ] }, "EnableProactiveEngagement":{ @@ -455,6 +490,22 @@ {"shape":"ResourceNotFoundException"} ] }, + "UpdateApplicationLayerAutomaticResponse":{ + "name":"UpdateApplicationLayerAutomaticResponse", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationLayerAutomaticResponseRequest"}, + "output":{"shape":"UpdateApplicationLayerAutomaticResponseResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OptimisticLockException"}, + {"shape":"InvalidOperationException"} + ] + }, "UpdateEmergencyContactSettings":{ "name":"UpdateEmergencyContactSettings", "http":{ @@ -517,6 +568,24 @@ }, "exception":true }, + "ApplicationLayerAutomaticResponseConfiguration":{ + "type":"structure", + "required":[ + "Status", + "Action" + ], + "members":{ + "Status":{"shape":"ApplicationLayerAutomaticResponseStatus"}, + "Action":{"shape":"ResponseAction"} + } + }, + "ApplicationLayerAutomaticResponseStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "AssociateDRTLogBucketRequest":{ "type":"structure", "required":["LogBucket"], @@ -682,6 +751,11 @@ "DISABLED" ] }, + "BlockAction":{ + "type":"structure", + "members":{ + } + }, "ContactNotes":{ "type":"string", "max":1024, @@ -695,6 +769,11 @@ "Value":{"shape":"Long"} } }, + "CountAction":{ + "type":"structure", + "members":{ + } + }, "CreateProtectionGroupRequest":{ "type":"structure", "required":[ @@ -870,6 +949,18 @@ "Subscription":{"shape":"Subscription"} } }, + "DisableApplicationLayerAutomaticResponseRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{"shape":"ResourceArn"} + } + }, + "DisableApplicationLayerAutomaticResponseResponse":{ + "type":"structure", + "members":{ + } + }, "DisableProactiveEngagementRequest":{ "type":"structure", "members":{ @@ -944,6 +1035,22 @@ "max":10, "min":0 }, + "EnableApplicationLayerAutomaticResponseRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Action" + ], + "members":{ + "ResourceArn":{"shape":"ResourceArn"}, + "Action":{"shape":"ResponseAction"} + } + }, + "EnableApplicationLayerAutomaticResponseResponse":{ + "type":"structure", + "members":{ + } + }, "EnableProactiveEngagementRequest":{ "type":"structure", "members":{ @@ -1196,7 +1303,8 @@ "Name":{"shape":"ProtectionName"}, "ResourceArn":{"shape":"ResourceArn"}, "HealthCheckIds":{"shape":"HealthCheckIds"}, - "ProtectionArn":{"shape":"ResourceArn"} + "ProtectionArn":{"shape":"ResourceArn"}, + "ApplicationLayerAutomaticResponseConfiguration":{"shape":"ApplicationLayerAutomaticResponseConfiguration"} } }, "ProtectionGroup":{ @@ -1276,7 +1384,7 @@ "ProtectionId":{ "type":"string", "max":36, - "min":1, + "min":36, "pattern":"[a-zA-Z0-9\\\\-]*" }, "ProtectionLimits":{ @@ -1326,6 +1434,13 @@ }, "exception":true }, + "ResponseAction":{ + "type":"structure", + "members":{ + "Block":{"shape":"BlockAction"}, + "Count":{"shape":"CountAction"} + } + }, "RoleArn":{ "type":"string", "max":2048, @@ -1460,8 +1575,8 @@ "TimeRange":{ "type":"structure", "members":{ - "FromInclusive":{"shape":"AttackTimestamp"}, - "ToExclusive":{"shape":"AttackTimestamp"} + "FromInclusive":{"shape":"Timestamp"}, + "ToExclusive":{"shape":"Timestamp"} } }, "Timestamp":{"type":"timestamp"}, @@ -1500,6 +1615,22 @@ "members":{ } }, + "UpdateApplicationLayerAutomaticResponseRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Action" + ], + "members":{ + "ResourceArn":{"shape":"ResourceArn"}, + "Action":{"shape":"ResponseAction"} + } + }, + "UpdateApplicationLayerAutomaticResponseResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateEmergencyContactSettingsRequest":{ "type":"structure", "members":{ diff --git a/models/apis/shield/2016-06-02/docs-2.json b/models/apis/shield/2016-06-02/docs-2.json index 242e65f8b40..58bf82d9177 100644 --- a/models/apis/shield/2016-06-02/docs-2.json +++ b/models/apis/shield/2016-06-02/docs-2.json @@ -2,11 +2,11 @@ "version": "2.0", "service": "Shield Advanced

This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.

", "operations": { - "AssociateDRTLogBucket": "

Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

", - "AssociateDRTRole": "

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.

The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.

To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

", - "AssociateHealthCheck": "

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

", + "AssociateDRTLogBucket": "

Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

", + "AssociateDRTRole": "

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON policy elements: Principal.

The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.

To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

", + "AssociateHealthCheck": "

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

", "AssociateProactiveEngagementDetails": "

Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

", - "CreateProtection": "

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the WAF console. For more information see Getting Started with Shield Advanced and Add Shield Advanced Protection to more Amazon Web Services Resources.

", + "CreateProtection": "

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources.

", "CreateProtectionGroup": "

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

", "CreateSubscription": "

Activates Shield Advanced for an account.

When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

", "DeleteProtection": "

Deletes an Shield Advanced Protection.

", @@ -19,10 +19,12 @@ "DescribeProtection": "

Lists the details of a Protection object.

", "DescribeProtectionGroup": "

Returns the specification for the specified protection group.

", "DescribeSubscription": "

Provides details about the Shield Advanced subscription for an account.

", + "DisableApplicationLayerAutomaticResponse": "

Disable the Shield Advanced automatic application layer DDoS mitigation feature for the resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.

", "DisableProactiveEngagement": "

Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.

", - "DisassociateDRTLogBucket": "

Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

", - "DisassociateDRTRole": "

Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

", - "DisassociateHealthCheck": "

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

", + "DisassociateDRTLogBucket": "

Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

", + "DisassociateDRTRole": "

Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.

", + "DisassociateHealthCheck": "

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

", + "EnableApplicationLayerAutomaticResponse": "

Enable the Shield Advanced automatic application layer DDoS mitigation for the resource.

This feature is available for Amazon CloudFront distributions only.

This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.

Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.

To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced.

You can also do this through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.

", "EnableProactiveEngagement": "

Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

", "GetSubscriptionState": "

Returns the SubscriptionState, either Active or Inactive.

", "ListAttacks": "

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

", @@ -32,6 +34,7 @@ "ListTagsForResource": "

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.

", "TagResource": "

Adds or updates tags for a resource in Shield.

", "UntagResource": "

Removes tags from a resource in Shield.

", + "UpdateApplicationLayerAutomaticResponse": "

Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.

", "UpdateEmergencyContactSettings": "

Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

", "UpdateProtectionGroup": "

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

", "UpdateSubscription": "

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

" @@ -47,6 +50,18 @@ "refs": { } }, + "ApplicationLayerAutomaticResponseConfiguration": { + "base": "

The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

", + "refs": { + "Protection$ApplicationLayerAutomaticResponseConfiguration": "

The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

" + } + }, + "ApplicationLayerAutomaticResponseStatus": { + "base": null, + "refs": { + "ApplicationLayerAutomaticResponseConfiguration$Status": "

Indicates whether automatic application layer DDoS mitigation is enabled for the protection.

" + } + }, "AssociateDRTLogBucketRequest": { "base": null, "refs": { @@ -97,19 +112,19 @@ "base": null, "refs": { "AttackDetail$AttackId": "

The unique identifier (ID) of the attack.

", - "DescribeAttackRequest$AttackId": "

The unique identifier (ID) for the attack that to be described.

" + "DescribeAttackRequest$AttackId": "

The unique identifier (ID) for the attack.

" } }, "AttackLayer": { "base": null, "refs": { - "AttackProperty$AttackLayer": "

The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.

For infrastructure layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.

" + "AttackProperty$AttackLayer": "

The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.

For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.

" } }, "AttackProperties": { "base": null, "refs": { - "AttackDetail$AttackProperties": "

The array of objects that provide details of the Shield event.

For infrastructure layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.

" + "AttackDetail$AttackProperties": "

The array of objects that provide details of the Shield event.

For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.

" } }, "AttackProperty": { @@ -151,12 +166,10 @@ "AttackTimestamp": { "base": null, "refs": { - "AttackDetail$StartTime": "

The time the attack started, in Unix time in seconds. For more information see timestamp.

", - "AttackDetail$EndTime": "

The time the attack ended, in Unix time in seconds. For more information see timestamp.

", - "AttackSummary$StartTime": "

The start time of the attack, in Unix time in seconds. For more information see timestamp.

", - "AttackSummary$EndTime": "

The end time of the attack, in Unix time in seconds. For more information see timestamp.

", - "TimeRange$FromInclusive": "

The start time, in Unix time in seconds. For more information see timestamp.

", - "TimeRange$ToExclusive": "

The end time, in Unix time in seconds. For more information see timestamp.

" + "AttackDetail$StartTime": "

The time the attack started, in Unix time in seconds.

", + "AttackDetail$EndTime": "

The time the attack ended, in Unix time in seconds.

", + "AttackSummary$StartTime": "

The start time of the attack, in Unix time in seconds.

", + "AttackSummary$EndTime": "

The end time of the attack, in Unix time in seconds.

" } }, "AttackVectorDescription": { @@ -192,6 +205,12 @@ "UpdateSubscriptionRequest$AutoRenew": "

When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

" } }, + "BlockAction": { + "base": "

Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

This is only used in the context of the ResponseAction setting.

JSON specification: \"Block\": {}

", + "refs": { + "ResponseAction$Block": "

Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

You must specify exactly one action, either Block or Count.

" + } + }, "ContactNotes": { "base": null, "refs": { @@ -199,11 +218,17 @@ } }, "Contributor": { - "base": "

A contributor to the attack and their contribution.

", + "base": "

A contributor to the attack and their contribution.

", "refs": { "TopContributors$member": null } }, + "CountAction": { + "base": "

Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

This is only used in the context of the ResponseAction setting.

JSON specification: \"Count\": {}

", + "refs": { + "ResponseAction$Count": "

Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

You must specify exactly one action, either Block or Count.

" + } + }, "CreateProtectionGroupRequest": { "base": null, "refs": { @@ -334,6 +359,16 @@ "refs": { } }, + "DisableApplicationLayerAutomaticResponseRequest": { + "base": null, + "refs": { + } + }, + "DisableApplicationLayerAutomaticResponseResponse": { + "base": null, + "refs": { + } + }, "DisableProactiveEngagementRequest": { "base": null, "refs": { @@ -409,6 +444,16 @@ "UpdateEmergencyContactSettingsRequest$EmergencyContactList": "

A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

If you have proactive engagement enabled, the contact list must include at least one phone number.

" } }, + "EnableApplicationLayerAutomaticResponseRequest": { + "base": null, + "refs": { + } + }, + "EnableApplicationLayerAutomaticResponseResponse": { + "base": null, + "refs": { + } + }, "EnableProactiveEngagementRequest": { "base": null, "refs": { @@ -445,7 +490,7 @@ "HealthCheckIds": { "base": null, "refs": { - "Protection$HealthCheckIds": "

The unique identifier (ID) for the Route 53 health check that's associated with the protection.

" + "Protection$HealthCheckIds": "

The unique identifier (ID) for the Route 53 health check that's associated with the protection.

" } }, "Integer": { @@ -465,7 +510,7 @@ } }, "InvalidPaginationTokenException": { - "base": "

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.

", + "base": "

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.

", "refs": { } }, @@ -592,10 +637,10 @@ "MaxResults": { "base": null, "refs": { - "ListAttacksRequest$MaxResults": "

The maximum number of AttackSummary objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

", - "ListProtectionGroupsRequest$MaxResults": "

The maximum number of ProtectionGroup objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

", - "ListProtectionsRequest$MaxResults": "

The maximum number of Protection objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

", - "ListResourcesInProtectionGroupRequest$MaxResults": "

The maximum number of resource ARN objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

" + "ListAttacksRequest$MaxResults": "

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

", + "ListProtectionGroupsRequest$MaxResults": "

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

", + "ListProtectionsRequest$MaxResults": "

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

", + "ListResourcesInProtectionGroupRequest$MaxResults": "

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

" } }, "Mitigation": { @@ -752,8 +797,10 @@ "base": null, "refs": { "AttackDetail$ResourceArn": "

The ARN (Amazon Resource Name) of the resource that was attacked.

", - "CreateProtectionRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the resource to be protected.

The ARN should be in one of the following formats:

", + "CreateProtectionRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the resource to be protected.

The ARN should be in one of the following formats:

", "DescribeProtectionRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the Amazon Web Services resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

", + "DisableApplicationLayerAutomaticResponseRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the resource.

", + "EnableApplicationLayerAutomaticResponseRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the resource.

", "ListTagsForResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) of the resource to get tags for.

", "Protection$ResourceArn": "

The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.

", "Protection$ProtectionArn": "

The ARN (Amazon Resource Name) of the protection.

", @@ -763,13 +810,14 @@ "ResourceArnList$member": null, "Subscription$SubscriptionArn": "

The ARN (Amazon Resource Name) of the subscription.

", "TagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.

", - "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

" + "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

", + "UpdateApplicationLayerAutomaticResponseRequest$ResourceArn": "

The ARN (Amazon Resource Name) of the resource.

" } }, "ResourceArnFilterList": { "base": null, "refs": { - "ListAttacksRequest$ResourceArns": "

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

" + "ListAttacksRequest$ResourceArns": "

The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.

" } }, "ResourceArnList": { @@ -783,6 +831,14 @@ "refs": { } }, + "ResponseAction": { + "base": "

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

", + "refs": { + "ApplicationLayerAutomaticResponseConfiguration$Action": null, + "EnableApplicationLayerAutomaticResponseRequest$Action": "

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

", + "UpdateApplicationLayerAutomaticResponseRequest$Action": "

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

" + } + }, "RoleArn": { "base": null, "refs": { @@ -796,7 +852,7 @@ "AttackSummary$AttackId": "

The unique identifier (ID) of the attack.

", "AttackSummary$ResourceArn": "

The ARN (Amazon Resource Name) of the resource that was attacked.

", "AttackVectorDescription$VectorType": "

The attack type. Valid values:

", - "Contributor$Name": "

The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.

", + "Contributor$Name": "

The name of the contributor. The type of name that you'll find here depends on the AttackPropertyIdentifier setting in the AttackProperty where this contributor is defined. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.

", "Limit$Type": "

The type of protection.

", "Mitigation$MitigationName": "

The name of the mitigation taken for this attack.

", "ResourceAlreadyExistsException$resourceType": "

The type of resource that already exists.

", @@ -919,34 +975,36 @@ "base": "

The time range.

", "refs": { "DescribeAttackStatisticsResponse$TimeRange": null, - "ListAttacksRequest$StartTime": "

The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

", - "ListAttacksRequest$EndTime": "

The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

" + "ListAttacksRequest$StartTime": "

The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

", + "ListAttacksRequest$EndTime": "

The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

" } }, "Timestamp": { "base": null, "refs": { - "Subscription$StartTime": "

The start time of the subscription, in Unix time in seconds. For more information see timestamp.

", - "Subscription$EndTime": "

The date and time your subscription will end.

" + "Subscription$StartTime": "

The start time of the subscription, in Unix time in seconds.

", + "Subscription$EndTime": "

The date and time your subscription will end.

", + "TimeRange$FromInclusive": "

The start time, in Unix time in seconds.

", + "TimeRange$ToExclusive": "

The end time, in Unix time in seconds.

" } }, "Token": { "base": null, "refs": { - "ListAttacksRequest$NextToken": "

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

", - "ListAttacksResponse$NextToken": "

The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.

Shield Advanced might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more attack summary objects to return, Shield Advanced will always also return a NextToken.

", - "ListProtectionGroupsRequest$NextToken": "

The next token value from a previous call to ListProtectionGroups. Pass null if this is the first call.

", - "ListProtectionGroupsResponse$NextToken": "

If you specify a value for MaxResults and you have more protection groups than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.

", - "ListProtectionsRequest$NextToken": "

The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.

", - "ListProtectionsResponse$NextToken": "

If you specify a value for MaxResults and you have more Protections than the value of MaxResults, Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

Shield Advanced might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, Shield Advanced will always also return a NextToken.

", - "ListResourcesInProtectionGroupRequest$NextToken": "

The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.

", - "ListResourcesInProtectionGroupResponse$NextToken": "

If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.

" + "ListAttacksRequest$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

", + "ListAttacksResponse$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

", + "ListProtectionGroupsRequest$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

", + "ListProtectionGroupsResponse$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

", + "ListProtectionsRequest$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

", + "ListProtectionsResponse$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

", + "ListResourcesInProtectionGroupRequest$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

", + "ListResourcesInProtectionGroupResponse$NextToken": "

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

" } }, "TopContributors": { "base": null, "refs": { - "AttackProperty$TopContributors": "

Contributor objects for the top five contributors to a Shield event.

" + "AttackProperty$TopContributors": "

Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that Shield Advanced identifies as responsible for some or all of an event.

" } }, "Unit": { @@ -965,6 +1023,16 @@ "refs": { } }, + "UpdateApplicationLayerAutomaticResponseRequest": { + "base": null, + "refs": { + } + }, + "UpdateApplicationLayerAutomaticResponseResponse": { + "base": null, + "refs": { + } + }, "UpdateEmergencyContactSettingsRequest": { "base": null, "refs": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index e6b1aa73a7a..159094490fb 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -12340,6 +12340,13 @@ } } }, + "workspaces-web" : { + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "xray" : { "endpoints" : { "af-south-1" : { }, diff --git a/service/devopsguru/api.go b/service/devopsguru/api.go index 343d0470bdc..48e0e25f2dd 100644 --- a/service/devopsguru/api.go +++ b/service/devopsguru/api.go @@ -826,7 +826,7 @@ func (c *DevOpsGuru) DescribeOrganizationResourceCollectionHealthRequest(input * op := &request.Operation{ Name: opDescribeOrganizationResourceCollectionHealth, HTTPMethod: "POST", - HTTPPath: "/organization/health/resource-collection/", + HTTPPath: "/organization/health/resource-collection", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, @@ -1002,10 +1002,12 @@ func (c *DevOpsGuru) DescribeResourceCollectionHealthRequest(input *DescribeReso // Returns the number of open proactive insights, open reactive insights, and // the Mean Time to Recover (MTTR) for all closed insights in resource collections // in your account. You specify the type of Amazon Web Services resources collection. -// The one type of Amazon Web Services resource collection supported is Amazon -// Web Services CloudFormation stacks. DevOps Guru can be configured to analyze -// only the Amazon Web Services resources that are defined in the stacks. You -// can specify up to 500 Amazon Web Services CloudFormation stacks. +// The two types of Amazon Web Services resource collections supported are Amazon +// Web Services CloudFormation stacks and Amazon Web Services resources that +// contain the same Amazon Web Services tag. DevOps Guru can be configured to +// analyze the Amazon Web Services resources that are defined in the stacks +// or that are tagged using the same tag key. You can specify up to 500 Amazon +// Web Services CloudFormation stacks. // // 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 @@ -1410,11 +1412,12 @@ func (c *DevOpsGuru) GetResourceCollectionRequest(input *GetResourceCollectionIn // GetResourceCollection API operation for Amazon DevOps Guru. // // Returns lists Amazon Web Services resources that are of the specified resource -// collection type. The one type of Amazon Web Services resource collection -// supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be -// configured to analyze only the Amazon Web Services resources that are defined -// in the stacks. You can specify up to 500 Amazon Web Services CloudFormation -// stacks. +// collection type. The two types of Amazon Web Services resource collections +// supported are Amazon Web Services CloudFormation stacks and Amazon Web Services +// resources that contain the same Amazon Web Services tag. DevOps Guru can +// be configured to analyze the Amazon Web Services resources that are defined +// in the stacks or that are tagged using the same tag key. You can specify +// up to 500 Amazon Web Services CloudFormation stacks. // // 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 @@ -3104,12 +3107,14 @@ func (c *DevOpsGuru) UpdateResourceCollectionRequest(input *UpdateResourceCollec // UpdateResourceCollection API operation for Amazon DevOps Guru. // -// Updates the collection of resources that DevOps Guru analyzes. The one type -// of Amazon Web Services resource collection supported is Amazon Web Services -// CloudFormation stacks. DevOps Guru can be configured to analyze only the -// Amazon Web Services resources that are defined in the stacks. You can specify -// up to 500 Amazon Web Services CloudFormation stacks. This method also creates -// the IAM role required for you to use DevOps Guru. +// Updates the collection of resources that DevOps Guru analyzes. The two types +// of Amazon Web Services resource collections supported are Amazon Web Services +// CloudFormation stacks and Amazon Web Services resources that contain the +// same Amazon Web Services tag. DevOps Guru can be configured to analyze the +// Amazon Web Services resources that are defined in the stacks or that are +// tagged using the same tag key. You can specify up to 500 Amazon Web Services +// CloudFormation stacks. This method also creates the IAM role required for +// you to use DevOps Guru. // // 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 @@ -3550,14 +3555,62 @@ func (s *AnomalyReportedTimeRange) SetOpenTime(v time.Time) *AnomalyReportedTime return s } +// The Amazon Web Services resources in which DevOps Guru detected unusual behavior +// that resulted in the generation of an anomaly. When DevOps Guru detects multiple +// related anomalies, it creates and insight with details about the anomalous +// behavior and suggestions about how to correct the problem. +type AnomalyResource struct { + _ struct{} `type:"structure"` + + // The name of the Amazon Web Services resource. + Name *string `type:"string"` + + // The type of the Amazon Web Services resource. + Type *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 AnomalyResource) 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 AnomalyResource) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *AnomalyResource) SetName(v string) *AnomalyResource { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *AnomalyResource) SetType(v string) *AnomalyResource { + s.Type = &v + return s +} + // Details about the source of the anomalous operational data that triggered -// the anomaly. The one supported source is Amazon CloudWatch metrics. +// the anomaly. type AnomalySourceDetails struct { _ struct{} `type:"structure"` - // An array of CloudWatchMetricsDetail object that contains information about - // the analyzed metrics that displayed anomalous behavior. + // An array of CloudWatchMetricsDetail objects that contain information about + // analyzed CloudWatch metrics that show anomalous behavior. CloudWatchMetrics []*CloudWatchMetricsDetail `type:"list"` + + // An array of PerformanceInsightsMetricsDetail objects that contain information + // about analyzed Performance Insights metrics that show anomalous behavior. + PerformanceInsightsMetrics []*PerformanceInsightsMetricsDetail `type:"list"` } // String returns the string representation. @@ -3584,6 +3637,12 @@ func (s *AnomalySourceDetails) SetCloudWatchMetrics(v []*CloudWatchMetricsDetail return s } +// SetPerformanceInsightsMetrics sets the PerformanceInsightsMetrics field's value. +func (s *AnomalySourceDetails) SetPerformanceInsightsMetrics(v []*PerformanceInsightsMetricsDetail) *AnomalySourceDetails { + s.PerformanceInsightsMetrics = v + return s +} + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange, which // specifies the time range when DevOps Guru opens and then closes an anomaly. @@ -3799,11 +3858,11 @@ func (s *CloudFormationHealth) SetStackName(v string) *CloudFormationHealth { type CloudWatchMetricsDataSummary struct { _ struct{} `type:"structure"` - // This is enum of the status showing whether the metric value pair list has - // Partial or Complete data or there was an error. + // This is an enum of the status showing whether the metric value pair list + // has partial or complete data, or if there was an error. StatusCode *string `type:"string" enum:"CloudWatchMetricDataStatusCode"` - // This is a list of cloudwatch metric values at given timestamp. + // This is a list of Amazon CloudWatch metric values at given timestamp. TimestampMetricValuePairList []*TimestampMetricValuePair `type:"list"` } @@ -3927,7 +3986,7 @@ func (s *CloudWatchMetricsDetail) SetUnit(v string) *CloudWatchMetricsDetail { return s } -// The dimension of a Amazon CloudWatch metric that is used when DevOps Guru +// The dimension of am Amazon CloudWatch metric that is used when DevOps Guru // analyzes the resources in your account for operational problems and anomalous // behavior. A dimension is a name/value pair that is part of the identity of // a metric. A metric can have up to 10 dimensions. For more information, see @@ -4057,6 +4116,37 @@ type CostEstimationResourceCollectionFilter struct { // An object that specifies the CloudFormation stack that defines the Amazon // Web Services resources used to create a monthly estimate for DevOps Guru. CloudFormation *CloudFormationCostEstimationResourceCollectionFilter `type:"structure"` + + // The Amazon Web Services tags used to filter the resource collection that + // is used for a cost estimate. + // + // Tags help you identify and organize your Amazon Web Services resources. Many + // Amazon Web Services services support tagging, so you can assign the same + // tag to resources from different services to indicate that the resources are + // related. For example, you can assign the same tag to an Amazon DynamoDB table + // resource that you assign to an Lambda function. For more information about + // using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) + // whitepaper. + // + // Each Amazon Web Services tag has two parts. + // + // * A tag key (for example, CostCenter, Environment, Project, or Secret). + // Tag keys are case-sensitive. + // + // * An optional field known as a tag value (for example, 111122223333, Production, + // or a team name). Omitting the tag value is the same as using an empty + // string. Like tag keys, tag values are case-sensitive. + // + // Together these are known as key-value pairs. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + Tags []*TagCostEstimationResourceCollectionFilter `type:"list"` } // String returns the string representation. @@ -4085,6 +4175,16 @@ func (s *CostEstimationResourceCollectionFilter) Validate() error { invalidParams.AddNested("CloudFormation", err.(request.ErrInvalidParams)) } } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -4098,6 +4198,12 @@ func (s *CostEstimationResourceCollectionFilter) SetCloudFormation(v *CloudForma return s } +// SetTags sets the Tags field's value. +func (s *CostEstimationResourceCollectionFilter) SetTags(v []*TagCostEstimationResourceCollectionFilter) *CostEstimationResourceCollectionFilter { + s.Tags = v + return s +} + // The time range of a cost estimation. type CostEstimationTimeRange struct { _ struct{} `type:"structure"` @@ -4412,10 +4518,10 @@ func (s *DescribeAnomalyInput) SetId(v string) *DescribeAnomalyInput { type DescribeAnomalyOutput struct { _ struct{} `type:"structure"` - // A ReactiveAnomaly object that represents the requested anomaly. + // A ProactiveAnomaly object that represents the requested anomaly. ProactiveAnomaly *ProactiveAnomaly `type:"structure"` - // A ProactiveAnomaly object that represents the requested anomaly. + // A ReactiveAnomaly object that represents the requested anomaly. ReactiveAnomaly *ReactiveAnomaly `type:"structure"` } @@ -4873,11 +4979,12 @@ type DescribeOrganizationResourceCollectionHealthInput struct { NextToken *string `min:"36" type:"string"` // An Amazon Web Services resource collection type. This type specifies how - // analyzed Amazon Web Services resources are defined. The one type of Amazon - // Web Services resource collection supported is Amazon Web Services CloudFormation - // stacks. DevOps Guru can be configured to analyze only the Amazon Web Services - // resources that are defined in the stacks. You can specify up to 500 Amazon - // Web Services CloudFormation stacks. + // analyzed Amazon Web Services resources are defined. The two types of Amazon + // Web Services resource collections supported are Amazon Web Services CloudFormation + // stacks and Amazon Web Services resources that contain the same Amazon Web + // Services tag. DevOps Guru can be configured to analyze the Amazon Web Services + // resources that are defined in the stacks or that are tagged using the same + // tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. // // OrganizationResourceCollectionType is a required field OrganizationResourceCollectionType *string `type:"string" required:"true" enum:"OrganizationResourceCollectionType"` @@ -5022,11 +5129,12 @@ type DescribeResourceCollectionHealthInput struct { NextToken *string `location:"querystring" locationName:"NextToken" min:"36" type:"string"` // An Amazon Web Services resource collection type. This type specifies how - // analyzed Amazon Web Services resources are defined. The one type of Amazon - // Web Services resource collection supported is Amazon Web Services CloudFormation - // stacks. DevOps Guru can be configured to analyze only the Amazon Web Services - // resources that are defined in the stacks. You can specify up to 500 Amazon - // Web Services CloudFormation stacks. + // analyzed Amazon Web Services resources are defined. The two types of Amazon + // Web Services resource collections supported are Amazon Web Services CloudFormation + // stacks and Amazon Web Services resources that contain the same Amazon Web + // Services tag. DevOps Guru can be configured to analyze the Amazon Web Services + // resources that are defined in the stacks or that are tagged using the same + // tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. // // ResourceCollectionType is a required field ResourceCollectionType *string `location:"uri" locationName:"ResourceCollectionType" type:"string" required:"true" enum:"ResourceCollectionType"` @@ -5086,9 +5194,7 @@ type DescribeResourceCollectionHealthOutput struct { // The returned CloudFormationHealthOverview object that contains an InsightHealthOverview // object with the requested system health information. - // - // CloudFormation is a required field - CloudFormation []*CloudFormationHealth `type:"list" required:"true"` + CloudFormation []*CloudFormationHealth `type:"list"` // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. @@ -5097,6 +5203,36 @@ type DescribeResourceCollectionHealthOutput struct { // An array of ServiceHealth objects that describes the health of the Amazon // Web Services services associated with the resources in the collection. Service []*ServiceHealth `type:"list"` + + // The Amazon Web Services tags that are used by resources in the resource collection. + // + // Tags help you identify and organize your Amazon Web Services resources. Many + // Amazon Web Services services support tagging, so you can assign the same + // tag to resources from different services to indicate that the resources are + // related. For example, you can assign the same tag to an Amazon DynamoDB table + // resource that you assign to an Lambda function. For more information about + // using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) + // whitepaper. + // + // Each Amazon Web Services tag has two parts. + // + // * A tag key (for example, CostCenter, Environment, Project, or Secret). + // Tag keys are case-sensitive. + // + // * An optional field known as a tag value (for example, 111122223333, Production, + // or a team name). Omitting the tag value is the same as using an empty + // string. Like tag keys, tag values are case-sensitive. + // + // Together these are known as key-value pairs. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + Tags []*TagHealth `type:"list"` } // String returns the string representation. @@ -5135,6 +5271,12 @@ func (s *DescribeResourceCollectionHealthOutput) SetService(v []*ServiceHealth) return s } +// SetTags sets the Tags field's value. +func (s *DescribeResourceCollectionHealthOutput) SetTags(v []*TagHealth) *DescribeResourceCollectionHealthOutput { + s.Tags = v + return s +} + type DescribeServiceIntegrationInput struct { _ struct{} `type:"structure" nopayload:"true"` } @@ -5255,10 +5397,12 @@ type Event struct { Name *string `type:"string"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // An EventResource object that contains information about the resource that @@ -5648,11 +5792,13 @@ type GetResourceCollectionOutput struct { // operation. If there are no more pages, this value is null. NextToken *string `min:"36" type:"string"` - // The requested list of Amazon Web Services resource collections. The one type - // of Amazon Web Services resource collection supported is Amazon Web Services - // CloudFormation stacks. DevOps Guru can be configured to analyze only the - // Amazon Web Services resources that are defined in the stacks. You can specify - // up to 500 Amazon Web Services CloudFormation stacks. + // The requested list of Amazon Web Services resource collections. The two types + // of Amazon Web Services resource collections supported are Amazon Web Services + // CloudFormation stacks and Amazon Web Services resources that contain the + // same Amazon Web Services tag. DevOps Guru can be configured to analyze the + // Amazon Web Services resources that are defined in the stacks or that are + // tagged using the same tag key. You can specify up to 500 Amazon Web Services + // CloudFormation stacks. ResourceCollection *ResourceCollectionFilter `type:"structure"` } @@ -6074,10 +6220,12 @@ type ListEventsFilters struct { InsightId *string `min:"1" type:"string"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` } @@ -6113,6 +6261,11 @@ func (s *ListEventsFilters) Validate() error { invalidParams.AddNested("EventTimeRange", err.(request.ErrInvalidParams)) } } + if s.ResourceCollection != nil { + if err := s.ResourceCollection.Validate(); err != nil { + invalidParams.AddNested("ResourceCollection", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -7209,19 +7362,109 @@ func (s *OpsCenterIntegrationConfig) SetOptInStatus(v string) *OpsCenterIntegrat return s } -// The time range during which anomalous behavior in a proactive anomaly or -// an insight is expected to occur. -type PredictionTimeRange struct { +// A logical grouping of Performance Insights metrics for a related subject +// area. For example, the db.sql dimension group consists of the following dimensions: +// db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id. +// +// Each response element returns a maximum of 500 bytes. For larger elements, +// such as SQL statements, only the first 500 bytes are returned. +// +// Amazon RDS Performance Insights enables you to monitor and explore different +// dimensions of database load based on data captured from a running DB instance. +// DB load is measured as average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension provides DB load data for each time point in the queried time range. +// Each time point decomposes overall load in relation to the requested dimensions, +// measured at that time point. Examples include SQL, Wait event, User, and +// Host. +// +// * To learn more about Performance Insights and Amazon Aurora DB instances, +// go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). +// +// * To learn more about Performance Insights and Amazon RDS DB instances, +// go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +type PerformanceInsightsMetricDimensionGroup struct { _ struct{} `type:"structure"` - // The time when the behavior in a proactive insight is expected to end. - EndTime *time.Time `type:"timestamp"` + // A list of specific dimensions from a dimension group. If this parameter is + // not present, then it signifies that all of the dimensions in the group were + // requested or are present in the response. + // + // Valid values for elements in the Dimensions array are: + // + // * db.application.name - The name of the application that is connected + // to the database (only Aurora PostgreSQL and RDS PostgreSQL) + // + // * db.host.id - The host ID of the connected client (all engines) + // + // * db.host.name - The host name of the connected client (all engines) + // + // * db.name - The name of the database to which the client is connected + // (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS + // MySQL, and MariaDB) + // + // * db.session_type.name - The type of the current session (only Aurora + // PostgreSQL and RDS PostgreSQL) + // + // * db.sql.id - The SQL ID generated by Performance Insights (all engines) + // + // * db.sql.db_id - The SQL ID generated by the database (all engines) + // + // * db.sql.statement - The SQL text that is being executed (all engines) + // + // * db.sql.tokenized_id + // + // * db.sql_tokenized.id - The SQL digest ID generated by Performance Insights + // (all engines) + // + // * db.sql_tokenized.db_id - SQL digest ID generated by the database (all + // engines) + // + // * db.sql_tokenized.statement - The SQL digest text (all engines) + // + // * db.user.id - The ID of the user logged in to the database (all engines) + // + // * db.user.name - The name of the user logged in to the database (all engines) + // + // * db.wait_event.name - The event for which the backend is waiting (all + // engines) + // + // * db.wait_event.type - The type of event for which the backend is waiting + // (all engines) + // + // * db.wait_event_type.name - The name of the event type for which the backend + // is waiting (all engines) + Dimensions []*string `type:"list"` - // The time range during which a metric limit is expected to be exceeded. This - // applies to proactive insights only. + // The name of the dimension group. Its valid values are: // - // StartTime is a required field - StartTime *time.Time `type:"timestamp" required:"true"` + // * db - The name of the database to which the client is connected (only + // Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, + // and MariaDB) + // + // * db.application - The name of the application that is connected to the + // database (only Aurora PostgreSQL and RDS PostgreSQL) + // + // * db.host - The host name of the connected client (all engines) + // + // * db.session_type - The type of the current session (only Aurora PostgreSQL + // and RDS PostgreSQL) + // + // * db.sql - The SQL that is currently executing (all engines) + // + // * db.sql_tokenized - The SQL digest (all engines) + // + // * db.wait_event - The event for which the database backend is waiting + // (all engines) + // + // * db.wait_event_type - The type of event for which the database backend + // is waiting (all engines) + // + // * db.user - The user logged in to the database (all engines) + Group *string `type:"string"` + + // The maximum number of items to fetch for this dimension group. + Limit *int64 `min:"1" type:"integer"` } // String returns the string representation. @@ -7229,7 +7472,7 @@ type PredictionTimeRange 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 PredictionTimeRange) String() string { +func (s PerformanceInsightsMetricDimensionGroup) String() string { return awsutil.Prettify(s) } @@ -7238,69 +7481,161 @@ func (s PredictionTimeRange) 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 PredictionTimeRange) GoString() string { +func (s PerformanceInsightsMetricDimensionGroup) GoString() string { return s.String() } -// SetEndTime sets the EndTime field's value. -func (s *PredictionTimeRange) SetEndTime(v time.Time) *PredictionTimeRange { - s.EndTime = &v +// SetDimensions sets the Dimensions field's value. +func (s *PerformanceInsightsMetricDimensionGroup) SetDimensions(v []*string) *PerformanceInsightsMetricDimensionGroup { + s.Dimensions = v return s } -// SetStartTime sets the StartTime field's value. -func (s *PredictionTimeRange) SetStartTime(v time.Time) *PredictionTimeRange { - s.StartTime = &v +// SetGroup sets the Group field's value. +func (s *PerformanceInsightsMetricDimensionGroup) SetGroup(v string) *PerformanceInsightsMetricDimensionGroup { + s.Group = &v return s } -// Information about an anomaly. This object is returned by ListAnomalies. -type ProactiveAnomaly struct { +// SetLimit sets the Limit field's value. +func (s *PerformanceInsightsMetricDimensionGroup) SetLimit(v int64) *PerformanceInsightsMetricDimensionGroup { + s.Limit = &v + return s +} + +// A single query to be processed. Use these parameters to query the Performance +// Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For +// more information, see GetResourceMetrics (https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html) +// in the Amazon RDS Performance Insights API Reference. +// +// Amazon RDS Performance Insights enables you to monitor and explore different +// dimensions of database load based on data captured from a running DB instance. +// DB load is measured as average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension provides DB load data for each time point in the queried time range. +// Each time point decomposes overall load in relation to the requested dimensions, +// measured at that time point. Examples include SQL, Wait event, User, and +// Host. +// +// * To learn more about Performance Insights and Amazon Aurora DB instances, +// go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). +// +// * To learn more about Performance Insights and Amazon RDS DB instances, +// go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +type PerformanceInsightsMetricQuery struct { _ struct{} `type:"structure"` - // A AnomalyReportedTimeRange object that specifies the time range between when - // the anomaly is opened and the time when it is closed. - AnomalyReportedTimeRange *AnomalyReportedTimeRange `type:"structure"` + // One or more filters to apply to a Performance Insights GetResourceMetrics + // API query. Restrictions: + // + // * Any number of filters by the same dimension, as specified in the GroupBy + // parameter. + // + // * A single filter for any other dimension in this dimension group. + Filter map[string]*string `type:"map"` + + // The specification for how to aggregate the data points from a Performance + // Insights GetResourceMetrics API query. The Performance Insights query returns + // all of the dimensions within that group, unless you provide the names of + // specific dimensions within that group. You can also request that Performance + // Insights return a limited number of values for a dimension. + GroupBy *PerformanceInsightsMetricDimensionGroup `type:"structure"` + + // The name of the meteric used used when querying an Performance Insights GetResourceMetrics + // API for anomaly metrics. + // + // Valid values for Metric are: + // + // * db.load.avg - a scaled representation of the number of active sessions + // for the database engine. + // + // * db.sampledload.avg - the raw number of active sessions for the database + // engine. + // + // If the number of active sessions is less than an internal Performance Insights + // threshold, db.load.avg and db.sampledload.avg are the same value. If the + // number of active sessions is greater than the internal threshold, Performance + // Insights samples the active sessions, with db.load.avg showing the scaled + // values, db.sampledload.avg showing the raw values, and db.sampledload.avg + // less than db.load.avg. For most use cases, you can query db.load.avg only. + Metric *string `type:"string"` +} - // A time range that specifies when the observed unusual behavior in an anomaly - // started and ended. This is different from AnomalyReportedTimeRange, which - // specifies the time range when DevOps Guru opens and then closes an anomaly. - AnomalyTimeRange *AnomalyTimeRange `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 PerformanceInsightsMetricQuery) String() string { + return awsutil.Prettify(s) +} - // The ID of the insight that contains this anomaly. An insight is composed - // of related anomalies. - AssociatedInsightId *string `min:"1" 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 PerformanceInsightsMetricQuery) GoString() string { + return s.String() +} - // The ID of a proactive anomaly. - Id *string `min:"1" type:"string"` +// SetFilter sets the Filter field's value. +func (s *PerformanceInsightsMetricQuery) SetFilter(v map[string]*string) *PerformanceInsightsMetricQuery { + s.Filter = v + return s +} - // A threshold that was exceeded by behavior in analyzed resources. Exceeding - // this threshold is related to the anomalous behavior that generated this anomaly. - Limit *float64 `type:"double"` +// SetGroupBy sets the GroupBy field's value. +func (s *PerformanceInsightsMetricQuery) SetGroupBy(v *PerformanceInsightsMetricDimensionGroup) *PerformanceInsightsMetricQuery { + s.GroupBy = v + return s +} - // The time range during which anomalous behavior in a proactive anomaly or - // an insight is expected to occur. - PredictionTimeRange *PredictionTimeRange `type:"structure"` +// SetMetric sets the Metric field's value. +func (s *PerformanceInsightsMetricQuery) SetMetric(v string) *PerformanceInsightsMetricQuery { + s.Metric = &v + return s +} - // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. - ResourceCollection *ResourceCollection `type:"structure"` +// Details about Performance Insights metrics. +// +// Amazon RDS Performance Insights enables you to monitor and explore different +// dimensions of database load based on data captured from a running DB instance. +// DB load is measured as average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension provides DB load data for each time point in the queried time range. +// Each time point decomposes overall load in relation to the requested dimensions, +// measured at that time point. Examples include SQL, Wait event, User, and +// Host. +// +// * To learn more about Performance Insights and Amazon Aurora DB instances, +// go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). +// +// * To learn more about Performance Insights and Amazon RDS DB instances, +// go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +type PerformanceInsightsMetricsDetail struct { + _ struct{} `type:"structure"` - // The severity of a proactive anomaly. - Severity *string `type:"string" enum:"AnomalySeverity"` + // The name used for a specific Performance Insights metric. + MetricDisplayName *string `type:"string"` - // Details about the source of the analyzed operational data that triggered - // the anomaly. The one supported source is Amazon CloudWatch metrics. - SourceDetails *AnomalySourceDetails `type:"structure"` + // A single query to be processed for the metric. For more information, see + // PerformanceInsightsMetricQuery (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsMetricQuery.html) . + MetricQuery *PerformanceInsightsMetricQuery `type:"structure"` - // The status of a proactive anomaly. - Status *string `type:"string" enum:"AnomalyStatus"` + // For more information, see PerformanceInsightsReferenceData (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceData.html) . + ReferenceData []*PerformanceInsightsReferenceData `type:"list"` - // The time of the anomaly's most recent update. - UpdateTime *time.Time `type:"timestamp"` + // The metric statistics during the anomalous period detected by DevOps Guru; + StatsAtAnomaly []*PerformanceInsightsStat `type:"list"` + + // Typical metric statistics that are not considered anomalous. When DevOps + // Guru analyzes metrics, it compares them to StatsAtBaseline to help determine + // if they are anomalous. + StatsAtBaseline []*PerformanceInsightsStat `type:"list"` + + // The unit of measure for a metric. For example, a session or a process. + Unit *string `type:"string"` } // String returns the string representation. @@ -7308,7 +7643,7 @@ type ProactiveAnomaly 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 ProactiveAnomaly) String() string { +func (s PerformanceInsightsMetricsDetail) String() string { return awsutil.Prettify(s) } @@ -7317,73 +7652,422 @@ func (s ProactiveAnomaly) 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 ProactiveAnomaly) GoString() string { +func (s PerformanceInsightsMetricsDetail) GoString() string { return s.String() } -// SetAnomalyReportedTimeRange sets the AnomalyReportedTimeRange field's value. -func (s *ProactiveAnomaly) SetAnomalyReportedTimeRange(v *AnomalyReportedTimeRange) *ProactiveAnomaly { - s.AnomalyReportedTimeRange = v +// SetMetricDisplayName sets the MetricDisplayName field's value. +func (s *PerformanceInsightsMetricsDetail) SetMetricDisplayName(v string) *PerformanceInsightsMetricsDetail { + s.MetricDisplayName = &v return s } -// SetAnomalyTimeRange sets the AnomalyTimeRange field's value. -func (s *ProactiveAnomaly) SetAnomalyTimeRange(v *AnomalyTimeRange) *ProactiveAnomaly { - s.AnomalyTimeRange = v +// SetMetricQuery sets the MetricQuery field's value. +func (s *PerformanceInsightsMetricsDetail) SetMetricQuery(v *PerformanceInsightsMetricQuery) *PerformanceInsightsMetricsDetail { + s.MetricQuery = v return s } -// SetAssociatedInsightId sets the AssociatedInsightId field's value. -func (s *ProactiveAnomaly) SetAssociatedInsightId(v string) *ProactiveAnomaly { - s.AssociatedInsightId = &v +// SetReferenceData sets the ReferenceData field's value. +func (s *PerformanceInsightsMetricsDetail) SetReferenceData(v []*PerformanceInsightsReferenceData) *PerformanceInsightsMetricsDetail { + s.ReferenceData = v return s } -// SetId sets the Id field's value. -func (s *ProactiveAnomaly) SetId(v string) *ProactiveAnomaly { - s.Id = &v +// SetStatsAtAnomaly sets the StatsAtAnomaly field's value. +func (s *PerformanceInsightsMetricsDetail) SetStatsAtAnomaly(v []*PerformanceInsightsStat) *PerformanceInsightsMetricsDetail { + s.StatsAtAnomaly = v return s } -// SetLimit sets the Limit field's value. -func (s *ProactiveAnomaly) SetLimit(v float64) *ProactiveAnomaly { - s.Limit = &v +// SetStatsAtBaseline sets the StatsAtBaseline field's value. +func (s *PerformanceInsightsMetricsDetail) SetStatsAtBaseline(v []*PerformanceInsightsStat) *PerformanceInsightsMetricsDetail { + s.StatsAtBaseline = v return s } -// SetPredictionTimeRange sets the PredictionTimeRange field's value. -func (s *ProactiveAnomaly) SetPredictionTimeRange(v *PredictionTimeRange) *ProactiveAnomaly { - s.PredictionTimeRange = v +// SetUnit sets the Unit field's value. +func (s *PerformanceInsightsMetricsDetail) SetUnit(v string) *PerformanceInsightsMetricsDetail { + s.Unit = &v return s } -// SetResourceCollection sets the ResourceCollection field's value. -func (s *ProactiveAnomaly) SetResourceCollection(v *ResourceCollection) *ProactiveAnomaly { - s.ResourceCollection = v - return s +// Reference scalar values and other metrics that DevOps Guru displays on a +// graph in its console along with the actual metrics it analyzed. Compare these +// reference values to your actual metrics to help you understand anomalous +// behavior that DevOps Guru detected. +type PerformanceInsightsReferenceComparisonValues struct { + _ struct{} `type:"structure"` + + // A metric that DevOps Guru compares to actual metric values. This reference + // metric is used to determine if an actual metric should be considered anomalous. + ReferenceMetric *PerformanceInsightsReferenceMetric `type:"structure"` + + // A scalar value DevOps Guru for a metric that DevOps Guru compares to actual + // metric values. This reference value is used to determine if an actual metric + // value should be considered anomalous. + ReferenceScalar *PerformanceInsightsReferenceScalar `type:"structure"` } -// SetSeverity sets the Severity field's value. -func (s *ProactiveAnomaly) SetSeverity(v string) *ProactiveAnomaly { - s.Severity = &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 PerformanceInsightsReferenceComparisonValues) String() string { + return awsutil.Prettify(s) } -// SetSourceDetails sets the SourceDetails field's value. -func (s *ProactiveAnomaly) SetSourceDetails(v *AnomalySourceDetails) *ProactiveAnomaly { - s.SourceDetails = 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 PerformanceInsightsReferenceComparisonValues) GoString() string { + return s.String() } -// SetStatus sets the Status field's value. -func (s *ProactiveAnomaly) SetStatus(v string) *ProactiveAnomaly { - s.Status = &v +// SetReferenceMetric sets the ReferenceMetric field's value. +func (s *PerformanceInsightsReferenceComparisonValues) SetReferenceMetric(v *PerformanceInsightsReferenceMetric) *PerformanceInsightsReferenceComparisonValues { + s.ReferenceMetric = v return s } -// SetUpdateTime sets the UpdateTime field's value. -func (s *ProactiveAnomaly) SetUpdateTime(v time.Time) *ProactiveAnomaly { - s.UpdateTime = &v +// SetReferenceScalar sets the ReferenceScalar field's value. +func (s *PerformanceInsightsReferenceComparisonValues) SetReferenceScalar(v *PerformanceInsightsReferenceScalar) *PerformanceInsightsReferenceComparisonValues { + s.ReferenceScalar = v + return s +} + +// Reference data used to evaluate Performance Insights to determine if its +// performance is anomalous or not. +type PerformanceInsightsReferenceData struct { + _ struct{} `type:"structure"` + + // The specific reference values used to evaluate the Performance Insights. + // For more information, see PerformanceInsightsReferenceComparisonValues (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html) . + ComparisonValues *PerformanceInsightsReferenceComparisonValues `type:"structure"` + + // The name of the reference data. + Name *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 PerformanceInsightsReferenceData) 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 PerformanceInsightsReferenceData) GoString() string { + return s.String() +} + +// SetComparisonValues sets the ComparisonValues field's value. +func (s *PerformanceInsightsReferenceData) SetComparisonValues(v *PerformanceInsightsReferenceComparisonValues) *PerformanceInsightsReferenceData { + s.ComparisonValues = v + return s +} + +// SetName sets the Name field's value. +func (s *PerformanceInsightsReferenceData) SetName(v string) *PerformanceInsightsReferenceData { + s.Name = &v + return s +} + +// Information about a reference metric used to evaluate Performance Insights. +type PerformanceInsightsReferenceMetric struct { + _ struct{} `type:"structure"` + + // A query to be processed on the metric. + MetricQuery *PerformanceInsightsMetricQuery `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 PerformanceInsightsReferenceMetric) 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 PerformanceInsightsReferenceMetric) GoString() string { + return s.String() +} + +// SetMetricQuery sets the MetricQuery field's value. +func (s *PerformanceInsightsReferenceMetric) SetMetricQuery(v *PerformanceInsightsMetricQuery) *PerformanceInsightsReferenceMetric { + s.MetricQuery = v + return s +} + +// A reference value to compare Performance Insights metrics against to determine +// if the metrics demonstrate anomalous behavior. +type PerformanceInsightsReferenceScalar struct { + _ struct{} `type:"structure"` + + // The reference value. + Value *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 PerformanceInsightsReferenceScalar) 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 PerformanceInsightsReferenceScalar) GoString() string { + return s.String() +} + +// SetValue sets the Value field's value. +func (s *PerformanceInsightsReferenceScalar) SetValue(v float64) *PerformanceInsightsReferenceScalar { + s.Value = &v + return s +} + +// A statistic in a Performance Insights collection. +type PerformanceInsightsStat struct { + _ struct{} `type:"structure"` + + // The statistic type. + Type *string `type:"string"` + + // The value of the statistic. + Value *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 PerformanceInsightsStat) 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 PerformanceInsightsStat) GoString() string { + return s.String() +} + +// SetType sets the Type field's value. +func (s *PerformanceInsightsStat) SetType(v string) *PerformanceInsightsStat { + s.Type = &v + return s +} + +// SetValue sets the Value field's value. +func (s *PerformanceInsightsStat) SetValue(v float64) *PerformanceInsightsStat { + s.Value = &v + return s +} + +// The time range during which anomalous behavior in a proactive anomaly or +// an insight is expected to occur. +type PredictionTimeRange struct { + _ struct{} `type:"structure"` + + // The time when the behavior in a proactive insight is expected to end. + EndTime *time.Time `type:"timestamp"` + + // The time range during which a metric limit is expected to be exceeded. This + // applies to proactive insights only. + // + // StartTime is a required field + StartTime *time.Time `type:"timestamp" 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 PredictionTimeRange) 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 PredictionTimeRange) GoString() string { + return s.String() +} + +// SetEndTime sets the EndTime field's value. +func (s *PredictionTimeRange) SetEndTime(v time.Time) *PredictionTimeRange { + s.EndTime = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *PredictionTimeRange) SetStartTime(v time.Time) *PredictionTimeRange { + s.StartTime = &v + return s +} + +// Information about an anomaly. This object is returned by ListAnomalies. +type ProactiveAnomaly struct { + _ struct{} `type:"structure"` + + // An AnomalyReportedTimeRange object that specifies the time range between + // when the anomaly is opened and the time when it is closed. + AnomalyReportedTimeRange *AnomalyReportedTimeRange `type:"structure"` + + // A time range that specifies when the observed unusual behavior in an anomaly + // started and ended. This is different from AnomalyReportedTimeRange, which + // specifies the time range when DevOps Guru opens and then closes an anomaly. + AnomalyTimeRange *AnomalyTimeRange `type:"structure"` + + // The ID of the insight that contains this anomaly. An insight is composed + // of related anomalies. + AssociatedInsightId *string `min:"1" type:"string"` + + // The ID of a proactive anomaly. + Id *string `min:"1" type:"string"` + + // A threshold that was exceeded by behavior in analyzed resources. Exceeding + // this threshold is related to the anomalous behavior that generated this anomaly. + Limit *float64 `type:"double"` + + // The time range during which anomalous behavior in a proactive anomaly or + // an insight is expected to occur. + PredictionTimeRange *PredictionTimeRange `type:"structure"` + + // A collection of Amazon Web Services resources supported by DevOps Guru. The + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. + ResourceCollection *ResourceCollection `type:"structure"` + + // The severity of the anomaly. The severity of anomalies that generate an insight + // determine that insight's severity. For more information, see Understanding + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. + Severity *string `type:"string" enum:"AnomalySeverity"` + + // Details about the source of the analyzed operational data that triggered + // the anomaly. The one supported source is Amazon CloudWatch metrics. + SourceDetails *AnomalySourceDetails `type:"structure"` + + // The status of a proactive anomaly. + Status *string `type:"string" enum:"AnomalyStatus"` + + // The time of the anomaly's most recent update. + UpdateTime *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 ProactiveAnomaly) 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 ProactiveAnomaly) GoString() string { + return s.String() +} + +// SetAnomalyReportedTimeRange sets the AnomalyReportedTimeRange field's value. +func (s *ProactiveAnomaly) SetAnomalyReportedTimeRange(v *AnomalyReportedTimeRange) *ProactiveAnomaly { + s.AnomalyReportedTimeRange = v + return s +} + +// SetAnomalyTimeRange sets the AnomalyTimeRange field's value. +func (s *ProactiveAnomaly) SetAnomalyTimeRange(v *AnomalyTimeRange) *ProactiveAnomaly { + s.AnomalyTimeRange = v + return s +} + +// SetAssociatedInsightId sets the AssociatedInsightId field's value. +func (s *ProactiveAnomaly) SetAssociatedInsightId(v string) *ProactiveAnomaly { + s.AssociatedInsightId = &v + return s +} + +// SetId sets the Id field's value. +func (s *ProactiveAnomaly) SetId(v string) *ProactiveAnomaly { + s.Id = &v + return s +} + +// SetLimit sets the Limit field's value. +func (s *ProactiveAnomaly) SetLimit(v float64) *ProactiveAnomaly { + s.Limit = &v + return s +} + +// SetPredictionTimeRange sets the PredictionTimeRange field's value. +func (s *ProactiveAnomaly) SetPredictionTimeRange(v *PredictionTimeRange) *ProactiveAnomaly { + s.PredictionTimeRange = v + return s +} + +// SetResourceCollection sets the ResourceCollection field's value. +func (s *ProactiveAnomaly) SetResourceCollection(v *ResourceCollection) *ProactiveAnomaly { + s.ResourceCollection = v + return s +} + +// SetSeverity sets the Severity field's value. +func (s *ProactiveAnomaly) SetSeverity(v string) *ProactiveAnomaly { + s.Severity = &v + return s +} + +// SetSourceDetails sets the SourceDetails field's value. +func (s *ProactiveAnomaly) SetSourceDetails(v *AnomalySourceDetails) *ProactiveAnomaly { + s.SourceDetails = v + return s +} + +// SetStatus sets the Status field's value. +func (s *ProactiveAnomaly) SetStatus(v string) *ProactiveAnomaly { + s.Status = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ProactiveAnomaly) SetUpdateTime(v time.Time) *ProactiveAnomaly { + s.UpdateTime = &v return s } @@ -7391,8 +8075,8 @@ func (s *ProactiveAnomaly) SetUpdateTime(v time.Time) *ProactiveAnomaly { type ProactiveAnomalySummary struct { _ struct{} `type:"structure"` - // A AnomalyReportedTimeRange object that specifies the time range between when - // the anomaly is opened and the time when it is closed. + // An AnomalyReportedTimeRange object that specifies the time range between + // when the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange `type:"structure"` // A time range that specifies when the observed unusual behavior in an anomaly @@ -7416,13 +8100,18 @@ type ProactiveAnomalySummary struct { PredictionTimeRange *PredictionTimeRange `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` - // The severity of the anomaly. + // The severity of the anomaly. The severity of anomalies that generate an insight + // determine that insight's severity. For more information, see Understanding + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"AnomalySeverity"` // Details about the source of the analyzed operational data that triggered @@ -7539,13 +8228,17 @@ type ProactiveInsight struct { PredictionTimeRange *PredictionTimeRange `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` - // The severity of the proactive insight. + // The severity of the insight. For more information, see Understanding insight + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // The ID of the Amazon Web Services System Manager OpsItem created for this @@ -7627,6 +8320,10 @@ func (s *ProactiveInsight) SetStatus(v string) *ProactiveInsight { type ProactiveInsightSummary struct { _ struct{} `type:"structure"` + // The Amazon Resource Names (ARNs) of the Amazon Web Services resources that + // generated this insight. + AssociatedResourceArns []*string `type:"list"` + // The ID of the proactive insight. Id *string `min:"1" type:"string"` @@ -7642,16 +8339,20 @@ type ProactiveInsightSummary struct { PredictionTimeRange *PredictionTimeRange `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection `type:"structure"` - // The severity of the proactive insight. + // The severity of the insight. For more information, see Understanding insight + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // The status of the proactive insight. @@ -7676,6 +8377,12 @@ func (s ProactiveInsightSummary) GoString() string { return s.String() } +// SetAssociatedResourceArns sets the AssociatedResourceArns field's value. +func (s *ProactiveInsightSummary) SetAssociatedResourceArns(v []*string) *ProactiveInsightSummary { + s.AssociatedResourceArns = v + return s +} + // SetId sets the Id field's value. func (s *ProactiveInsightSummary) SetId(v string) *ProactiveInsightSummary { s.Id = &v @@ -7749,16 +8456,20 @@ type ProactiveOrganizationInsightSummary struct { PredictionTimeRange *PredictionTimeRange `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection `type:"structure"` - // An array of severity values used to search for insights. + // An array of severity values used to search for insights. For more information, + // see Understanding insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // An array of status values used to search for insights. @@ -7915,10 +8626,14 @@ func (s PutFeedbackOutput) GoString() string { type ReactiveAnomaly struct { _ struct{} `type:"structure"` - // A AnomalyReportedTimeRange object that specifies the time range between when - // the anomaly is opened and the time when it is closed. + // An AnomalyReportedTimeRange object that specifies the time range between + // when the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange `type:"structure"` + // The Amazon Web Services resources in which anomalous behavior was detected + // by DevOps Guru. + AnomalyResources []*AnomalyResource `type:"list"` + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange, which // specifies the time range when DevOps Guru opens and then closes an anomaly. @@ -7928,17 +8643,32 @@ type ReactiveAnomaly struct { // of related anomalies. AssociatedInsightId *string `min:"1" type:"string"` + // The ID of the causal anomaly that is associated with this reactive anomaly. + // The ID of a `CAUSAL` anomaly is always `NULL`. + CausalAnomalyId *string `min:"1" type:"string"` + + // A description of the reactive anomaly. + Description *string `type:"string"` + // The ID of the reactive anomaly. Id *string `min:"1" type:"string"` + // The name of the reactive anomaly. + Name *string `type:"string"` + // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` - // The severity of the anomaly. + // The severity of the anomaly. The severity of anomalies that generate an insight + // determine that insight's severity. For more information, see Understanding + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"AnomalySeverity"` // Details about the source of the analyzed operational data that triggered @@ -7947,6 +8677,14 @@ type ReactiveAnomaly struct { // The status of the anomaly. Status *string `type:"string" enum:"AnomalyStatus"` + + // The type of the reactive anomaly. It can be one of the following types. + // + // * CAUSAL - the anomaly can cause a new insight. + // + // * CONTEXTUAL - the anomaly contains additional information about an insight + // or its causal anomaly. + Type *string `type:"string" enum:"AnomalyType"` } // String returns the string representation. @@ -7973,6 +8711,12 @@ func (s *ReactiveAnomaly) SetAnomalyReportedTimeRange(v *AnomalyReportedTimeRang return s } +// SetAnomalyResources sets the AnomalyResources field's value. +func (s *ReactiveAnomaly) SetAnomalyResources(v []*AnomalyResource) *ReactiveAnomaly { + s.AnomalyResources = v + return s +} + // SetAnomalyTimeRange sets the AnomalyTimeRange field's value. func (s *ReactiveAnomaly) SetAnomalyTimeRange(v *AnomalyTimeRange) *ReactiveAnomaly { s.AnomalyTimeRange = v @@ -7985,12 +8729,30 @@ func (s *ReactiveAnomaly) SetAssociatedInsightId(v string) *ReactiveAnomaly { return s } +// SetCausalAnomalyId sets the CausalAnomalyId field's value. +func (s *ReactiveAnomaly) SetCausalAnomalyId(v string) *ReactiveAnomaly { + s.CausalAnomalyId = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ReactiveAnomaly) SetDescription(v string) *ReactiveAnomaly { + s.Description = &v + return s +} + // SetId sets the Id field's value. func (s *ReactiveAnomaly) SetId(v string) *ReactiveAnomaly { s.Id = &v return s } +// SetName sets the Name field's value. +func (s *ReactiveAnomaly) SetName(v string) *ReactiveAnomaly { + s.Name = &v + return s +} + // SetResourceCollection sets the ResourceCollection field's value. func (s *ReactiveAnomaly) SetResourceCollection(v *ResourceCollection) *ReactiveAnomaly { s.ResourceCollection = v @@ -8015,14 +8777,24 @@ func (s *ReactiveAnomaly) SetStatus(v string) *ReactiveAnomaly { return s } +// SetType sets the Type field's value. +func (s *ReactiveAnomaly) SetType(v string) *ReactiveAnomaly { + s.Type = &v + return s +} + // Details about a reactive anomaly. This object is returned by DescribeAnomaly. type ReactiveAnomalySummary struct { _ struct{} `type:"structure"` - // A AnomalyReportedTimeRange object that specifies the time range between when - // the anomaly is opened and the time when it is closed. + // An AnomalyReportedTimeRange object that specifies the time range between + // when the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange `type:"structure"` + // The Amazon Web Services resources in which anomalous behavior was detected + // by DevOps Guru. + AnomalyResources []*AnomalyResource `type:"list"` + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange, which // specifies the time range when DevOps Guru opens and then closes an anomaly. @@ -8032,17 +8804,32 @@ type ReactiveAnomalySummary struct { // of related anomalies. AssociatedInsightId *string `min:"1" type:"string"` + // The ID of the causal anomaly that is associated with this reactive anomaly. + // The ID of a `CAUSAL` anomaly is always `NULL`. + CausalAnomalyId *string `min:"1" type:"string"` + + // A description of the reactive anomaly. + Description *string `type:"string"` + // The ID of the reactive anomaly. Id *string `min:"1" type:"string"` + // The name of the reactive anomaly. + Name *string `type:"string"` + // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` - // The severity of the reactive anomaly. + // The severity of the anomaly. The severity of anomalies that generate an insight + // determine that insight's severity. For more information, see Understanding + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"AnomalySeverity"` // Details about the source of the analyzed operational data that triggered @@ -8051,6 +8838,14 @@ type ReactiveAnomalySummary struct { // The status of the reactive anomaly. Status *string `type:"string" enum:"AnomalyStatus"` + + // The type of the reactive anomaly. It can be one of the following types. + // + // * CAUSAL - the anomaly can cause a new insight. + // + // * CONTEXTUAL - the anomaly contains additional information about an insight + // or its causal anomaly. + Type *string `type:"string" enum:"AnomalyType"` } // String returns the string representation. @@ -8077,6 +8872,12 @@ func (s *ReactiveAnomalySummary) SetAnomalyReportedTimeRange(v *AnomalyReportedT return s } +// SetAnomalyResources sets the AnomalyResources field's value. +func (s *ReactiveAnomalySummary) SetAnomalyResources(v []*AnomalyResource) *ReactiveAnomalySummary { + s.AnomalyResources = v + return s +} + // SetAnomalyTimeRange sets the AnomalyTimeRange field's value. func (s *ReactiveAnomalySummary) SetAnomalyTimeRange(v *AnomalyTimeRange) *ReactiveAnomalySummary { s.AnomalyTimeRange = v @@ -8089,12 +8890,30 @@ func (s *ReactiveAnomalySummary) SetAssociatedInsightId(v string) *ReactiveAnoma return s } +// SetCausalAnomalyId sets the CausalAnomalyId field's value. +func (s *ReactiveAnomalySummary) SetCausalAnomalyId(v string) *ReactiveAnomalySummary { + s.CausalAnomalyId = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ReactiveAnomalySummary) SetDescription(v string) *ReactiveAnomalySummary { + s.Description = &v + return s +} + // SetId sets the Id field's value. func (s *ReactiveAnomalySummary) SetId(v string) *ReactiveAnomalySummary { s.Id = &v return s } +// SetName sets the Name field's value. +func (s *ReactiveAnomalySummary) SetName(v string) *ReactiveAnomalySummary { + s.Name = &v + return s +} + // SetResourceCollection sets the ResourceCollection field's value. func (s *ReactiveAnomalySummary) SetResourceCollection(v *ResourceCollection) *ReactiveAnomalySummary { s.ResourceCollection = v @@ -8119,6 +8938,12 @@ func (s *ReactiveAnomalySummary) SetStatus(v string) *ReactiveAnomalySummary { return s } +// SetType sets the Type field's value. +func (s *ReactiveAnomalySummary) SetType(v string) *ReactiveAnomalySummary { + s.Type = &v + return s +} + // Information about a reactive insight. This object is returned by ListInsights. type ReactiveInsight struct { _ struct{} `type:"structure"` @@ -8134,13 +8959,17 @@ type ReactiveInsight struct { Name *string `min:"1" type:"string"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` - // The severity of a reactive insight. + // The severity of the insight. For more information, see Understanding insight + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // The ID of the Amazon Web Services System Manager OpsItem created for this @@ -8216,6 +9045,10 @@ func (s *ReactiveInsight) SetStatus(v string) *ReactiveInsight { type ReactiveInsightSummary struct { _ struct{} `type:"structure"` + // The Amazon Resource Names (ARNs) of the Amazon Web Services resources that + // generated this insight. + AssociatedResourceArns []*string `type:"list"` + // The ID of a reactive summary. Id *string `min:"1" type:"string"` @@ -8227,16 +9060,20 @@ type ReactiveInsightSummary struct { Name *string `min:"1" type:"string"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection `type:"structure"` - // The severity of a reactive insight. + // The severity of the insight. For more information, see Understanding insight + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // The status of a reactive insight. @@ -8261,6 +9098,12 @@ func (s ReactiveInsightSummary) GoString() string { return s.String() } +// SetAssociatedResourceArns sets the AssociatedResourceArns field's value. +func (s *ReactiveInsightSummary) SetAssociatedResourceArns(v []*string) *ReactiveInsightSummary { + s.AssociatedResourceArns = v + return s +} + // SetId sets the Id field's value. func (s *ReactiveInsightSummary) SetId(v string) *ReactiveInsightSummary { s.Id = &v @@ -8324,16 +9167,20 @@ type ReactiveOrganizationInsightSummary struct { OrganizationalUnitId *string `type:"string"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection `type:"structure"` - // An array of severity values used to search for insights. + // An array of severity values used to search for insights. For more information, + // see Understanding insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // in the Amazon DevOps Guru User Guide. Severity *string `type:"string" enum:"InsightSeverity"` // An array of status values used to search for insights. @@ -8496,6 +9343,9 @@ func (s *Recommendation) SetRelatedEvents(v []*RecommendationRelatedEvent) *Reco type RecommendationRelatedAnomaly struct { _ struct{} `type:"structure"` + // The ID of an anomaly that generated the insight with this recommendation. + AnomalyId *string `min:"1" type:"string"` + // An array of objects that represent resources in which DevOps Guru detected // anomalous behavior. Each object contains the name and type of the resource. Resources []*RecommendationRelatedAnomalyResource `type:"list"` @@ -8523,6 +9373,12 @@ func (s RecommendationRelatedAnomaly) GoString() string { return s.String() } +// SetAnomalyId sets the AnomalyId field's value. +func (s *RecommendationRelatedAnomaly) SetAnomalyId(v string) *RecommendationRelatedAnomaly { + s.AnomalyId = &v + return s +} + // SetResources sets the Resources field's value. func (s *RecommendationRelatedAnomaly) SetResources(v []*RecommendationRelatedAnomalyResource) *RecommendationRelatedAnomaly { s.Resources = v @@ -8542,7 +9398,11 @@ type RecommendationRelatedAnomalyResource struct { // The name of the resource. Name *string `type:"string"` - // The type of the resource. + // The type of the resource. Resource types take the same form that is used + // by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name. + // For example, AWS::RDS::DBCluster. For more information, see Amazon Web Services + // resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // in the Amazon Web Services CloudFormation User Guide. Type *string `type:"string"` } @@ -8812,10 +9672,12 @@ func (s RemoveNotificationChannelOutput) GoString() string { } // A collection of Amazon Web Services resources supported by DevOps Guru. The -// one type of Amazon Web Services resource collection supported is Amazon Web -// Services CloudFormation stacks. DevOps Guru can be configured to analyze -// only the Amazon Web Services resources that are defined in the stacks. You -// can specify up to 500 Amazon Web Services CloudFormation stacks. +// two types of Amazon Web Services resource collections supported are Amazon +// Web Services CloudFormation stacks and Amazon Web Services resources that +// contain the same Amazon Web Services tag. DevOps Guru can be configured to +// analyze the Amazon Web Services resources that are defined in the stacks +// or that are tagged using the same tag key. You can specify up to 500 Amazon +// Web Services CloudFormation stacks. type ResourceCollection struct { _ struct{} `type:"structure"` @@ -8823,6 +9685,36 @@ type ResourceCollection struct { // define Amazon Web Services resources that DevOps Guru analyzes. You can specify // up to 500 Amazon Web Services CloudFormation stacks. CloudFormation *CloudFormationCollection `type:"structure"` + + // The Amazon Web Services tags that are used by resources in the resource collection. + // + // Tags help you identify and organize your Amazon Web Services resources. Many + // Amazon Web Services services support tagging, so you can assign the same + // tag to resources from different services to indicate that the resources are + // related. For example, you can assign the same tag to an Amazon DynamoDB table + // resource that you assign to an Lambda function. For more information about + // using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) + // whitepaper. + // + // Each Amazon Web Services tag has two parts. + // + // * A tag key (for example, CostCenter, Environment, Project, or Secret). + // Tag keys are case-sensitive. + // + // * An optional field known as a tag value (for example, 111122223333, Production, + // or a team name). Omitting the tag value is the same as using an empty + // string. Like tag keys, tag values are case-sensitive. + // + // Together these are known as key-value pairs. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + Tags []*TagCollection `type:"list"` } // String returns the string representation. @@ -8843,12 +9735,38 @@ func (s ResourceCollection) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ResourceCollection) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResourceCollection"} + 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 +} + // SetCloudFormation sets the CloudFormation field's value. func (s *ResourceCollection) SetCloudFormation(v *CloudFormationCollection) *ResourceCollection { s.CloudFormation = v return s } +// SetTags sets the Tags field's value. +func (s *ResourceCollection) SetTags(v []*TagCollection) *ResourceCollection { + s.Tags = v + return s +} + // Information about a filter used to specify which Amazon Web Services resources // are analyzed for anomalous behavior by DevOps Guru. type ResourceCollectionFilter struct { @@ -8859,6 +9777,37 @@ type ResourceCollectionFilter struct { // to analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) // in the Amazon Web Services CloudFormation User Guide. CloudFormation *CloudFormationCollectionFilter `type:"structure"` + + // The Amazon Web Services tags used to filter the resources in the resource + // collection. + // + // Tags help you identify and organize your Amazon Web Services resources. Many + // Amazon Web Services services support tagging, so you can assign the same + // tag to resources from different services to indicate that the resources are + // related. For example, you can assign the same tag to an Amazon DynamoDB table + // resource that you assign to an Lambda function. For more information about + // using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) + // whitepaper. + // + // Each Amazon Web Services tag has two parts. + // + // * A tag key (for example, CostCenter, Environment, Project, or Secret). + // Tag keys are case-sensitive. + // + // * An optional field known as a tag value (for example, 111122223333, Production, + // or a team name). Omitting the tag value is the same as using an empty + // string. Like tag keys, tag values are case-sensitive. + // + // Together these are known as key-value pairs. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + Tags []*TagCollectionFilter `type:"list"` } // String returns the string representation. @@ -8885,6 +9834,12 @@ func (s *ResourceCollectionFilter) SetCloudFormation(v *CloudFormationCollection return s } +// SetTags sets the Tags field's value. +func (s *ResourceCollectionFilter) SetTags(v []*TagCollectionFilter) *ResourceCollectionFilter { + s.Tags = v + return s +} + // A requested resource could not be found type ResourceNotFoundException struct { _ struct{} `type:"structure"` @@ -8965,10 +9920,12 @@ type SearchInsightsFilters struct { _ struct{} `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. @@ -8999,6 +9956,21 @@ func (s SearchInsightsFilters) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchInsightsFilters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchInsightsFilters"} + if s.ResourceCollection != nil { + if err := s.ResourceCollection.Validate(); err != nil { + invalidParams.AddNested("ResourceCollection", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetResourceCollection sets the ResourceCollection field's value. func (s *SearchInsightsFilters) SetResourceCollection(v *ResourceCollection) *SearchInsightsFilters { s.ResourceCollection = v @@ -9083,6 +10055,11 @@ func (s *SearchInsightsInput) Validate() error { if s.Type == nil { invalidParams.Add(request.NewErrParamRequired("Type")) } + if s.Filters != nil { + if err := s.Filters.Validate(); err != nil { + invalidParams.AddNested("Filters", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9176,10 +10153,12 @@ type SearchOrganizationInsightsFilters struct { _ struct{} `type:"structure"` // A collection of Amazon Web Services resources supported by DevOps Guru. The - // one type of Amazon Web Services resource collection supported is Amazon Web - // Services CloudFormation stacks. DevOps Guru can be configured to analyze - // only the Amazon Web Services resources that are defined in the stacks. You - // can specify up to 500 Amazon Web Services CloudFormation stacks. + // two types of Amazon Web Services resource collections supported are Amazon + // Web Services CloudFormation stacks and Amazon Web Services resources that + // contain the same Amazon Web Services tag. DevOps Guru can be configured to + // analyze the Amazon Web Services resources that are defined in the stacks + // or that are tagged using the same tag key. You can specify up to 500 Amazon + // Web Services CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // A collection of the names of Amazon Web Services services. @@ -9210,6 +10189,21 @@ func (s SearchOrganizationInsightsFilters) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchOrganizationInsightsFilters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchOrganizationInsightsFilters"} + if s.ResourceCollection != nil { + if err := s.ResourceCollection.Validate(); err != nil { + invalidParams.AddNested("ResourceCollection", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetResourceCollection sets the ResourceCollection field's value. func (s *SearchOrganizationInsightsFilters) SetResourceCollection(v *ResourceCollection) *SearchOrganizationInsightsFilters { s.ResourceCollection = v @@ -9304,6 +10298,11 @@ func (s *SearchOrganizationInsightsInput) Validate() error { if s.Type == nil { invalidParams.Add(request.NewErrParamRequired("Type")) } + if s.Filters != nil { + if err := s.Filters.Validate(); err != nil { + invalidParams.AddNested("Filters", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9877,6 +10876,340 @@ func (s *StartTimeRange) SetToTime(v time.Time) *StartTimeRange { return s } +// A collection of Amazon Web Services stags. +// +// Tags help you identify and organize your Amazon Web Services resources. Many +// Amazon Web Services services support tagging, so you can assign the same +// tag to resources from different services to indicate that the resources are +// related. For example, you can assign the same tag to an Amazon DynamoDB table +// resource that you assign to an Lambda function. For more information about +// using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) +// whitepaper. +// +// Each Amazon Web Services tag has two parts. +// +// * A tag key (for example, CostCenter, Environment, Project, or Secret). +// Tag keys are case-sensitive. +// +// * An optional field known as a tag value (for example, 111122223333, Production, +// or a team name). Omitting the tag value is the same as using an empty +// string. Like tag keys, tag values are case-sensitive. +// +// Together these are known as key-value pairs. +// +// The string used for a key in a tag that you use to define your resource coverage +// must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application +// or Devops-guru-rds-application. While keys are case-sensitive, the case of +// key characters don't matter to DevOps Guru. For example, DevOps Guru works +// with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible +// key/value pairs in your application might be Devops-Guru-production-application/RDS +// or Devops-Guru-production-application/containers. +type TagCollection struct { + _ struct{} `type:"structure"` + + // An Amazon Web Services tag key that is used to identify the Amazon Web Services + // resources that DevOps Guru analyzes. All Amazon Web Services resources in + // your account and Region tagged with this key make up your DevOps Guru application + // and analysis boundary. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + // + // AppBoundaryKey is a required field + AppBoundaryKey *string `min:"1" type:"string" required:"true"` + + // The values in an Amazon Web Services tag collection. + // + // The tag's value is an optional field used to associate a string with the + // tag key (for example, 111122223333, Production, or a team name). The key + // and value are the tag's key pair. Omitting the tag value is the same as using + // an empty string. Like tag keys, tag values are case-sensitive. You can specify + // a maximum of 256 characters for a tag value. + // + // TagValues is a required field + TagValues []*string `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 TagCollection) 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 TagCollection) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagCollection) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagCollection"} + if s.AppBoundaryKey == nil { + invalidParams.Add(request.NewErrParamRequired("AppBoundaryKey")) + } + if s.AppBoundaryKey != nil && len(*s.AppBoundaryKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AppBoundaryKey", 1)) + } + if s.TagValues == nil { + invalidParams.Add(request.NewErrParamRequired("TagValues")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppBoundaryKey sets the AppBoundaryKey field's value. +func (s *TagCollection) SetAppBoundaryKey(v string) *TagCollection { + s.AppBoundaryKey = &v + return s +} + +// SetTagValues sets the TagValues field's value. +func (s *TagCollection) SetTagValues(v []*string) *TagCollection { + s.TagValues = v + return s +} + +// A collection of Amazon Web Services tags used to filter insights. This is +// used to return insights generated from only resources that contain the tags +// in the tag collection. +type TagCollectionFilter struct { + _ struct{} `type:"structure"` + + // An Amazon Web Services tag key that is used to identify the Amazon Web Services + // resources that DevOps Guru analyzes. All Amazon Web Services resources in + // your account and Region tagged with this key make up your DevOps Guru application + // and analysis boundary. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + // + // AppBoundaryKey is a required field + AppBoundaryKey *string `min:"1" type:"string" required:"true"` + + // The values in an Amazon Web Services tag collection. + // + // The tag's value is an optional field used to associate a string with the + // tag key (for example, 111122223333, Production, or a team name). The key + // and value are the tag's key pair. Omitting the tag value is the same as using + // an empty string. Like tag keys, tag values are case-sensitive. You can specify + // a maximum of 256 characters for a tag value. + // + // TagValues is a required field + TagValues []*string `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 TagCollectionFilter) 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 TagCollectionFilter) GoString() string { + return s.String() +} + +// SetAppBoundaryKey sets the AppBoundaryKey field's value. +func (s *TagCollectionFilter) SetAppBoundaryKey(v string) *TagCollectionFilter { + s.AppBoundaryKey = &v + return s +} + +// SetTagValues sets the TagValues field's value. +func (s *TagCollectionFilter) SetTagValues(v []*string) *TagCollectionFilter { + s.TagValues = v + return s +} + +// Information about a collection of Amazon Web Services resources that are +// identified by an Amazon Web Services tag. This collection of resources is +// used to create a monthly cost estimate for DevOps Guru to analyze Amazon +// Web Services resources. The maximum number of tags you can specify for a +// cost estimate is one. The estimate created is for the cost to analyze the +// Amazon Web Services resources defined by the tag. For more information, see +// Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the Amazon Web Services CloudFormation User Guide. +type TagCostEstimationResourceCollectionFilter struct { + _ struct{} `type:"structure"` + + // An Amazon Web Services tag key that is used to identify the Amazon Web Services + // resources that DevOps Guru analyzes. All Amazon Web Services resources in + // your account and Region tagged with this key make up your DevOps Guru application + // and analysis boundary. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + // + // AppBoundaryKey is a required field + AppBoundaryKey *string `min:"1" type:"string" required:"true"` + + // The values in an Amazon Web Services tag collection. + // + // The tag's value is an optional field used to associate a string with the + // tag key (for example, 111122223333, Production, or a team name). The key + // and value are the tag's key pair. Omitting the tag value is the same as using + // an empty string. Like tag keys, tag values are case-sensitive. You can specify + // a maximum of 256 characters for a tag value. + // + // TagValues is a required field + TagValues []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagCostEstimationResourceCollectionFilter) 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 TagCostEstimationResourceCollectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagCostEstimationResourceCollectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagCostEstimationResourceCollectionFilter"} + if s.AppBoundaryKey == nil { + invalidParams.Add(request.NewErrParamRequired("AppBoundaryKey")) + } + if s.AppBoundaryKey != nil && len(*s.AppBoundaryKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AppBoundaryKey", 1)) + } + if s.TagValues == nil { + invalidParams.Add(request.NewErrParamRequired("TagValues")) + } + if s.TagValues != nil && len(s.TagValues) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagValues", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppBoundaryKey sets the AppBoundaryKey field's value. +func (s *TagCostEstimationResourceCollectionFilter) SetAppBoundaryKey(v string) *TagCostEstimationResourceCollectionFilter { + s.AppBoundaryKey = &v + return s +} + +// SetTagValues sets the TagValues field's value. +func (s *TagCostEstimationResourceCollectionFilter) SetTagValues(v []*string) *TagCostEstimationResourceCollectionFilter { + s.TagValues = v + return s +} + +// Information about the health of Amazon Web Services resources in your account +// that are specified by an Amazon Web Services tag key. +type TagHealth struct { + _ struct{} `type:"structure"` + + // An Amazon Web Services tag key that is used to identify the Amazon Web Services + // resources that DevOps Guru analyzes. All Amazon Web Services resources in + // your account and Region tagged with this key make up your DevOps Guru application + // and analysis boundary. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + AppBoundaryKey *string `min:"1" type:"string"` + + // Information about the health of the Amazon Web Services resources in your + // account that are specified by an Amazon Web Services tag, including the number + // of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) + // of closed insights. + Insight *InsightHealth `type:"structure"` + + // The value in an Amazon Web Services tag. + // + // The tag's value is an optional field used to associate a string with the + // tag key (for example, 111122223333, Production, or a team name). The key + // and value are the tag's key pair. Omitting the tag value is the same as using + // an empty string. Like tag keys, tag values are case-sensitive. You can specify + // a maximum of 256 characters for a tag value. + TagValue *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 TagHealth) 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 TagHealth) GoString() string { + return s.String() +} + +// SetAppBoundaryKey sets the AppBoundaryKey field's value. +func (s *TagHealth) SetAppBoundaryKey(v string) *TagHealth { + s.AppBoundaryKey = &v + return s +} + +// SetInsight sets the Insight field's value. +func (s *TagHealth) SetInsight(v *InsightHealth) *TagHealth { + s.Insight = v + return s +} + +// SetTagValue sets the TagValue field's value. +func (s *TagHealth) SetTagValue(v string) *TagHealth { + s.TagValue = &v + return s +} + // The request was denied due to a request throttling. type ThrottlingException struct { _ struct{} `type:"structure"` @@ -10031,9 +11364,40 @@ func (s *UpdateCloudFormationCollectionFilter) SetStackNames(v []*string) *Updat type UpdateResourceCollectionFilter struct { _ struct{} `type:"structure"` - // An collection of Amazon Web Services CloudFormation stacks. You can specify + // A collection of Amazon Web Services CloudFormation stacks. You can specify // up to 500 Amazon Web Services CloudFormation stacks. CloudFormation *UpdateCloudFormationCollectionFilter `type:"structure"` + + // The updated Amazon Web Services tags used to filter the resources in the + // resource collection. + // + // Tags help you identify and organize your Amazon Web Services resources. Many + // Amazon Web Services services support tagging, so you can assign the same + // tag to resources from different services to indicate that the resources are + // related. For example, you can assign the same tag to an Amazon DynamoDB table + // resource that you assign to an Lambda function. For more information about + // using tags, see the Tagging best practices (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) + // whitepaper. + // + // Each Amazon Web Services tag has two parts. + // + // * A tag key (for example, CostCenter, Environment, Project, or Secret). + // Tag keys are case-sensitive. + // + // * An optional field known as a tag value (for example, 111122223333, Production, + // or a team name). Omitting the tag value is the same as using an empty + // string. Like tag keys, tag values are case-sensitive. + // + // Together these are known as key-value pairs. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + Tags []*UpdateTagCollectionFilter `type:"list"` } // String returns the string representation. @@ -10054,12 +11418,38 @@ func (s UpdateResourceCollectionFilter) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateResourceCollectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateResourceCollectionFilter"} + 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 +} + // SetCloudFormation sets the CloudFormation field's value. func (s *UpdateResourceCollectionFilter) SetCloudFormation(v *UpdateCloudFormationCollectionFilter) *UpdateResourceCollectionFilter { s.CloudFormation = v return s } +// SetTags sets the Tags field's value. +func (s *UpdateResourceCollectionFilter) SetTags(v []*UpdateTagCollectionFilter) *UpdateResourceCollectionFilter { + s.Tags = v + return s +} + type UpdateResourceCollectionInput struct { _ struct{} `type:"structure"` @@ -10102,6 +11492,11 @@ func (s *UpdateResourceCollectionInput) Validate() error { if s.ResourceCollection == nil { invalidParams.Add(request.NewErrParamRequired("ResourceCollection")) } + if s.ResourceCollection != nil { + if err := s.ResourceCollection.Validate(); err != nil { + invalidParams.AddNested("ResourceCollection", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10246,6 +11641,88 @@ func (s UpdateServiceIntegrationOutput) GoString() string { return s.String() } +// A new collection of Amazon Web Services resources that are defined by an +// Amazon Web Services tag or tag key/value pair. +type UpdateTagCollectionFilter struct { + _ struct{} `type:"structure"` + + // An Amazon Web Services tag key that is used to identify the Amazon Web Services + // resources that DevOps Guru analyzes. All Amazon Web Services resources in + // your account and Region tagged with this key make up your DevOps Guru application + // and analysis boundary. + // + // The string used for a key in a tag that you use to define your resource coverage + // must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application + // or Devops-guru-rds-application. While keys are case-sensitive, the case of + // key characters don't matter to DevOps Guru. For example, DevOps Guru works + // with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible + // key/value pairs in your application might be Devops-Guru-production-application/RDS + // or Devops-Guru-production-application/containers. + // + // AppBoundaryKey is a required field + AppBoundaryKey *string `min:"1" type:"string" required:"true"` + + // The values in an Amazon Web Services tag collection. + // + // The tag's value is an optional field used to associate a string with the + // tag key (for example, 111122223333, Production, or a team name). The key + // and value are the tag's key pair. Omitting the tag value is the same as using + // an empty string. Like tag keys, tag values are case-sensitive. You can specify + // a maximum of 256 characters for a tag value. + // + // TagValues is a required field + TagValues []*string `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 UpdateTagCollectionFilter) 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 UpdateTagCollectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateTagCollectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateTagCollectionFilter"} + if s.AppBoundaryKey == nil { + invalidParams.Add(request.NewErrParamRequired("AppBoundaryKey")) + } + if s.AppBoundaryKey != nil && len(*s.AppBoundaryKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AppBoundaryKey", 1)) + } + if s.TagValues == nil { + invalidParams.Add(request.NewErrParamRequired("TagValues")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppBoundaryKey sets the AppBoundaryKey field's value. +func (s *UpdateTagCollectionFilter) SetAppBoundaryKey(v string) *UpdateTagCollectionFilter { + s.AppBoundaryKey = &v + return s +} + +// SetTagValues sets the TagValues field's value. +func (s *UpdateTagCollectionFilter) SetTagValues(v []*string) *UpdateTagCollectionFilter { + s.TagValues = v + return s +} + // Contains information about data passed in to a field during a request that // is not valid. type ValidationException struct { @@ -10400,6 +11877,22 @@ func AnomalyStatus_Values() []string { } } +const ( + // AnomalyTypeCausal is a AnomalyType enum value + AnomalyTypeCausal = "CAUSAL" + + // AnomalyTypeContextual is a AnomalyType enum value + AnomalyTypeContextual = "CONTEXTUAL" +) + +// AnomalyType_Values returns all elements of the AnomalyType enum +func AnomalyType_Values() []string { + return []string{ + AnomalyTypeCausal, + AnomalyTypeContextual, + } +} + const ( // CloudWatchMetricDataStatusCodeComplete is a CloudWatchMetricDataStatusCode enum value CloudWatchMetricDataStatusCodeComplete = "Complete" @@ -10712,6 +12205,9 @@ const ( // ResourceCollectionTypeAwsService is a ResourceCollectionType enum value ResourceCollectionTypeAwsService = "AWS_SERVICE" + + // ResourceCollectionTypeAwsTags is a ResourceCollectionType enum value + ResourceCollectionTypeAwsTags = "AWS_TAGS" ) // ResourceCollectionType_Values returns all elements of the ResourceCollectionType enum @@ -10719,6 +12215,7 @@ func ResourceCollectionType_Values() []string { return []string{ ResourceCollectionTypeAwsCloudFormation, ResourceCollectionTypeAwsService, + ResourceCollectionTypeAwsTags, } } @@ -10858,6 +12355,12 @@ const ( // ValidationExceptionReasonOther is a ValidationExceptionReason enum value ValidationExceptionReasonOther = "OTHER" + + // ValidationExceptionReasonInvalidParameterCombination is a ValidationExceptionReason enum value + ValidationExceptionReasonInvalidParameterCombination = "INVALID_PARAMETER_COMBINATION" + + // ValidationExceptionReasonParameterInconsistentWithServiceState is a ValidationExceptionReason enum value + ValidationExceptionReasonParameterInconsistentWithServiceState = "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE" ) // ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum @@ -10867,5 +12370,7 @@ func ValidationExceptionReason_Values() []string { ValidationExceptionReasonCannotParse, ValidationExceptionReasonFieldValidationFailed, ValidationExceptionReasonOther, + ValidationExceptionReasonInvalidParameterCombination, + ValidationExceptionReasonParameterInconsistentWithServiceState, } } diff --git a/service/directconnect/api.go b/service/directconnect/api.go index ce430eed57e..3d6da1961f0 100644 --- a/service/directconnect/api.go +++ b/service/directconnect/api.go @@ -10451,7 +10451,7 @@ type DescribeRouterConfigurationOutput struct { // The ID assigned to the virtual interface. VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string"` - // The name of the virtual interface assigned by the customer network. + // Provides the details about a virtual interface's router. VirtualInterfaceName *string `locationName:"virtualInterfaceName" type:"string"` } @@ -12159,6 +12159,9 @@ type NewPrivateVirtualInterface struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` + // Indicates whether to enable or disable SiteLink. + EnableSiteLink *bool `locationName:"enableSiteLink" type:"boolean"` + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` @@ -12268,6 +12271,12 @@ func (s *NewPrivateVirtualInterface) SetDirectConnectGatewayId(v string) *NewPri return s } +// SetEnableSiteLink sets the EnableSiteLink field's value. +func (s *NewPrivateVirtualInterface) SetEnableSiteLink(v bool) *NewPrivateVirtualInterface { + s.EnableSiteLink = &v + return s +} + // SetMtu sets the Mtu field's value. func (s *NewPrivateVirtualInterface) SetMtu(v int64) *NewPrivateVirtualInterface { s.Mtu = &v @@ -12767,6 +12776,9 @@ type NewTransitVirtualInterface struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` + // Indicates whether to enable or disable SiteLink. + EnableSiteLink *bool `locationName:"enableSiteLink" type:"boolean"` + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` @@ -12860,6 +12872,12 @@ func (s *NewTransitVirtualInterface) SetDirectConnectGatewayId(v string) *NewTra return s } +// SetEnableSiteLink sets the EnableSiteLink field's value. +func (s *NewTransitVirtualInterface) SetEnableSiteLink(v bool) *NewTransitVirtualInterface { + s.EnableSiteLink = &v + return s +} + // SetMtu sets the Mtu field's value. func (s *NewTransitVirtualInterface) SetMtu(v int64) *NewTransitVirtualInterface { s.Mtu = &v @@ -14282,6 +14300,9 @@ func (s *UpdateLagInput) SetMinimumLinks(v int64) *UpdateLagInput { type UpdateVirtualInterfaceAttributesInput struct { _ struct{} `type:"structure"` + // Indicates whether to enable or disable SiteLink. + EnableSiteLink *bool `locationName:"enableSiteLink" type:"boolean"` + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` @@ -14290,6 +14311,9 @@ type UpdateVirtualInterfaceAttributesInput struct { // // VirtualInterfaceId is a required field VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string" required:"true"` + + // The name of the virtual private interface. + VirtualInterfaceName *string `locationName:"virtualInterfaceName" type:"string"` } // String returns the string representation. @@ -14323,6 +14347,12 @@ func (s *UpdateVirtualInterfaceAttributesInput) Validate() error { return nil } +// SetEnableSiteLink sets the EnableSiteLink field's value. +func (s *UpdateVirtualInterfaceAttributesInput) SetEnableSiteLink(v bool) *UpdateVirtualInterfaceAttributesInput { + s.EnableSiteLink = &v + return s +} + // SetMtu sets the Mtu field's value. func (s *UpdateVirtualInterfaceAttributesInput) SetMtu(v int64) *UpdateVirtualInterfaceAttributesInput { s.Mtu = &v @@ -14335,6 +14365,12 @@ func (s *UpdateVirtualInterfaceAttributesInput) SetVirtualInterfaceId(v string) return s } +// SetVirtualInterfaceName sets the VirtualInterfaceName field's value. +func (s *UpdateVirtualInterfaceAttributesInput) SetVirtualInterfaceName(v string) *UpdateVirtualInterfaceAttributesInput { + s.VirtualInterfaceName = &v + return s +} + // Information about a virtual interface. type UpdateVirtualInterfaceAttributesOutput struct { _ struct{} `type:"structure"` @@ -14399,6 +14435,9 @@ type UpdateVirtualInterfaceAttributesOutput struct { // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Indicates whether SiteLink is enabled. + SiteLinkEnabled *bool `locationName:"siteLinkEnabled" type:"boolean"` + // The tags associated with the virtual interface. Tags []*Tag `locationName:"tags" min:"1" type:"list"` @@ -14578,6 +14617,12 @@ func (s *UpdateVirtualInterfaceAttributesOutput) SetRouteFilterPrefixes(v []*Rou return s } +// SetSiteLinkEnabled sets the SiteLinkEnabled field's value. +func (s *UpdateVirtualInterfaceAttributesOutput) SetSiteLinkEnabled(v bool) *UpdateVirtualInterfaceAttributesOutput { + s.SiteLinkEnabled = &v + return s +} + // SetTags sets the Tags field's value. func (s *UpdateVirtualInterfaceAttributesOutput) SetTags(v []*Tag) *UpdateVirtualInterfaceAttributesOutput { s.Tags = v @@ -14735,6 +14780,9 @@ type VirtualInterface struct { // Applies to public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Indicates whether SiteLink is enabled. + SiteLinkEnabled *bool `locationName:"siteLinkEnabled" type:"boolean"` + // The tags associated with the virtual interface. Tags []*Tag `locationName:"tags" min:"1" type:"list"` @@ -14914,6 +14962,12 @@ func (s *VirtualInterface) SetRouteFilterPrefixes(v []*RouteFilterPrefix) *Virtu return s } +// SetSiteLinkEnabled sets the SiteLinkEnabled field's value. +func (s *VirtualInterface) SetSiteLinkEnabled(v bool) *VirtualInterface { + s.SiteLinkEnabled = &v + return s +} + // SetTags sets the Tags field's value. func (s *VirtualInterface) SetTags(v []*Tag) *VirtualInterface { s.Tags = v diff --git a/service/dynamodb/api.go b/service/dynamodb/api.go index 73de1f4e0f2..017ed69e500 100644 --- a/service/dynamodb/api.go +++ b/service/dynamodb/api.go @@ -10125,6 +10125,10 @@ type CreateReplicationGroupMemberAction struct { // // RegionName is a required field RegionName *string `type:"string" required:"true"` + + // Replica-specific table class. If not specified, uses the source table's table + // class. + TableClassOverride *string `type:"string" enum:"TableClass"` } // String returns the string representation. @@ -10200,6 +10204,12 @@ func (s *CreateReplicationGroupMemberAction) SetRegionName(v string) *CreateRepl return s } +// SetTableClassOverride sets the TableClassOverride field's value. +func (s *CreateReplicationGroupMemberAction) SetTableClassOverride(v string) *CreateReplicationGroupMemberAction { + s.TableClassOverride = &v + return s +} + // Represents the input of a CreateTable operation. type CreateTableInput struct { _ struct{} `type:"structure"` @@ -10336,6 +10346,9 @@ type CreateTableInput struct { // are written to the stream. StreamSpecification *StreamSpecification `type:"structure"` + // The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS. + TableClass *string `type:"string" enum:"TableClass"` + // The name of the table to create. // // TableName is a required field @@ -10497,6 +10510,12 @@ func (s *CreateTableInput) SetStreamSpecification(v *StreamSpecification) *Creat return s } +// SetTableClass sets the TableClass field's value. +func (s *CreateTableInput) SetTableClass(v string) *CreateTableInput { + s.TableClass = &v + return s +} + // SetTableName sets the TableName field's value. func (s *CreateTableInput) SetTableName(v string) *CreateTableInput { s.TableName = &v @@ -18635,6 +18654,9 @@ type ReplicaDescription struct { // Specifies the progress of a Create, Update, or Delete action on the replica // as a percentage. ReplicaStatusPercentProgress *string `type:"string"` + + // Contains details of the table class. + ReplicaTableClassSummary *TableClassSummary `type:"structure"` } // String returns the string representation. @@ -18703,6 +18725,12 @@ func (s *ReplicaDescription) SetReplicaStatusPercentProgress(v string) *ReplicaD return s } +// SetReplicaTableClassSummary sets the ReplicaTableClassSummary field's value. +func (s *ReplicaDescription) SetReplicaTableClassSummary(v *TableClassSummary) *ReplicaDescription { + s.ReplicaTableClassSummary = v + return s +} + // Represents the properties of a replica global secondary index. type ReplicaGlobalSecondaryIndex struct { _ struct{} `type:"structure"` @@ -19219,6 +19247,9 @@ type ReplicaSettingsDescription struct { // // * ACTIVE - The Region is ready for use. ReplicaStatus *string `type:"string" enum:"ReplicaStatus"` + + // Contains details of the table class. + ReplicaTableClassSummary *TableClassSummary `type:"structure"` } // String returns the string representation. @@ -19287,6 +19318,12 @@ func (s *ReplicaSettingsDescription) SetReplicaStatus(v string) *ReplicaSettings return s } +// SetReplicaTableClassSummary sets the ReplicaTableClassSummary field's value. +func (s *ReplicaSettingsDescription) SetReplicaTableClassSummary(v *TableClassSummary) *ReplicaSettingsDescription { + s.ReplicaTableClassSummary = v + return s +} + // Represents the settings for a global table in a Region that will be modified. type ReplicaSettingsUpdate struct { _ struct{} `type:"structure"` @@ -19309,6 +19346,10 @@ type ReplicaSettingsUpdate struct { // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedReadCapacityUnits *int64 `min:"1" type:"long"` + + // Replica-specific table class. If not specified, uses the source table's table + // class. + ReplicaTableClass *string `type:"string" enum:"TableClass"` } // String returns the string representation. @@ -19387,6 +19428,12 @@ func (s *ReplicaSettingsUpdate) SetReplicaProvisionedReadCapacityUnits(v int64) return s } +// SetReplicaTableClass sets the ReplicaTableClass field's value. +func (s *ReplicaSettingsUpdate) SetReplicaTableClass(v string) *ReplicaSettingsUpdate { + s.ReplicaTableClass = &v + return s +} + // Represents one of the following: // // * A new replica to be added to an existing global table. @@ -21175,6 +21222,47 @@ func (s *TableAutoScalingDescription) SetTableStatus(v string) *TableAutoScaling return s } +// Contains details of the table class. +type TableClassSummary struct { + _ struct{} `type:"structure"` + + // The date and time at which the table class was last updated. + LastUpdateDateTime *time.Time `type:"timestamp"` + + // The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS. + TableClass *string `type:"string" enum:"TableClass"` +} + +// 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 TableClassSummary) 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 TableClassSummary) GoString() string { + return s.String() +} + +// SetLastUpdateDateTime sets the LastUpdateDateTime field's value. +func (s *TableClassSummary) SetLastUpdateDateTime(v time.Time) *TableClassSummary { + s.LastUpdateDateTime = &v + return s +} + +// SetTableClass sets the TableClass field's value. +func (s *TableClassSummary) SetTableClass(v string) *TableClassSummary { + s.TableClass = &v + return s +} + // Represents the properties of a table. type TableDescription struct { _ struct{} `type:"structure"` @@ -21353,6 +21441,9 @@ type TableDescription struct { // The Amazon Resource Name (ARN) that uniquely identifies the table. TableArn *string `type:"string"` + // Contains details of the table class. + TableClassSummary *TableClassSummary `type:"structure"` + // Unique identifier for the table for which the backup was created. TableId *string `type:"string"` @@ -21507,6 +21598,12 @@ func (s *TableDescription) SetTableArn(v string) *TableDescription { return s } +// SetTableClassSummary sets the TableClassSummary field's value. +func (s *TableDescription) SetTableClassSummary(v *TableClassSummary) *TableDescription { + s.TableClassSummary = v + return s +} + // SetTableId sets the TableId field's value. func (s *TableDescription) SetTableId(v string) *TableDescription { s.TableId = &v @@ -23863,6 +23960,10 @@ type UpdateReplicationGroupMemberAction struct { // // RegionName is a required field RegionName *string `type:"string" required:"true"` + + // Replica-specific table class. If not specified, uses the source table's table + // class. + TableClassOverride *string `type:"string" enum:"TableClass"` } // String returns the string representation. @@ -23938,6 +24039,12 @@ func (s *UpdateReplicationGroupMemberAction) SetRegionName(v string) *UpdateRepl return s } +// SetTableClassOverride sets the TableClassOverride field's value. +func (s *UpdateReplicationGroupMemberAction) SetTableClassOverride(v string) *UpdateReplicationGroupMemberAction { + s.TableClassOverride = &v + return s +} + // Represents the input of an UpdateTable operation. type UpdateTableInput struct { _ struct{} `type:"structure"` @@ -23996,6 +24103,10 @@ type UpdateTableInput struct { // doesn't have a stream. StreamSpecification *StreamSpecification `type:"structure"` + // The table class of the table to be updated. Valid values are STANDARD and + // STANDARD_INFREQUENT_ACCESS. + TableClass *string `type:"string" enum:"TableClass"` + // The name of the table to be updated. // // TableName is a required field @@ -24121,6 +24232,12 @@ func (s *UpdateTableInput) SetStreamSpecification(v *StreamSpecification) *Updat return s } +// SetTableClass sets the TableClass field's value. +func (s *UpdateTableInput) SetTableClass(v string) *UpdateTableInput { + s.TableClass = &v + return s +} + // SetTableName sets the TableName field's value. func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput { s.TableName = &v @@ -25154,6 +25271,22 @@ func StreamViewType_Values() []string { } } +const ( + // TableClassStandard is a TableClass enum value + TableClassStandard = "STANDARD" + + // TableClassStandardInfrequentAccess is a TableClass enum value + TableClassStandardInfrequentAccess = "STANDARD_INFREQUENT_ACCESS" +) + +// TableClass_Values returns all elements of the TableClass enum +func TableClass_Values() []string { + return []string{ + TableClassStandard, + TableClassStandardInfrequentAccess, + } +} + const ( // TableStatusCreating is a TableStatus enum value TableStatusCreating = "CREATING" diff --git a/service/ec2/api.go b/service/ec2/api.go index 23894cefb6d..0e993104224 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -738,6 +738,83 @@ func (c *EC2) AllocateHostsWithContext(ctx aws.Context, input *AllocateHostsInpu return out, req.Send() } +const opAllocateIpamPoolCidr = "AllocateIpamPoolCidr" + +// AllocateIpamPoolCidrRequest generates a "aws/request.Request" representing the +// client's request for the AllocateIpamPoolCidr 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 AllocateIpamPoolCidr for more information on using the AllocateIpamPoolCidr +// 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 AllocateIpamPoolCidrRequest method. +// req, resp := client.AllocateIpamPoolCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/AllocateIpamPoolCidr +func (c *EC2) AllocateIpamPoolCidrRequest(input *AllocateIpamPoolCidrInput) (req *request.Request, output *AllocateIpamPoolCidrOutput) { + op := &request.Operation{ + Name: opAllocateIpamPoolCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AllocateIpamPoolCidrInput{} + } + + output = &AllocateIpamPoolCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// AllocateIpamPoolCidr API operation for Amazon Elastic Compute Cloud. +// +// Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment +// from an IPAM pool to another resource or IPAM pool. For more information, +// see Allocate CIDRs (/vpc/latest/ipam/allocate-cidrs-ipam.html) in the Amazon +// VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation AllocateIpamPoolCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/AllocateIpamPoolCidr +func (c *EC2) AllocateIpamPoolCidr(input *AllocateIpamPoolCidrInput) (*AllocateIpamPoolCidrOutput, error) { + req, out := c.AllocateIpamPoolCidrRequest(input) + return out, req.Send() +} + +// AllocateIpamPoolCidrWithContext is the same as AllocateIpamPoolCidr with the addition of +// the ability to pass a context and additional request options. +// +// See AllocateIpamPoolCidr 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 *EC2) AllocateIpamPoolCidrWithContext(ctx aws.Context, input *AllocateIpamPoolCidrInput, opts ...request.Option) (*AllocateIpamPoolCidrOutput, error) { + req, out := c.AllocateIpamPoolCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opApplySecurityGroupsToClientVpnTargetNetwork = "ApplySecurityGroupsToClientVpnTargetNetwork" // ApplySecurityGroupsToClientVpnTargetNetworkRequest generates a "aws/request.Request" representing the @@ -5253,6 +5330,249 @@ func (c *EC2) CreateInternetGatewayWithContext(ctx aws.Context, input *CreateInt return out, req.Send() } +const opCreateIpam = "CreateIpam" + +// CreateIpamRequest generates a "aws/request.Request" representing the +// client's request for the CreateIpam 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 CreateIpam for more information on using the CreateIpam +// 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 CreateIpamRequest method. +// req, resp := client.CreateIpamRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpam +func (c *EC2) CreateIpamRequest(input *CreateIpamInput) (req *request.Request, output *CreateIpamOutput) { + op := &request.Operation{ + Name: opCreateIpam, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateIpamInput{} + } + + output = &CreateIpamOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateIpam API operation for Amazon Elastic Compute Cloud. +// +// Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that +// you can use to automate your IP address management workflows including assigning, +// tracking, troubleshooting, and auditing IP addresses across Amazon Web Services +// Regions and accounts throughout your Amazon Web Services Organization. +// +// For more information, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation CreateIpam for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpam +func (c *EC2) CreateIpam(input *CreateIpamInput) (*CreateIpamOutput, error) { + req, out := c.CreateIpamRequest(input) + return out, req.Send() +} + +// CreateIpamWithContext is the same as CreateIpam with the addition of +// the ability to pass a context and additional request options. +// +// See CreateIpam 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 *EC2) CreateIpamWithContext(ctx aws.Context, input *CreateIpamInput, opts ...request.Option) (*CreateIpamOutput, error) { + req, out := c.CreateIpamRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateIpamPool = "CreateIpamPool" + +// CreateIpamPoolRequest generates a "aws/request.Request" representing the +// client's request for the CreateIpamPool 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 CreateIpamPool for more information on using the CreateIpamPool +// 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 CreateIpamPoolRequest method. +// req, resp := client.CreateIpamPoolRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamPool +func (c *EC2) CreateIpamPoolRequest(input *CreateIpamPoolInput) (req *request.Request, output *CreateIpamPoolOutput) { + op := &request.Operation{ + Name: opCreateIpamPool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateIpamPoolInput{} + } + + output = &CreateIpamPoolOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateIpamPool API operation for Amazon Elastic Compute Cloud. +// +// Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, +// a pool is a collection of contiguous IP addresses CIDRs. Pools enable you +// to organize your IP addresses according to your routing and security needs. +// For example, if you have separate routing and security needs for development +// and production applications, you can create a pool for each. +// +// For more information, see Create a top-level pool (/vpc/latest/ipam/create-top-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation CreateIpamPool for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamPool +func (c *EC2) CreateIpamPool(input *CreateIpamPoolInput) (*CreateIpamPoolOutput, error) { + req, out := c.CreateIpamPoolRequest(input) + return out, req.Send() +} + +// CreateIpamPoolWithContext is the same as CreateIpamPool with the addition of +// the ability to pass a context and additional request options. +// +// See CreateIpamPool 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 *EC2) CreateIpamPoolWithContext(ctx aws.Context, input *CreateIpamPoolInput, opts ...request.Option) (*CreateIpamPoolOutput, error) { + req, out := c.CreateIpamPoolRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateIpamScope = "CreateIpamScope" + +// CreateIpamScopeRequest generates a "aws/request.Request" representing the +// client's request for the CreateIpamScope 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 CreateIpamScope for more information on using the CreateIpamScope +// 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 CreateIpamScopeRequest method. +// req, resp := client.CreateIpamScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamScope +func (c *EC2) CreateIpamScopeRequest(input *CreateIpamScopeInput) (req *request.Request, output *CreateIpamScopeOutput) { + op := &request.Operation{ + Name: opCreateIpamScope, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateIpamScopeInput{} + } + + output = &CreateIpamScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateIpamScope API operation for Amazon Elastic Compute Cloud. +// +// Create an IPAM scope. In IPAM, a scope is the highest-level container within +// IPAM. An IPAM contains two default scopes. Each scope represents the IP space +// for a single network. The private scope is intended for all private IP address +// space. The public scope is intended for all public IP address space. Scopes +// enable you to reuse IP addresses across multiple unconnected networks without +// causing IP address overlap or conflict. +// +// For more information, see Add a scope (/vpc/latest/ipam/add-scope-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation CreateIpamScope for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateIpamScope +func (c *EC2) CreateIpamScope(input *CreateIpamScopeInput) (*CreateIpamScopeOutput, error) { + req, out := c.CreateIpamScopeRequest(input) + return out, req.Send() +} + +// CreateIpamScopeWithContext is the same as CreateIpamScope with the addition of +// the ability to pass a context and additional request options. +// +// See CreateIpamScope 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 *EC2) CreateIpamScopeWithContext(ctx aws.Context, input *CreateIpamScopeInput, opts ...request.Option) (*CreateIpamScopeOutput, error) { + req, out := c.CreateIpamScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateKeyPair = "CreateKeyPair" // CreateKeyPairRequest generates a "aws/request.Request" representing the @@ -5981,6 +6301,85 @@ func (c *EC2) CreateNetworkAclEntryWithContext(ctx aws.Context, input *CreateNet return out, req.Send() } +const opCreateNetworkInsightsAccessScope = "CreateNetworkInsightsAccessScope" + +// CreateNetworkInsightsAccessScopeRequest generates a "aws/request.Request" representing the +// client's request for the CreateNetworkInsightsAccessScope 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 CreateNetworkInsightsAccessScope for more information on using the CreateNetworkInsightsAccessScope +// 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 CreateNetworkInsightsAccessScopeRequest method. +// req, resp := client.CreateNetworkInsightsAccessScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateNetworkInsightsAccessScope +func (c *EC2) CreateNetworkInsightsAccessScopeRequest(input *CreateNetworkInsightsAccessScopeInput) (req *request.Request, output *CreateNetworkInsightsAccessScopeOutput) { + op := &request.Operation{ + Name: opCreateNetworkInsightsAccessScope, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateNetworkInsightsAccessScopeInput{} + } + + output = &CreateNetworkInsightsAccessScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateNetworkInsightsAccessScope API operation for Amazon Elastic Compute Cloud. +// +// Creates a Network Access Scope. +// +// Amazon Web Services Network Access Analyzer enables cloud networking and +// cloud operations teams to verify that their networks on Amazon Web Services +// conform to their network security and governance objectives. For more information, +// see the Amazon Web Services Network Access Analyzer Guide (https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/). +// +// 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 Elastic Compute Cloud's +// API operation CreateNetworkInsightsAccessScope for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateNetworkInsightsAccessScope +func (c *EC2) CreateNetworkInsightsAccessScope(input *CreateNetworkInsightsAccessScopeInput) (*CreateNetworkInsightsAccessScopeOutput, error) { + req, out := c.CreateNetworkInsightsAccessScopeRequest(input) + return out, req.Send() +} + +// CreateNetworkInsightsAccessScopeWithContext is the same as CreateNetworkInsightsAccessScope with the addition of +// the ability to pass a context and additional request options. +// +// See CreateNetworkInsightsAccessScope 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 *EC2) CreateNetworkInsightsAccessScopeWithContext(ctx aws.Context, input *CreateNetworkInsightsAccessScopeInput, opts ...request.Option) (*CreateNetworkInsightsAccessScopeOutput, error) { + req, out := c.CreateNetworkInsightsAccessScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateNetworkInsightsPath = "CreateNetworkInsightsPath" // CreateNetworkInsightsPathRequest generates a "aws/request.Request" representing the @@ -6300,6 +6699,84 @@ func (c *EC2) CreatePlacementGroupWithContext(ctx aws.Context, input *CreatePlac return out, req.Send() } +const opCreatePublicIpv4Pool = "CreatePublicIpv4Pool" + +// CreatePublicIpv4PoolRequest generates a "aws/request.Request" representing the +// client's request for the CreatePublicIpv4Pool 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 CreatePublicIpv4Pool for more information on using the CreatePublicIpv4Pool +// 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 CreatePublicIpv4PoolRequest method. +// req, resp := client.CreatePublicIpv4PoolRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreatePublicIpv4Pool +func (c *EC2) CreatePublicIpv4PoolRequest(input *CreatePublicIpv4PoolInput) (req *request.Request, output *CreatePublicIpv4PoolOutput) { + op := &request.Operation{ + Name: opCreatePublicIpv4Pool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreatePublicIpv4PoolInput{} + } + + output = &CreatePublicIpv4PoolOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreatePublicIpv4Pool API operation for Amazon Elastic Compute Cloud. +// +// Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address +// pool required for the public IPv4 CIDRs that you own and bring to Amazon +// Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web +// Services, however, use IPAM pools only. To monitor the status of pool creation, +// use DescribePublicIpv4Pools (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation CreatePublicIpv4Pool for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreatePublicIpv4Pool +func (c *EC2) CreatePublicIpv4Pool(input *CreatePublicIpv4PoolInput) (*CreatePublicIpv4PoolOutput, error) { + req, out := c.CreatePublicIpv4PoolRequest(input) + return out, req.Send() +} + +// CreatePublicIpv4PoolWithContext is the same as CreatePublicIpv4Pool with the addition of +// the ability to pass a context and additional request options. +// +// See CreatePublicIpv4Pool 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 *EC2) CreatePublicIpv4PoolWithContext(ctx aws.Context, input *CreatePublicIpv4PoolInput, opts ...request.Option) (*CreatePublicIpv4PoolOutput, error) { + req, out := c.CreatePublicIpv4PoolRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateReplaceRootVolumeTask = "CreateReplaceRootVolumeTask" // CreateReplaceRootVolumeTaskRequest generates a "aws/request.Request" representing the @@ -10132,6 +10609,247 @@ func (c *EC2) DeleteInternetGatewayWithContext(ctx aws.Context, input *DeleteInt return out, req.Send() } +const opDeleteIpam = "DeleteIpam" + +// DeleteIpamRequest generates a "aws/request.Request" representing the +// client's request for the DeleteIpam 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 DeleteIpam for more information on using the DeleteIpam +// 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 DeleteIpamRequest method. +// req, resp := client.DeleteIpamRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpam +func (c *EC2) DeleteIpamRequest(input *DeleteIpamInput) (req *request.Request, output *DeleteIpamOutput) { + op := &request.Operation{ + Name: opDeleteIpam, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteIpamInput{} + } + + output = &DeleteIpamOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteIpam API operation for Amazon Elastic Compute Cloud. +// +// Delete an IPAM. Deleting an IPAM removes all monitored data associated with +// the IPAM including the historical data for CIDRs. +// +// You cannot delete an IPAM if there are CIDRs provisioned to pools or if there +// are allocations in the pools within the IPAM. To deprovision pool CIDRs, +// see DeprovisionIpamPoolCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html). +// To release allocations, see ReleaseIpamPoolAllocation (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html). +// +// For more information, see Delete an IPAM (/vpc/latest/ipam/delete-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeleteIpam for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpam +func (c *EC2) DeleteIpam(input *DeleteIpamInput) (*DeleteIpamOutput, error) { + req, out := c.DeleteIpamRequest(input) + return out, req.Send() +} + +// DeleteIpamWithContext is the same as DeleteIpam with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteIpam 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 *EC2) DeleteIpamWithContext(ctx aws.Context, input *DeleteIpamInput, opts ...request.Option) (*DeleteIpamOutput, error) { + req, out := c.DeleteIpamRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteIpamPool = "DeleteIpamPool" + +// DeleteIpamPoolRequest generates a "aws/request.Request" representing the +// client's request for the DeleteIpamPool 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 DeleteIpamPool for more information on using the DeleteIpamPool +// 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 DeleteIpamPoolRequest method. +// req, resp := client.DeleteIpamPoolRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamPool +func (c *EC2) DeleteIpamPoolRequest(input *DeleteIpamPoolInput) (req *request.Request, output *DeleteIpamPoolOutput) { + op := &request.Operation{ + Name: opDeleteIpamPool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteIpamPoolInput{} + } + + output = &DeleteIpamPoolOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteIpamPool API operation for Amazon Elastic Compute Cloud. +// +// Delete an IPAM pool. +// +// You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned +// to it. To release allocations, see ReleaseIpamPoolAllocation (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html). +// To deprovision pool CIDRs, see DeprovisionIpamPoolCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html). +// +// For more information, see Delete a pool (/vpc/latest/ipam/delete-pool-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeleteIpamPool for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamPool +func (c *EC2) DeleteIpamPool(input *DeleteIpamPoolInput) (*DeleteIpamPoolOutput, error) { + req, out := c.DeleteIpamPoolRequest(input) + return out, req.Send() +} + +// DeleteIpamPoolWithContext is the same as DeleteIpamPool with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteIpamPool 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 *EC2) DeleteIpamPoolWithContext(ctx aws.Context, input *DeleteIpamPoolInput, opts ...request.Option) (*DeleteIpamPoolOutput, error) { + req, out := c.DeleteIpamPoolRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteIpamScope = "DeleteIpamScope" + +// DeleteIpamScopeRequest generates a "aws/request.Request" representing the +// client's request for the DeleteIpamScope 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 DeleteIpamScope for more information on using the DeleteIpamScope +// 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 DeleteIpamScopeRequest method. +// req, resp := client.DeleteIpamScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamScope +func (c *EC2) DeleteIpamScopeRequest(input *DeleteIpamScopeInput) (req *request.Request, output *DeleteIpamScopeOutput) { + op := &request.Operation{ + Name: opDeleteIpamScope, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteIpamScopeInput{} + } + + output = &DeleteIpamScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteIpamScope API operation for Amazon Elastic Compute Cloud. +// +// Delete the scope for an IPAM. You cannot delete the default scopes. +// +// For more information, see Delete a scope (/vpc/latest/ipam/delete-scope-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeleteIpamScope for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteIpamScope +func (c *EC2) DeleteIpamScope(input *DeleteIpamScopeInput) (*DeleteIpamScopeOutput, error) { + req, out := c.DeleteIpamScopeRequest(input) + return out, req.Send() +} + +// DeleteIpamScopeWithContext is the same as DeleteIpamScope with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteIpamScope 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 *EC2) DeleteIpamScopeWithContext(ctx aws.Context, input *DeleteIpamScopeInput, opts ...request.Option) (*DeleteIpamScopeOutput, error) { + req, out := c.DeleteIpamScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteKeyPair = "DeleteKeyPair" // DeleteKeyPairRequest generates a "aws/request.Request" representing the @@ -10811,6 +11529,154 @@ func (c *EC2) DeleteNetworkAclEntryWithContext(ctx aws.Context, input *DeleteNet return out, req.Send() } +const opDeleteNetworkInsightsAccessScope = "DeleteNetworkInsightsAccessScope" + +// DeleteNetworkInsightsAccessScopeRequest generates a "aws/request.Request" representing the +// client's request for the DeleteNetworkInsightsAccessScope 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 DeleteNetworkInsightsAccessScope for more information on using the DeleteNetworkInsightsAccessScope +// 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 DeleteNetworkInsightsAccessScopeRequest method. +// req, resp := client.DeleteNetworkInsightsAccessScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteNetworkInsightsAccessScope +func (c *EC2) DeleteNetworkInsightsAccessScopeRequest(input *DeleteNetworkInsightsAccessScopeInput) (req *request.Request, output *DeleteNetworkInsightsAccessScopeOutput) { + op := &request.Operation{ + Name: opDeleteNetworkInsightsAccessScope, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteNetworkInsightsAccessScopeInput{} + } + + output = &DeleteNetworkInsightsAccessScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteNetworkInsightsAccessScope API operation for Amazon Elastic Compute Cloud. +// +// Deletes the specified Network Access Scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeleteNetworkInsightsAccessScope for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteNetworkInsightsAccessScope +func (c *EC2) DeleteNetworkInsightsAccessScope(input *DeleteNetworkInsightsAccessScopeInput) (*DeleteNetworkInsightsAccessScopeOutput, error) { + req, out := c.DeleteNetworkInsightsAccessScopeRequest(input) + return out, req.Send() +} + +// DeleteNetworkInsightsAccessScopeWithContext is the same as DeleteNetworkInsightsAccessScope with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteNetworkInsightsAccessScope 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 *EC2) DeleteNetworkInsightsAccessScopeWithContext(ctx aws.Context, input *DeleteNetworkInsightsAccessScopeInput, opts ...request.Option) (*DeleteNetworkInsightsAccessScopeOutput, error) { + req, out := c.DeleteNetworkInsightsAccessScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteNetworkInsightsAccessScopeAnalysis = "DeleteNetworkInsightsAccessScopeAnalysis" + +// DeleteNetworkInsightsAccessScopeAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the DeleteNetworkInsightsAccessScopeAnalysis 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 DeleteNetworkInsightsAccessScopeAnalysis for more information on using the DeleteNetworkInsightsAccessScopeAnalysis +// 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 DeleteNetworkInsightsAccessScopeAnalysisRequest method. +// req, resp := client.DeleteNetworkInsightsAccessScopeAnalysisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis +func (c *EC2) DeleteNetworkInsightsAccessScopeAnalysisRequest(input *DeleteNetworkInsightsAccessScopeAnalysisInput) (req *request.Request, output *DeleteNetworkInsightsAccessScopeAnalysisOutput) { + op := &request.Operation{ + Name: opDeleteNetworkInsightsAccessScopeAnalysis, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteNetworkInsightsAccessScopeAnalysisInput{} + } + + output = &DeleteNetworkInsightsAccessScopeAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteNetworkInsightsAccessScopeAnalysis API operation for Amazon Elastic Compute Cloud. +// +// Deletes the specified Network Access Scope 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 Elastic Compute Cloud's +// API operation DeleteNetworkInsightsAccessScopeAnalysis for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis +func (c *EC2) DeleteNetworkInsightsAccessScopeAnalysis(input *DeleteNetworkInsightsAccessScopeAnalysisInput) (*DeleteNetworkInsightsAccessScopeAnalysisOutput, error) { + req, out := c.DeleteNetworkInsightsAccessScopeAnalysisRequest(input) + return out, req.Send() +} + +// DeleteNetworkInsightsAccessScopeAnalysisWithContext is the same as DeleteNetworkInsightsAccessScopeAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteNetworkInsightsAccessScopeAnalysis 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 *EC2) DeleteNetworkInsightsAccessScopeAnalysisWithContext(ctx aws.Context, input *DeleteNetworkInsightsAccessScopeAnalysisInput, opts ...request.Option) (*DeleteNetworkInsightsAccessScopeAnalysisOutput, error) { + req, out := c.DeleteNetworkInsightsAccessScopeAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteNetworkInsightsAnalysis = "DeleteNetworkInsightsAnalysis" // DeleteNetworkInsightsAnalysisRequest generates a "aws/request.Request" representing the @@ -11190,6 +12056,83 @@ func (c *EC2) DeletePlacementGroupWithContext(ctx aws.Context, input *DeletePlac return out, req.Send() } +const opDeletePublicIpv4Pool = "DeletePublicIpv4Pool" + +// DeletePublicIpv4PoolRequest generates a "aws/request.Request" representing the +// client's request for the DeletePublicIpv4Pool 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 DeletePublicIpv4Pool for more information on using the DeletePublicIpv4Pool +// 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 DeletePublicIpv4PoolRequest method. +// req, resp := client.DeletePublicIpv4PoolRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeletePublicIpv4Pool +func (c *EC2) DeletePublicIpv4PoolRequest(input *DeletePublicIpv4PoolInput) (req *request.Request, output *DeletePublicIpv4PoolOutput) { + op := &request.Operation{ + Name: opDeletePublicIpv4Pool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeletePublicIpv4PoolInput{} + } + + output = &DeletePublicIpv4PoolOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeletePublicIpv4Pool API operation for Amazon Elastic Compute Cloud. +// +// Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required +// for the public IPv4 CIDRs that you own and bring to Amazon Web Services to +// manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, +// use IPAM pools only. +// +// 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 Elastic Compute Cloud's +// API operation DeletePublicIpv4Pool for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeletePublicIpv4Pool +func (c *EC2) DeletePublicIpv4Pool(input *DeletePublicIpv4PoolInput) (*DeletePublicIpv4PoolOutput, error) { + req, out := c.DeletePublicIpv4PoolRequest(input) + return out, req.Send() +} + +// DeletePublicIpv4PoolWithContext is the same as DeletePublicIpv4Pool with the addition of +// the ability to pass a context and additional request options. +// +// See DeletePublicIpv4Pool 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 *EC2) DeletePublicIpv4PoolWithContext(ctx aws.Context, input *DeletePublicIpv4PoolInput, opts ...request.Option) (*DeletePublicIpv4PoolOutput, error) { + req, out := c.DeletePublicIpv4PoolRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteQueuedReservedInstances = "DeleteQueuedReservedInstances" // DeleteQueuedReservedInstancesRequest generates a "aws/request.Request" representing the @@ -13666,6 +14609,157 @@ func (c *EC2) DeprovisionByoipCidrWithContext(ctx aws.Context, input *Deprovisio return out, req.Send() } +const opDeprovisionIpamPoolCidr = "DeprovisionIpamPoolCidr" + +// DeprovisionIpamPoolCidrRequest generates a "aws/request.Request" representing the +// client's request for the DeprovisionIpamPoolCidr 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 DeprovisionIpamPoolCidr for more information on using the DeprovisionIpamPoolCidr +// 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 DeprovisionIpamPoolCidrRequest method. +// req, resp := client.DeprovisionIpamPoolCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeprovisionIpamPoolCidr +func (c *EC2) DeprovisionIpamPoolCidrRequest(input *DeprovisionIpamPoolCidrInput) (req *request.Request, output *DeprovisionIpamPoolCidrOutput) { + op := &request.Operation{ + Name: opDeprovisionIpamPoolCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeprovisionIpamPoolCidrInput{} + } + + output = &DeprovisionIpamPoolCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeprovisionIpamPoolCidr API operation for Amazon Elastic Compute Cloud. +// +// Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR +// from a pool that has a source pool, the CIDR is recycled back into the source +// pool. For more information, see Deprovision pool CIDRs (/vpc/latest/ipam/depro-pool-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DeprovisionIpamPoolCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeprovisionIpamPoolCidr +func (c *EC2) DeprovisionIpamPoolCidr(input *DeprovisionIpamPoolCidrInput) (*DeprovisionIpamPoolCidrOutput, error) { + req, out := c.DeprovisionIpamPoolCidrRequest(input) + return out, req.Send() +} + +// DeprovisionIpamPoolCidrWithContext is the same as DeprovisionIpamPoolCidr with the addition of +// the ability to pass a context and additional request options. +// +// See DeprovisionIpamPoolCidr 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 *EC2) DeprovisionIpamPoolCidrWithContext(ctx aws.Context, input *DeprovisionIpamPoolCidrInput, opts ...request.Option) (*DeprovisionIpamPoolCidrOutput, error) { + req, out := c.DeprovisionIpamPoolCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeprovisionPublicIpv4PoolCidr = "DeprovisionPublicIpv4PoolCidr" + +// DeprovisionPublicIpv4PoolCidrRequest generates a "aws/request.Request" representing the +// client's request for the DeprovisionPublicIpv4PoolCidr 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 DeprovisionPublicIpv4PoolCidr for more information on using the DeprovisionPublicIpv4PoolCidr +// 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 DeprovisionPublicIpv4PoolCidrRequest method. +// req, resp := client.DeprovisionPublicIpv4PoolCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr +func (c *EC2) DeprovisionPublicIpv4PoolCidrRequest(input *DeprovisionPublicIpv4PoolCidrInput) (req *request.Request, output *DeprovisionPublicIpv4PoolCidrOutput) { + op := &request.Operation{ + Name: opDeprovisionPublicIpv4PoolCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeprovisionPublicIpv4PoolCidrInput{} + } + + output = &DeprovisionPublicIpv4PoolCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeprovisionPublicIpv4PoolCidr API operation for Amazon Elastic Compute Cloud. +// +// Deprovision a CIDR from a public IPv4 pool. +// +// 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 Elastic Compute Cloud's +// API operation DeprovisionPublicIpv4PoolCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr +func (c *EC2) DeprovisionPublicIpv4PoolCidr(input *DeprovisionPublicIpv4PoolCidrInput) (*DeprovisionPublicIpv4PoolCidrOutput, error) { + req, out := c.DeprovisionPublicIpv4PoolCidrRequest(input) + return out, req.Send() +} + +// DeprovisionPublicIpv4PoolCidrWithContext is the same as DeprovisionPublicIpv4PoolCidr with the addition of +// the ability to pass a context and additional request options. +// +// See DeprovisionPublicIpv4PoolCidr 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 *EC2) DeprovisionPublicIpv4PoolCidrWithContext(ctx aws.Context, input *DeprovisionPublicIpv4PoolCidrInput, opts ...request.Option) (*DeprovisionPublicIpv4PoolCidrOutput, error) { + req, out := c.DeprovisionPublicIpv4PoolCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeregisterImage = "DeregisterImage" // DeregisterImageRequest generates a "aws/request.Request" representing the @@ -19762,6 +20856,405 @@ func (c *EC2) DescribeInternetGatewaysPagesWithContext(ctx aws.Context, input *D return p.Err() } +const opDescribeIpamPools = "DescribeIpamPools" + +// DescribeIpamPoolsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeIpamPools 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 DescribeIpamPools for more information on using the DescribeIpamPools +// 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 DescribeIpamPoolsRequest method. +// req, resp := client.DescribeIpamPoolsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamPools +func (c *EC2) DescribeIpamPoolsRequest(input *DescribeIpamPoolsInput) (req *request.Request, output *DescribeIpamPoolsOutput) { + op := &request.Operation{ + Name: opDescribeIpamPools, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &DescribeIpamPoolsInput{} + } + + output = &DescribeIpamPoolsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeIpamPools API operation for Amazon Elastic Compute Cloud. +// +// Get information about your IPAM pools. +// +// 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 Elastic Compute Cloud's +// API operation DescribeIpamPools for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamPools +func (c *EC2) DescribeIpamPools(input *DescribeIpamPoolsInput) (*DescribeIpamPoolsOutput, error) { + req, out := c.DescribeIpamPoolsRequest(input) + return out, req.Send() +} + +// DescribeIpamPoolsWithContext is the same as DescribeIpamPools with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeIpamPools 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 *EC2) DescribeIpamPoolsWithContext(ctx aws.Context, input *DescribeIpamPoolsInput, opts ...request.Option) (*DescribeIpamPoolsOutput, error) { + req, out := c.DescribeIpamPoolsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// DescribeIpamPoolsPages iterates over the pages of a DescribeIpamPools operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeIpamPools 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 DescribeIpamPools operation. +// pageNum := 0 +// err := client.DescribeIpamPoolsPages(params, +// func(page *ec2.DescribeIpamPoolsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) DescribeIpamPoolsPages(input *DescribeIpamPoolsInput, fn func(*DescribeIpamPoolsOutput, bool) bool) error { + return c.DescribeIpamPoolsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeIpamPoolsPagesWithContext same as DescribeIpamPoolsPages 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 *EC2) DescribeIpamPoolsPagesWithContext(ctx aws.Context, input *DescribeIpamPoolsInput, fn func(*DescribeIpamPoolsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeIpamPoolsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeIpamPoolsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeIpamPoolsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeIpamScopes = "DescribeIpamScopes" + +// DescribeIpamScopesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeIpamScopes 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 DescribeIpamScopes for more information on using the DescribeIpamScopes +// 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 DescribeIpamScopesRequest method. +// req, resp := client.DescribeIpamScopesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamScopes +func (c *EC2) DescribeIpamScopesRequest(input *DescribeIpamScopesInput) (req *request.Request, output *DescribeIpamScopesOutput) { + op := &request.Operation{ + Name: opDescribeIpamScopes, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &DescribeIpamScopesInput{} + } + + output = &DescribeIpamScopesOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeIpamScopes API operation for Amazon Elastic Compute Cloud. +// +// Get information about your IPAM scopes. +// +// 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 Elastic Compute Cloud's +// API operation DescribeIpamScopes for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpamScopes +func (c *EC2) DescribeIpamScopes(input *DescribeIpamScopesInput) (*DescribeIpamScopesOutput, error) { + req, out := c.DescribeIpamScopesRequest(input) + return out, req.Send() +} + +// DescribeIpamScopesWithContext is the same as DescribeIpamScopes with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeIpamScopes 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 *EC2) DescribeIpamScopesWithContext(ctx aws.Context, input *DescribeIpamScopesInput, opts ...request.Option) (*DescribeIpamScopesOutput, error) { + req, out := c.DescribeIpamScopesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// DescribeIpamScopesPages iterates over the pages of a DescribeIpamScopes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeIpamScopes 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 DescribeIpamScopes operation. +// pageNum := 0 +// err := client.DescribeIpamScopesPages(params, +// func(page *ec2.DescribeIpamScopesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) DescribeIpamScopesPages(input *DescribeIpamScopesInput, fn func(*DescribeIpamScopesOutput, bool) bool) error { + return c.DescribeIpamScopesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeIpamScopesPagesWithContext same as DescribeIpamScopesPages 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 *EC2) DescribeIpamScopesPagesWithContext(ctx aws.Context, input *DescribeIpamScopesInput, fn func(*DescribeIpamScopesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeIpamScopesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeIpamScopesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeIpamScopesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeIpams = "DescribeIpams" + +// DescribeIpamsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeIpams 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 DescribeIpams for more information on using the DescribeIpams +// 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 DescribeIpamsRequest method. +// req, resp := client.DescribeIpamsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpams +func (c *EC2) DescribeIpamsRequest(input *DescribeIpamsInput) (req *request.Request, output *DescribeIpamsOutput) { + op := &request.Operation{ + Name: opDescribeIpams, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &DescribeIpamsInput{} + } + + output = &DescribeIpamsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeIpams API operation for Amazon Elastic Compute Cloud. +// +// Get information about your IPAM pools. +// +// For more information, see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DescribeIpams for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeIpams +func (c *EC2) DescribeIpams(input *DescribeIpamsInput) (*DescribeIpamsOutput, error) { + req, out := c.DescribeIpamsRequest(input) + return out, req.Send() +} + +// DescribeIpamsWithContext is the same as DescribeIpams with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeIpams 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 *EC2) DescribeIpamsWithContext(ctx aws.Context, input *DescribeIpamsInput, opts ...request.Option) (*DescribeIpamsOutput, error) { + req, out := c.DescribeIpamsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// DescribeIpamsPages iterates over the pages of a DescribeIpams operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeIpams 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 DescribeIpams operation. +// pageNum := 0 +// err := client.DescribeIpamsPages(params, +// func(page *ec2.DescribeIpamsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) DescribeIpamsPages(input *DescribeIpamsInput, fn func(*DescribeIpamsOutput, bool) bool) error { + return c.DescribeIpamsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeIpamsPagesWithContext same as DescribeIpamsPages 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 *EC2) DescribeIpamsPagesWithContext(ctx aws.Context, input *DescribeIpamsInput, fn func(*DescribeIpamsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeIpamsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeIpamsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeIpamsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeIpv6Pools = "DescribeIpv6Pools" // DescribeIpv6PoolsRequest generates a "aws/request.Request" representing the @@ -21570,6 +23063,270 @@ func (c *EC2) DescribeNetworkAclsPagesWithContext(ctx aws.Context, input *Descri return p.Err() } +const opDescribeNetworkInsightsAccessScopeAnalyses = "DescribeNetworkInsightsAccessScopeAnalyses" + +// DescribeNetworkInsightsAccessScopeAnalysesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeNetworkInsightsAccessScopeAnalyses 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 DescribeNetworkInsightsAccessScopeAnalyses for more information on using the DescribeNetworkInsightsAccessScopeAnalyses +// 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 DescribeNetworkInsightsAccessScopeAnalysesRequest method. +// req, resp := client.DescribeNetworkInsightsAccessScopeAnalysesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses +func (c *EC2) DescribeNetworkInsightsAccessScopeAnalysesRequest(input *DescribeNetworkInsightsAccessScopeAnalysesInput) (req *request.Request, output *DescribeNetworkInsightsAccessScopeAnalysesOutput) { + op := &request.Operation{ + Name: opDescribeNetworkInsightsAccessScopeAnalyses, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &DescribeNetworkInsightsAccessScopeAnalysesInput{} + } + + output = &DescribeNetworkInsightsAccessScopeAnalysesOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeNetworkInsightsAccessScopeAnalyses API operation for Amazon Elastic Compute Cloud. +// +// Describes the specified Network Access Scope analyses. +// +// 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 Elastic Compute Cloud's +// API operation DescribeNetworkInsightsAccessScopeAnalyses for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses +func (c *EC2) DescribeNetworkInsightsAccessScopeAnalyses(input *DescribeNetworkInsightsAccessScopeAnalysesInput) (*DescribeNetworkInsightsAccessScopeAnalysesOutput, error) { + req, out := c.DescribeNetworkInsightsAccessScopeAnalysesRequest(input) + return out, req.Send() +} + +// DescribeNetworkInsightsAccessScopeAnalysesWithContext is the same as DescribeNetworkInsightsAccessScopeAnalyses with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeNetworkInsightsAccessScopeAnalyses 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 *EC2) DescribeNetworkInsightsAccessScopeAnalysesWithContext(ctx aws.Context, input *DescribeNetworkInsightsAccessScopeAnalysesInput, opts ...request.Option) (*DescribeNetworkInsightsAccessScopeAnalysesOutput, error) { + req, out := c.DescribeNetworkInsightsAccessScopeAnalysesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// DescribeNetworkInsightsAccessScopeAnalysesPages iterates over the pages of a DescribeNetworkInsightsAccessScopeAnalyses operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeNetworkInsightsAccessScopeAnalyses 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 DescribeNetworkInsightsAccessScopeAnalyses operation. +// pageNum := 0 +// err := client.DescribeNetworkInsightsAccessScopeAnalysesPages(params, +// func(page *ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) DescribeNetworkInsightsAccessScopeAnalysesPages(input *DescribeNetworkInsightsAccessScopeAnalysesInput, fn func(*DescribeNetworkInsightsAccessScopeAnalysesOutput, bool) bool) error { + return c.DescribeNetworkInsightsAccessScopeAnalysesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeNetworkInsightsAccessScopeAnalysesPagesWithContext same as DescribeNetworkInsightsAccessScopeAnalysesPages 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 *EC2) DescribeNetworkInsightsAccessScopeAnalysesPagesWithContext(ctx aws.Context, input *DescribeNetworkInsightsAccessScopeAnalysesInput, fn func(*DescribeNetworkInsightsAccessScopeAnalysesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeNetworkInsightsAccessScopeAnalysesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeNetworkInsightsAccessScopeAnalysesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeNetworkInsightsAccessScopeAnalysesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeNetworkInsightsAccessScopes = "DescribeNetworkInsightsAccessScopes" + +// DescribeNetworkInsightsAccessScopesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeNetworkInsightsAccessScopes 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 DescribeNetworkInsightsAccessScopes for more information on using the DescribeNetworkInsightsAccessScopes +// 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 DescribeNetworkInsightsAccessScopesRequest method. +// req, resp := client.DescribeNetworkInsightsAccessScopesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes +func (c *EC2) DescribeNetworkInsightsAccessScopesRequest(input *DescribeNetworkInsightsAccessScopesInput) (req *request.Request, output *DescribeNetworkInsightsAccessScopesOutput) { + op := &request.Operation{ + Name: opDescribeNetworkInsightsAccessScopes, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &DescribeNetworkInsightsAccessScopesInput{} + } + + output = &DescribeNetworkInsightsAccessScopesOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeNetworkInsightsAccessScopes API operation for Amazon Elastic Compute Cloud. +// +// Describes the specified Network Access Scopes. +// +// 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 Elastic Compute Cloud's +// API operation DescribeNetworkInsightsAccessScopes for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes +func (c *EC2) DescribeNetworkInsightsAccessScopes(input *DescribeNetworkInsightsAccessScopesInput) (*DescribeNetworkInsightsAccessScopesOutput, error) { + req, out := c.DescribeNetworkInsightsAccessScopesRequest(input) + return out, req.Send() +} + +// DescribeNetworkInsightsAccessScopesWithContext is the same as DescribeNetworkInsightsAccessScopes with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeNetworkInsightsAccessScopes 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 *EC2) DescribeNetworkInsightsAccessScopesWithContext(ctx aws.Context, input *DescribeNetworkInsightsAccessScopesInput, opts ...request.Option) (*DescribeNetworkInsightsAccessScopesOutput, error) { + req, out := c.DescribeNetworkInsightsAccessScopesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// DescribeNetworkInsightsAccessScopesPages iterates over the pages of a DescribeNetworkInsightsAccessScopes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeNetworkInsightsAccessScopes 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 DescribeNetworkInsightsAccessScopes operation. +// pageNum := 0 +// err := client.DescribeNetworkInsightsAccessScopesPages(params, +// func(page *ec2.DescribeNetworkInsightsAccessScopesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) DescribeNetworkInsightsAccessScopesPages(input *DescribeNetworkInsightsAccessScopesInput, fn func(*DescribeNetworkInsightsAccessScopesOutput, bool) bool) error { + return c.DescribeNetworkInsightsAccessScopesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeNetworkInsightsAccessScopesPagesWithContext same as DescribeNetworkInsightsAccessScopesPages 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 *EC2) DescribeNetworkInsightsAccessScopesPagesWithContext(ctx aws.Context, input *DescribeNetworkInsightsAccessScopesInput, fn func(*DescribeNetworkInsightsAccessScopesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeNetworkInsightsAccessScopesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeNetworkInsightsAccessScopesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeNetworkInsightsAccessScopesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opDescribeNetworkInsightsAnalyses = "DescribeNetworkInsightsAnalyses" // DescribeNetworkInsightsAnalysesRequest generates a "aws/request.Request" representing the @@ -29894,6 +31651,82 @@ func (c *EC2) DisableImageDeprecationWithContext(ctx aws.Context, input *Disable return out, req.Send() } +const opDisableIpamOrganizationAdminAccount = "DisableIpamOrganizationAdminAccount" + +// DisableIpamOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the DisableIpamOrganizationAdminAccount 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 DisableIpamOrganizationAdminAccount for more information on using the DisableIpamOrganizationAdminAccount +// 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 DisableIpamOrganizationAdminAccountRequest method. +// req, resp := client.DisableIpamOrganizationAdminAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DisableIpamOrganizationAdminAccount +func (c *EC2) DisableIpamOrganizationAdminAccountRequest(input *DisableIpamOrganizationAdminAccountInput) (req *request.Request, output *DisableIpamOrganizationAdminAccountOutput) { + op := &request.Operation{ + Name: opDisableIpamOrganizationAdminAccount, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DisableIpamOrganizationAdminAccountInput{} + } + + output = &DisableIpamOrganizationAdminAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// DisableIpamOrganizationAdminAccount API operation for Amazon Elastic Compute Cloud. +// +// Disable the IPAM account. For more information, see Enable integration with +// Organizations (/vpc/latest/ipam/enable-integ-ipam.html) in the Amazon VPC +// IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation DisableIpamOrganizationAdminAccount for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DisableIpamOrganizationAdminAccount +func (c *EC2) DisableIpamOrganizationAdminAccount(input *DisableIpamOrganizationAdminAccountInput) (*DisableIpamOrganizationAdminAccountOutput, error) { + req, out := c.DisableIpamOrganizationAdminAccountRequest(input) + return out, req.Send() +} + +// DisableIpamOrganizationAdminAccountWithContext is the same as DisableIpamOrganizationAdminAccount with the addition of +// the ability to pass a context and additional request options. +// +// See DisableIpamOrganizationAdminAccount 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 *EC2) DisableIpamOrganizationAdminAccountWithContext(ctx aws.Context, input *DisableIpamOrganizationAdminAccountInput, opts ...request.Option) (*DisableIpamOrganizationAdminAccountOutput, error) { + req, out := c.DisableIpamOrganizationAdminAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDisableSerialConsoleAccess = "DisableSerialConsoleAccess" // DisableSerialConsoleAccessRequest generates a "aws/request.Request" representing the @@ -31389,6 +33222,83 @@ func (c *EC2) EnableImageDeprecationWithContext(ctx aws.Context, input *EnableIm return out, req.Send() } +const opEnableIpamOrganizationAdminAccount = "EnableIpamOrganizationAdminAccount" + +// EnableIpamOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the EnableIpamOrganizationAdminAccount 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 EnableIpamOrganizationAdminAccount for more information on using the EnableIpamOrganizationAdminAccount +// 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 EnableIpamOrganizationAdminAccountRequest method. +// req, resp := client.EnableIpamOrganizationAdminAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/EnableIpamOrganizationAdminAccount +func (c *EC2) EnableIpamOrganizationAdminAccountRequest(input *EnableIpamOrganizationAdminAccountInput) (req *request.Request, output *EnableIpamOrganizationAdminAccountOutput) { + op := &request.Operation{ + Name: opEnableIpamOrganizationAdminAccount, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &EnableIpamOrganizationAdminAccountInput{} + } + + output = &EnableIpamOrganizationAdminAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// EnableIpamOrganizationAdminAccount API operation for Amazon Elastic Compute Cloud. +// +// Enable an Organizations member account as the IPAM admin account. You cannot +// select the Organizations management account as the IPAM admin account. For +// more information, see Enable integration with Organizations (/vpc/latest/ipam/enable-integ-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation EnableIpamOrganizationAdminAccount for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/EnableIpamOrganizationAdminAccount +func (c *EC2) EnableIpamOrganizationAdminAccount(input *EnableIpamOrganizationAdminAccountInput) (*EnableIpamOrganizationAdminAccountOutput, error) { + req, out := c.EnableIpamOrganizationAdminAccountRequest(input) + return out, req.Send() +} + +// EnableIpamOrganizationAdminAccountWithContext is the same as EnableIpamOrganizationAdminAccount with the addition of +// the ability to pass a context and additional request options. +// +// See EnableIpamOrganizationAdminAccount 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 *EC2) EnableIpamOrganizationAdminAccountWithContext(ctx aws.Context, input *EnableIpamOrganizationAdminAccountInput, opts ...request.Option) (*EnableIpamOrganizationAdminAccountOutput, error) { + req, out := c.EnableIpamOrganizationAdminAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opEnableSerialConsoleAccess = "EnableSerialConsoleAccess" // EnableSerialConsoleAccessRequest generates a "aws/request.Request" representing the @@ -33373,6 +35283,536 @@ func (c *EC2) GetInstanceTypesFromInstanceRequirementsPagesWithContext(ctx aws.C return p.Err() } +const opGetIpamAddressHistory = "GetIpamAddressHistory" + +// GetIpamAddressHistoryRequest generates a "aws/request.Request" representing the +// client's request for the GetIpamAddressHistory 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 GetIpamAddressHistory for more information on using the GetIpamAddressHistory +// 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 GetIpamAddressHistoryRequest method. +// req, resp := client.GetIpamAddressHistoryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamAddressHistory +func (c *EC2) GetIpamAddressHistoryRequest(input *GetIpamAddressHistoryInput) (req *request.Request, output *GetIpamAddressHistoryOutput) { + op := &request.Operation{ + Name: opGetIpamAddressHistory, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetIpamAddressHistoryInput{} + } + + output = &GetIpamAddressHistoryOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetIpamAddressHistory API operation for Amazon Elastic Compute Cloud. +// +// Retrieve historical information about a CIDR within an IPAM scope. For more +// information, see View the history of IP addresses (/vpc/latest/ipam/view-history-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation GetIpamAddressHistory for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamAddressHistory +func (c *EC2) GetIpamAddressHistory(input *GetIpamAddressHistoryInput) (*GetIpamAddressHistoryOutput, error) { + req, out := c.GetIpamAddressHistoryRequest(input) + return out, req.Send() +} + +// GetIpamAddressHistoryWithContext is the same as GetIpamAddressHistory with the addition of +// the ability to pass a context and additional request options. +// +// See GetIpamAddressHistory 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 *EC2) GetIpamAddressHistoryWithContext(ctx aws.Context, input *GetIpamAddressHistoryInput, opts ...request.Option) (*GetIpamAddressHistoryOutput, error) { + req, out := c.GetIpamAddressHistoryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetIpamAddressHistoryPages iterates over the pages of a GetIpamAddressHistory operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetIpamAddressHistory 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 GetIpamAddressHistory operation. +// pageNum := 0 +// err := client.GetIpamAddressHistoryPages(params, +// func(page *ec2.GetIpamAddressHistoryOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) GetIpamAddressHistoryPages(input *GetIpamAddressHistoryInput, fn func(*GetIpamAddressHistoryOutput, bool) bool) error { + return c.GetIpamAddressHistoryPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetIpamAddressHistoryPagesWithContext same as GetIpamAddressHistoryPages 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 *EC2) GetIpamAddressHistoryPagesWithContext(ctx aws.Context, input *GetIpamAddressHistoryInput, fn func(*GetIpamAddressHistoryOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetIpamAddressHistoryInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetIpamAddressHistoryRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetIpamAddressHistoryOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetIpamPoolAllocations = "GetIpamPoolAllocations" + +// GetIpamPoolAllocationsRequest generates a "aws/request.Request" representing the +// client's request for the GetIpamPoolAllocations 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 GetIpamPoolAllocations for more information on using the GetIpamPoolAllocations +// 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 GetIpamPoolAllocationsRequest method. +// req, resp := client.GetIpamPoolAllocationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamPoolAllocations +func (c *EC2) GetIpamPoolAllocationsRequest(input *GetIpamPoolAllocationsInput) (req *request.Request, output *GetIpamPoolAllocationsOutput) { + op := &request.Operation{ + Name: opGetIpamPoolAllocations, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetIpamPoolAllocationsInput{} + } + + output = &GetIpamPoolAllocationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetIpamPoolAllocations API operation for Amazon Elastic Compute Cloud. +// +// Get a list of all the CIDR allocations in an IPAM pool. +// +// 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 Elastic Compute Cloud's +// API operation GetIpamPoolAllocations for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamPoolAllocations +func (c *EC2) GetIpamPoolAllocations(input *GetIpamPoolAllocationsInput) (*GetIpamPoolAllocationsOutput, error) { + req, out := c.GetIpamPoolAllocationsRequest(input) + return out, req.Send() +} + +// GetIpamPoolAllocationsWithContext is the same as GetIpamPoolAllocations with the addition of +// the ability to pass a context and additional request options. +// +// See GetIpamPoolAllocations 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 *EC2) GetIpamPoolAllocationsWithContext(ctx aws.Context, input *GetIpamPoolAllocationsInput, opts ...request.Option) (*GetIpamPoolAllocationsOutput, error) { + req, out := c.GetIpamPoolAllocationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetIpamPoolAllocationsPages iterates over the pages of a GetIpamPoolAllocations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetIpamPoolAllocations 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 GetIpamPoolAllocations operation. +// pageNum := 0 +// err := client.GetIpamPoolAllocationsPages(params, +// func(page *ec2.GetIpamPoolAllocationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) GetIpamPoolAllocationsPages(input *GetIpamPoolAllocationsInput, fn func(*GetIpamPoolAllocationsOutput, bool) bool) error { + return c.GetIpamPoolAllocationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetIpamPoolAllocationsPagesWithContext same as GetIpamPoolAllocationsPages 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 *EC2) GetIpamPoolAllocationsPagesWithContext(ctx aws.Context, input *GetIpamPoolAllocationsInput, fn func(*GetIpamPoolAllocationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetIpamPoolAllocationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetIpamPoolAllocationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetIpamPoolAllocationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetIpamPoolCidrs = "GetIpamPoolCidrs" + +// GetIpamPoolCidrsRequest generates a "aws/request.Request" representing the +// client's request for the GetIpamPoolCidrs 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 GetIpamPoolCidrs for more information on using the GetIpamPoolCidrs +// 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 GetIpamPoolCidrsRequest method. +// req, resp := client.GetIpamPoolCidrsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamPoolCidrs +func (c *EC2) GetIpamPoolCidrsRequest(input *GetIpamPoolCidrsInput) (req *request.Request, output *GetIpamPoolCidrsOutput) { + op := &request.Operation{ + Name: opGetIpamPoolCidrs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetIpamPoolCidrsInput{} + } + + output = &GetIpamPoolCidrsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetIpamPoolCidrs API operation for Amazon Elastic Compute Cloud. +// +// Get the CIDRs provisioned to an IPAM pool. +// +// 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 Elastic Compute Cloud's +// API operation GetIpamPoolCidrs for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamPoolCidrs +func (c *EC2) GetIpamPoolCidrs(input *GetIpamPoolCidrsInput) (*GetIpamPoolCidrsOutput, error) { + req, out := c.GetIpamPoolCidrsRequest(input) + return out, req.Send() +} + +// GetIpamPoolCidrsWithContext is the same as GetIpamPoolCidrs with the addition of +// the ability to pass a context and additional request options. +// +// See GetIpamPoolCidrs 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 *EC2) GetIpamPoolCidrsWithContext(ctx aws.Context, input *GetIpamPoolCidrsInput, opts ...request.Option) (*GetIpamPoolCidrsOutput, error) { + req, out := c.GetIpamPoolCidrsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetIpamPoolCidrsPages iterates over the pages of a GetIpamPoolCidrs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetIpamPoolCidrs 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 GetIpamPoolCidrs operation. +// pageNum := 0 +// err := client.GetIpamPoolCidrsPages(params, +// func(page *ec2.GetIpamPoolCidrsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) GetIpamPoolCidrsPages(input *GetIpamPoolCidrsInput, fn func(*GetIpamPoolCidrsOutput, bool) bool) error { + return c.GetIpamPoolCidrsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetIpamPoolCidrsPagesWithContext same as GetIpamPoolCidrsPages 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 *EC2) GetIpamPoolCidrsPagesWithContext(ctx aws.Context, input *GetIpamPoolCidrsInput, fn func(*GetIpamPoolCidrsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetIpamPoolCidrsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetIpamPoolCidrsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetIpamPoolCidrsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetIpamResourceCidrs = "GetIpamResourceCidrs" + +// GetIpamResourceCidrsRequest generates a "aws/request.Request" representing the +// client's request for the GetIpamResourceCidrs 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 GetIpamResourceCidrs for more information on using the GetIpamResourceCidrs +// 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 GetIpamResourceCidrsRequest method. +// req, resp := client.GetIpamResourceCidrsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamResourceCidrs +func (c *EC2) GetIpamResourceCidrsRequest(input *GetIpamResourceCidrsInput) (req *request.Request, output *GetIpamResourceCidrsOutput) { + op := &request.Operation{ + Name: opGetIpamResourceCidrs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetIpamResourceCidrsInput{} + } + + output = &GetIpamResourceCidrsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetIpamResourceCidrs API operation for Amazon Elastic Compute Cloud. +// +// Get information about the resources in a scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation GetIpamResourceCidrs for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetIpamResourceCidrs +func (c *EC2) GetIpamResourceCidrs(input *GetIpamResourceCidrsInput) (*GetIpamResourceCidrsOutput, error) { + req, out := c.GetIpamResourceCidrsRequest(input) + return out, req.Send() +} + +// GetIpamResourceCidrsWithContext is the same as GetIpamResourceCidrs with the addition of +// the ability to pass a context and additional request options. +// +// See GetIpamResourceCidrs 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 *EC2) GetIpamResourceCidrsWithContext(ctx aws.Context, input *GetIpamResourceCidrsInput, opts ...request.Option) (*GetIpamResourceCidrsOutput, error) { + req, out := c.GetIpamResourceCidrsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetIpamResourceCidrsPages iterates over the pages of a GetIpamResourceCidrs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetIpamResourceCidrs 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 GetIpamResourceCidrs operation. +// pageNum := 0 +// err := client.GetIpamResourceCidrsPages(params, +// func(page *ec2.GetIpamResourceCidrsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EC2) GetIpamResourceCidrsPages(input *GetIpamResourceCidrsInput, fn func(*GetIpamResourceCidrsOutput, bool) bool) error { + return c.GetIpamResourceCidrsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetIpamResourceCidrsPagesWithContext same as GetIpamResourceCidrsPages 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 *EC2) GetIpamResourceCidrsPagesWithContext(ctx aws.Context, input *GetIpamResourceCidrsInput, fn func(*GetIpamResourceCidrsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetIpamResourceCidrsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetIpamResourceCidrsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetIpamResourceCidrsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetLaunchTemplateData = "GetLaunchTemplateData" // GetLaunchTemplateDataRequest generates a "aws/request.Request" representing the @@ -33719,6 +36159,154 @@ func (c *EC2) GetManagedPrefixListEntriesPagesWithContext(ctx aws.Context, input return p.Err() } +const opGetNetworkInsightsAccessScopeAnalysisFindings = "GetNetworkInsightsAccessScopeAnalysisFindings" + +// GetNetworkInsightsAccessScopeAnalysisFindingsRequest generates a "aws/request.Request" representing the +// client's request for the GetNetworkInsightsAccessScopeAnalysisFindings 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 GetNetworkInsightsAccessScopeAnalysisFindings for more information on using the GetNetworkInsightsAccessScopeAnalysisFindings +// 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 GetNetworkInsightsAccessScopeAnalysisFindingsRequest method. +// req, resp := client.GetNetworkInsightsAccessScopeAnalysisFindingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings +func (c *EC2) GetNetworkInsightsAccessScopeAnalysisFindingsRequest(input *GetNetworkInsightsAccessScopeAnalysisFindingsInput) (req *request.Request, output *GetNetworkInsightsAccessScopeAnalysisFindingsOutput) { + op := &request.Operation{ + Name: opGetNetworkInsightsAccessScopeAnalysisFindings, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetNetworkInsightsAccessScopeAnalysisFindingsInput{} + } + + output = &GetNetworkInsightsAccessScopeAnalysisFindingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetNetworkInsightsAccessScopeAnalysisFindings API operation for Amazon Elastic Compute Cloud. +// +// Gets the findings for the specified Network Access Scope 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 Elastic Compute Cloud's +// API operation GetNetworkInsightsAccessScopeAnalysisFindings for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings +func (c *EC2) GetNetworkInsightsAccessScopeAnalysisFindings(input *GetNetworkInsightsAccessScopeAnalysisFindingsInput) (*GetNetworkInsightsAccessScopeAnalysisFindingsOutput, error) { + req, out := c.GetNetworkInsightsAccessScopeAnalysisFindingsRequest(input) + return out, req.Send() +} + +// GetNetworkInsightsAccessScopeAnalysisFindingsWithContext is the same as GetNetworkInsightsAccessScopeAnalysisFindings with the addition of +// the ability to pass a context and additional request options. +// +// See GetNetworkInsightsAccessScopeAnalysisFindings 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 *EC2) GetNetworkInsightsAccessScopeAnalysisFindingsWithContext(ctx aws.Context, input *GetNetworkInsightsAccessScopeAnalysisFindingsInput, opts ...request.Option) (*GetNetworkInsightsAccessScopeAnalysisFindingsOutput, error) { + req, out := c.GetNetworkInsightsAccessScopeAnalysisFindingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetNetworkInsightsAccessScopeContent = "GetNetworkInsightsAccessScopeContent" + +// GetNetworkInsightsAccessScopeContentRequest generates a "aws/request.Request" representing the +// client's request for the GetNetworkInsightsAccessScopeContent 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 GetNetworkInsightsAccessScopeContent for more information on using the GetNetworkInsightsAccessScopeContent +// 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 GetNetworkInsightsAccessScopeContentRequest method. +// req, resp := client.GetNetworkInsightsAccessScopeContentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent +func (c *EC2) GetNetworkInsightsAccessScopeContentRequest(input *GetNetworkInsightsAccessScopeContentInput) (req *request.Request, output *GetNetworkInsightsAccessScopeContentOutput) { + op := &request.Operation{ + Name: opGetNetworkInsightsAccessScopeContent, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetNetworkInsightsAccessScopeContentInput{} + } + + output = &GetNetworkInsightsAccessScopeContentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetNetworkInsightsAccessScopeContent API operation for Amazon Elastic Compute Cloud. +// +// Gets the content for the specified Network Access Scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation GetNetworkInsightsAccessScopeContent for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent +func (c *EC2) GetNetworkInsightsAccessScopeContent(input *GetNetworkInsightsAccessScopeContentInput) (*GetNetworkInsightsAccessScopeContentOutput, error) { + req, out := c.GetNetworkInsightsAccessScopeContentRequest(input) + return out, req.Send() +} + +// GetNetworkInsightsAccessScopeContentWithContext is the same as GetNetworkInsightsAccessScopeContent with the addition of +// the ability to pass a context and additional request options. +// +// See GetNetworkInsightsAccessScopeContent 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 *EC2) GetNetworkInsightsAccessScopeContentWithContext(ctx aws.Context, input *GetNetworkInsightsAccessScopeContentInput, opts ...request.Option) (*GetNetworkInsightsAccessScopeContentOutput, error) { + req, out := c.GetNetworkInsightsAccessScopeContentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetPasswordData = "GetPasswordData" // GetPasswordDataRequest generates a "aws/request.Request" representing the @@ -37355,6 +39943,313 @@ func (c *EC2) ModifyInstancePlacementWithContext(ctx aws.Context, input *ModifyI return out, req.Send() } +const opModifyIpam = "ModifyIpam" + +// ModifyIpamRequest generates a "aws/request.Request" representing the +// client's request for the ModifyIpam 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 ModifyIpam for more information on using the ModifyIpam +// 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 ModifyIpamRequest method. +// req, resp := client.ModifyIpamRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpam +func (c *EC2) ModifyIpamRequest(input *ModifyIpamInput) (req *request.Request, output *ModifyIpamOutput) { + op := &request.Operation{ + Name: opModifyIpam, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyIpamInput{} + } + + output = &ModifyIpamOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyIpam API operation for Amazon Elastic Compute Cloud. +// +// Modify the configurations of an IPAM. +// +// 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 Elastic Compute Cloud's +// API operation ModifyIpam for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpam +func (c *EC2) ModifyIpam(input *ModifyIpamInput) (*ModifyIpamOutput, error) { + req, out := c.ModifyIpamRequest(input) + return out, req.Send() +} + +// ModifyIpamWithContext is the same as ModifyIpam with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyIpam 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 *EC2) ModifyIpamWithContext(ctx aws.Context, input *ModifyIpamInput, opts ...request.Option) (*ModifyIpamOutput, error) { + req, out := c.ModifyIpamRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opModifyIpamPool = "ModifyIpamPool" + +// ModifyIpamPoolRequest generates a "aws/request.Request" representing the +// client's request for the ModifyIpamPool 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 ModifyIpamPool for more information on using the ModifyIpamPool +// 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 ModifyIpamPoolRequest method. +// req, resp := client.ModifyIpamPoolRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamPool +func (c *EC2) ModifyIpamPoolRequest(input *ModifyIpamPoolInput) (req *request.Request, output *ModifyIpamPoolOutput) { + op := &request.Operation{ + Name: opModifyIpamPool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyIpamPoolInput{} + } + + output = &ModifyIpamPoolOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyIpamPool API operation for Amazon Elastic Compute Cloud. +// +// Modify the configurations of an IPAM pool. +// +// For more information, see Modify a pool (/vpc/latest/ipam/mod-pool-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ModifyIpamPool for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamPool +func (c *EC2) ModifyIpamPool(input *ModifyIpamPoolInput) (*ModifyIpamPoolOutput, error) { + req, out := c.ModifyIpamPoolRequest(input) + return out, req.Send() +} + +// ModifyIpamPoolWithContext is the same as ModifyIpamPool with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyIpamPool 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 *EC2) ModifyIpamPoolWithContext(ctx aws.Context, input *ModifyIpamPoolInput, opts ...request.Option) (*ModifyIpamPoolOutput, error) { + req, out := c.ModifyIpamPoolRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opModifyIpamResourceCidr = "ModifyIpamResourceCidr" + +// ModifyIpamResourceCidrRequest generates a "aws/request.Request" representing the +// client's request for the ModifyIpamResourceCidr 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 ModifyIpamResourceCidr for more information on using the ModifyIpamResourceCidr +// 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 ModifyIpamResourceCidrRequest method. +// req, resp := client.ModifyIpamResourceCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamResourceCidr +func (c *EC2) ModifyIpamResourceCidrRequest(input *ModifyIpamResourceCidrInput) (req *request.Request, output *ModifyIpamResourceCidrOutput) { + op := &request.Operation{ + Name: opModifyIpamResourceCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyIpamResourceCidrInput{} + } + + output = &ModifyIpamResourceCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyIpamResourceCidr API operation for Amazon Elastic Compute Cloud. +// +// Modify a resource CIDR. You can use this action to transfer resource CIDRs +// between scopes and ignore resource CIDRs that you do not want to manage. +// If set to false, the resource will not be tracked for overlap, it cannot +// be auto-imported into a pool, and it will be removed from any pool it has +// an allocation in. +// +// For more information, see Move resource CIDRs between scopes (/vpc/latest/ipam/move-resource-ipam.html) +// and Change the monitoring state of resource CIDRs (/vpc/latest/ipam/change-monitoring-state-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ModifyIpamResourceCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamResourceCidr +func (c *EC2) ModifyIpamResourceCidr(input *ModifyIpamResourceCidrInput) (*ModifyIpamResourceCidrOutput, error) { + req, out := c.ModifyIpamResourceCidrRequest(input) + return out, req.Send() +} + +// ModifyIpamResourceCidrWithContext is the same as ModifyIpamResourceCidr with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyIpamResourceCidr 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 *EC2) ModifyIpamResourceCidrWithContext(ctx aws.Context, input *ModifyIpamResourceCidrInput, opts ...request.Option) (*ModifyIpamResourceCidrOutput, error) { + req, out := c.ModifyIpamResourceCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opModifyIpamScope = "ModifyIpamScope" + +// ModifyIpamScopeRequest generates a "aws/request.Request" representing the +// client's request for the ModifyIpamScope 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 ModifyIpamScope for more information on using the ModifyIpamScope +// 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 ModifyIpamScopeRequest method. +// req, resp := client.ModifyIpamScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamScope +func (c *EC2) ModifyIpamScopeRequest(input *ModifyIpamScopeInput) (req *request.Request, output *ModifyIpamScopeOutput) { + op := &request.Operation{ + Name: opModifyIpamScope, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ModifyIpamScopeInput{} + } + + output = &ModifyIpamScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// ModifyIpamScope API operation for Amazon Elastic Compute Cloud. +// +// Modify an IPAM scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ModifyIpamScope for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyIpamScope +func (c *EC2) ModifyIpamScope(input *ModifyIpamScopeInput) (*ModifyIpamScopeOutput, error) { + req, out := c.ModifyIpamScopeRequest(input) + return out, req.Send() +} + +// ModifyIpamScopeWithContext is the same as ModifyIpamScope with the addition of +// the ability to pass a context and additional request options. +// +// See ModifyIpamScope 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 *EC2) ModifyIpamScopeWithContext(ctx aws.Context, input *ModifyIpamScopeInput, opts ...request.Option) (*ModifyIpamScopeOutput, error) { + req, out := c.ModifyIpamScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opModifyLaunchTemplate = "ModifyLaunchTemplate" // ModifyLaunchTemplateRequest generates a "aws/request.Request" representing the @@ -39892,6 +42787,80 @@ func (c *EC2) MoveAddressToVpcWithContext(ctx aws.Context, input *MoveAddressToV return out, req.Send() } +const opMoveByoipCidrToIpam = "MoveByoipCidrToIpam" + +// MoveByoipCidrToIpamRequest generates a "aws/request.Request" representing the +// client's request for the MoveByoipCidrToIpam 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 MoveByoipCidrToIpam for more information on using the MoveByoipCidrToIpam +// 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 MoveByoipCidrToIpamRequest method. +// req, resp := client.MoveByoipCidrToIpamRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/MoveByoipCidrToIpam +func (c *EC2) MoveByoipCidrToIpamRequest(input *MoveByoipCidrToIpamInput) (req *request.Request, output *MoveByoipCidrToIpamOutput) { + op := &request.Operation{ + Name: opMoveByoipCidrToIpam, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &MoveByoipCidrToIpamInput{} + } + + output = &MoveByoipCidrToIpamOutput{} + req = c.newRequest(op, input, output) + return +} + +// MoveByoipCidrToIpam API operation for Amazon Elastic Compute Cloud. +// +// Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool. +// +// 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 Elastic Compute Cloud's +// API operation MoveByoipCidrToIpam for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/MoveByoipCidrToIpam +func (c *EC2) MoveByoipCidrToIpam(input *MoveByoipCidrToIpamInput) (*MoveByoipCidrToIpamOutput, error) { + req, out := c.MoveByoipCidrToIpamRequest(input) + return out, req.Send() +} + +// MoveByoipCidrToIpamWithContext is the same as MoveByoipCidrToIpam with the addition of +// the ability to pass a context and additional request options. +// +// See MoveByoipCidrToIpam 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 *EC2) MoveByoipCidrToIpamWithContext(ctx aws.Context, input *MoveByoipCidrToIpamInput, opts ...request.Option) (*MoveByoipCidrToIpamOutput, error) { + req, out := c.MoveByoipCidrToIpamRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opProvisionByoipCidr = "ProvisionByoipCidr" // ProvisionByoipCidrRequest generates a "aws/request.Request" representing the @@ -39983,6 +42952,162 @@ func (c *EC2) ProvisionByoipCidrWithContext(ctx aws.Context, input *ProvisionByo return out, req.Send() } +const opProvisionIpamPoolCidr = "ProvisionIpamPoolCidr" + +// ProvisionIpamPoolCidrRequest generates a "aws/request.Request" representing the +// client's request for the ProvisionIpamPoolCidr 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 ProvisionIpamPoolCidr for more information on using the ProvisionIpamPoolCidr +// 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 ProvisionIpamPoolCidrRequest method. +// req, resp := client.ProvisionIpamPoolCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ProvisionIpamPoolCidr +func (c *EC2) ProvisionIpamPoolCidrRequest(input *ProvisionIpamPoolCidrInput) (req *request.Request, output *ProvisionIpamPoolCidrOutput) { + op := &request.Operation{ + Name: opProvisionIpamPoolCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ProvisionIpamPoolCidrInput{} + } + + output = &ProvisionIpamPoolCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// ProvisionIpamPoolCidr API operation for Amazon Elastic Compute Cloud. +// +// Provision a CIDR to an IPAM pool. You can use thsi action to provision new +// CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to +// a pool within it. +// +// For more information, see Provision CIDRs to pools (/vpc/latest/ipam/prov-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ProvisionIpamPoolCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ProvisionIpamPoolCidr +func (c *EC2) ProvisionIpamPoolCidr(input *ProvisionIpamPoolCidrInput) (*ProvisionIpamPoolCidrOutput, error) { + req, out := c.ProvisionIpamPoolCidrRequest(input) + return out, req.Send() +} + +// ProvisionIpamPoolCidrWithContext is the same as ProvisionIpamPoolCidr with the addition of +// the ability to pass a context and additional request options. +// +// See ProvisionIpamPoolCidr 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 *EC2) ProvisionIpamPoolCidrWithContext(ctx aws.Context, input *ProvisionIpamPoolCidrInput, opts ...request.Option) (*ProvisionIpamPoolCidrOutput, error) { + req, out := c.ProvisionIpamPoolCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opProvisionPublicIpv4PoolCidr = "ProvisionPublicIpv4PoolCidr" + +// ProvisionPublicIpv4PoolCidrRequest generates a "aws/request.Request" representing the +// client's request for the ProvisionPublicIpv4PoolCidr 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 ProvisionPublicIpv4PoolCidr for more information on using the ProvisionPublicIpv4PoolCidr +// 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 ProvisionPublicIpv4PoolCidrRequest method. +// req, resp := client.ProvisionPublicIpv4PoolCidrRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr +func (c *EC2) ProvisionPublicIpv4PoolCidrRequest(input *ProvisionPublicIpv4PoolCidrInput) (req *request.Request, output *ProvisionPublicIpv4PoolCidrOutput) { + op := &request.Operation{ + Name: opProvisionPublicIpv4PoolCidr, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ProvisionPublicIpv4PoolCidrInput{} + } + + output = &ProvisionPublicIpv4PoolCidrOutput{} + req = c.newRequest(op, input, output) + return +} + +// ProvisionPublicIpv4PoolCidr API operation for Amazon Elastic Compute Cloud. +// +// Provision a CIDR to a public IPv4 pool. +// +// For more information about IPAM, see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ProvisionPublicIpv4PoolCidr for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr +func (c *EC2) ProvisionPublicIpv4PoolCidr(input *ProvisionPublicIpv4PoolCidrInput) (*ProvisionPublicIpv4PoolCidrOutput, error) { + req, out := c.ProvisionPublicIpv4PoolCidrRequest(input) + return out, req.Send() +} + +// ProvisionPublicIpv4PoolCidrWithContext is the same as ProvisionPublicIpv4PoolCidr with the addition of +// the ability to pass a context and additional request options. +// +// See ProvisionPublicIpv4PoolCidr 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 *EC2) ProvisionPublicIpv4PoolCidrWithContext(ctx aws.Context, input *ProvisionPublicIpv4PoolCidrInput, opts ...request.Option) (*ProvisionPublicIpv4PoolCidrOutput, error) { + req, out := c.ProvisionPublicIpv4PoolCidrRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opPurchaseHostReservation = "PurchaseHostReservation" // PurchaseHostReservationRequest generates a "aws/request.Request" representing the @@ -41235,6 +44360,85 @@ func (c *EC2) ReleaseHostsWithContext(ctx aws.Context, input *ReleaseHostsInput, return out, req.Send() } +const opReleaseIpamPoolAllocation = "ReleaseIpamPoolAllocation" + +// ReleaseIpamPoolAllocationRequest generates a "aws/request.Request" representing the +// client's request for the ReleaseIpamPoolAllocation 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 ReleaseIpamPoolAllocation for more information on using the ReleaseIpamPoolAllocation +// 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 ReleaseIpamPoolAllocationRequest method. +// req, resp := client.ReleaseIpamPoolAllocationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ReleaseIpamPoolAllocation +func (c *EC2) ReleaseIpamPoolAllocationRequest(input *ReleaseIpamPoolAllocationInput) (req *request.Request, output *ReleaseIpamPoolAllocationOutput) { + op := &request.Operation{ + Name: opReleaseIpamPoolAllocation, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ReleaseIpamPoolAllocationInput{} + } + + output = &ReleaseIpamPoolAllocationOutput{} + req = c.newRequest(op, input, output) + return +} + +// ReleaseIpamPoolAllocation API operation for Amazon Elastic Compute Cloud. +// +// Release an allocation within an IPAM pool. You can only use this action to +// release manual allocations. To remove an allocation for a resource without +// deleting the resource, set its monitored state to false using ModifyIpamResourceCidr +// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html). +// For more information, see Release an allocation (/vpc/latest/ipam/release-pool-alloc-ipam.html) +// in the Amazon VPC IPAM User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation ReleaseIpamPoolAllocation for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ReleaseIpamPoolAllocation +func (c *EC2) ReleaseIpamPoolAllocation(input *ReleaseIpamPoolAllocationInput) (*ReleaseIpamPoolAllocationOutput, error) { + req, out := c.ReleaseIpamPoolAllocationRequest(input) + return out, req.Send() +} + +// ReleaseIpamPoolAllocationWithContext is the same as ReleaseIpamPoolAllocation with the addition of +// the ability to pass a context and additional request options. +// +// See ReleaseIpamPoolAllocation 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 *EC2) ReleaseIpamPoolAllocationWithContext(ctx aws.Context, input *ReleaseIpamPoolAllocationInput, opts ...request.Option) (*ReleaseIpamPoolAllocationOutput, error) { + req, out := c.ReleaseIpamPoolAllocationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opReplaceIamInstanceProfileAssociation = "ReplaceIamInstanceProfileAssociation" // ReplaceIamInstanceProfileAssociationRequest generates a "aws/request.Request" representing the @@ -43815,6 +47019,80 @@ func (c *EC2) StartInstancesWithContext(ctx aws.Context, input *StartInstancesIn return out, req.Send() } +const opStartNetworkInsightsAccessScopeAnalysis = "StartNetworkInsightsAccessScopeAnalysis" + +// StartNetworkInsightsAccessScopeAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the StartNetworkInsightsAccessScopeAnalysis 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 StartNetworkInsightsAccessScopeAnalysis for more information on using the StartNetworkInsightsAccessScopeAnalysis +// 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 StartNetworkInsightsAccessScopeAnalysisRequest method. +// req, resp := client.StartNetworkInsightsAccessScopeAnalysisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis +func (c *EC2) StartNetworkInsightsAccessScopeAnalysisRequest(input *StartNetworkInsightsAccessScopeAnalysisInput) (req *request.Request, output *StartNetworkInsightsAccessScopeAnalysisOutput) { + op := &request.Operation{ + Name: opStartNetworkInsightsAccessScopeAnalysis, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartNetworkInsightsAccessScopeAnalysisInput{} + } + + output = &StartNetworkInsightsAccessScopeAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartNetworkInsightsAccessScopeAnalysis API operation for Amazon Elastic Compute Cloud. +// +// Starts analyzing the specified Network Access Scope. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Elastic Compute Cloud's +// API operation StartNetworkInsightsAccessScopeAnalysis for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis +func (c *EC2) StartNetworkInsightsAccessScopeAnalysis(input *StartNetworkInsightsAccessScopeAnalysisInput) (*StartNetworkInsightsAccessScopeAnalysisOutput, error) { + req, out := c.StartNetworkInsightsAccessScopeAnalysisRequest(input) + return out, req.Send() +} + +// StartNetworkInsightsAccessScopeAnalysisWithContext is the same as StartNetworkInsightsAccessScopeAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See StartNetworkInsightsAccessScopeAnalysis 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 *EC2) StartNetworkInsightsAccessScopeAnalysisWithContext(ctx aws.Context, input *StartNetworkInsightsAccessScopeAnalysisInput, opts ...request.Option) (*StartNetworkInsightsAccessScopeAnalysisOutput, error) { + req, out := c.StartNetworkInsightsAccessScopeAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartNetworkInsightsAnalysis = "StartNetworkInsightsAnalysis" // StartNetworkInsightsAnalysisRequest generates a "aws/request.Request" representing the @@ -45487,6 +48765,165 @@ func (s *AcceptVpcPeeringConnectionOutput) SetVpcPeeringConnection(v *VpcPeering return s } +// Describes a finding for a Network Access Scope. +type AccessScopeAnalysisFinding struct { + _ struct{} `type:"structure"` + + // The finding components. + FindingComponents []*PathComponent `locationName:"findingComponentSet" locationNameList:"item" type:"list"` + + // The ID of the finding. + FindingId *string `locationName:"findingId" type:"string"` + + // The ID of the Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysisId *string `locationName:"networkInsightsAccessScopeAnalysisId" type:"string"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `locationName:"networkInsightsAccessScopeId" 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 AccessScopeAnalysisFinding) 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 AccessScopeAnalysisFinding) GoString() string { + return s.String() +} + +// SetFindingComponents sets the FindingComponents field's value. +func (s *AccessScopeAnalysisFinding) SetFindingComponents(v []*PathComponent) *AccessScopeAnalysisFinding { + s.FindingComponents = v + return s +} + +// SetFindingId sets the FindingId field's value. +func (s *AccessScopeAnalysisFinding) SetFindingId(v string) *AccessScopeAnalysisFinding { + s.FindingId = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *AccessScopeAnalysisFinding) SetNetworkInsightsAccessScopeAnalysisId(v string) *AccessScopeAnalysisFinding { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *AccessScopeAnalysisFinding) SetNetworkInsightsAccessScopeId(v string) *AccessScopeAnalysisFinding { + s.NetworkInsightsAccessScopeId = &v + return s +} + +// Describes a path. +type AccessScopePath struct { + _ struct{} `type:"structure"` + + // The destination. + Destination *PathStatement `locationName:"destination" type:"structure"` + + // The source. + Source *PathStatement `locationName:"source" type:"structure"` + + // The through resources. + ThroughResources []*ThroughResourcesStatement `locationName:"throughResourceSet" locationNameList:"item" 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 AccessScopePath) 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 AccessScopePath) GoString() string { + return s.String() +} + +// SetDestination sets the Destination field's value. +func (s *AccessScopePath) SetDestination(v *PathStatement) *AccessScopePath { + s.Destination = v + return s +} + +// SetSource sets the Source field's value. +func (s *AccessScopePath) SetSource(v *PathStatement) *AccessScopePath { + s.Source = v + return s +} + +// SetThroughResources sets the ThroughResources field's value. +func (s *AccessScopePath) SetThroughResources(v []*ThroughResourcesStatement) *AccessScopePath { + s.ThroughResources = v + return s +} + +// Describes a path. +type AccessScopePathRequest struct { + _ struct{} `type:"structure"` + + // The destination. + Destination *PathStatementRequest `type:"structure"` + + // The source. + Source *PathStatementRequest `type:"structure"` + + // The through resources. + ThroughResources []*ThroughResourcesStatementRequest `locationName:"ThroughResource" locationNameList:"item" 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 AccessScopePathRequest) 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 AccessScopePathRequest) GoString() string { + return s.String() +} + +// SetDestination sets the Destination field's value. +func (s *AccessScopePathRequest) SetDestination(v *PathStatementRequest) *AccessScopePathRequest { + s.Destination = v + return s +} + +// SetSource sets the Source field's value. +func (s *AccessScopePathRequest) SetSource(v *PathStatementRequest) *AccessScopePathRequest { + s.Source = v + return s +} + +// SetThroughResources sets the ThroughResources field's value. +func (s *AccessScopePathRequest) SetThroughResources(v []*ThroughResourcesStatementRequest) *AccessScopePathRequest { + s.ThroughResources = v + return s +} + // Describes an account attribute. type AccountAttribute struct { _ struct{} `type:"structure"` @@ -45621,6 +49058,44 @@ func (s *ActiveInstance) SetSpotInstanceRequestId(v string) *ActiveInstance { return s } +// Add an operating Region to an IPAM. Operating Regions are Amazon Web Services +// Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers +// and monitors resources in the Amazon Web Services Regions you select as operating +// Regions. +// +// For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) +// in the Amazon VPC IPAM User Guide. +type AddIpamOperatingRegion struct { + _ struct{} `type:"structure"` + + // The name of the operating Region. + RegionName *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 AddIpamOperatingRegion) 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 AddIpamOperatingRegion) GoString() string { + return s.String() +} + +// SetRegionName sets the RegionName field's value. +func (s *AddIpamOperatingRegion) SetRegionName(v string) *AddIpamOperatingRegion { + s.RegionName = &v + return s +} + // An entry for a prefix list. type AddPrefixListEntry struct { _ struct{} `type:"structure"` @@ -46357,6 +49832,170 @@ func (s *AllocateHostsOutput) SetHostIds(v []*string) *AllocateHostsOutput { return s } +type AllocateIpamPoolCidrInput struct { + _ struct{} `type:"structure"` + + // The CIDR you would like to allocate from the IPAM pool. Note the following: + // + // * If there is no DefaultNetmaskLength allocation rule set on the pool, + // you must specify either the NetmaskLength or the CIDR. + // + // * If the DefaultNetmaskLength allocation rule is set on the pool, you + // can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength + // allocation rule will be ignored. + // + // Possible values: Any available IPv4 or IPv6 CIDR. + Cidr *string `type:"string"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // A description for the allocation. + Description *string `type:"string"` + + // Exclude a particular CIDR range from being returned by the pool. + DisallowedCidrs []*string `locationName:"DisallowedCidr" locationNameList:"item" type:"list"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM pool from which you would like to allocate a CIDR. + // + // IpamPoolId is a required field + IpamPoolId *string `type:"string" required:"true"` + + // The netmask length of the CIDR you would like to allocate from the IPAM pool. + // Note the following: + // + // * If there is no DefaultNetmaskLength allocation rule set on the pool, + // you must specify either the NetmaskLength or the CIDR. + // + // * If the DefaultNetmaskLength allocation rule is set on the pool, you + // can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength + // allocation rule will be ignored. + // + // Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask + // lengths for IPv6 addresses are 0 - 128. + NetmaskLength *int64 `type:"integer"` + + // A preview of the next available CIDR in a pool. + PreviewNextCidr *bool `type:"boolean"` +} + +// 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 AllocateIpamPoolCidrInput) 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 AllocateIpamPoolCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AllocateIpamPoolCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AllocateIpamPoolCidrInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *AllocateIpamPoolCidrInput) SetCidr(v string) *AllocateIpamPoolCidrInput { + s.Cidr = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *AllocateIpamPoolCidrInput) SetClientToken(v string) *AllocateIpamPoolCidrInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AllocateIpamPoolCidrInput) SetDescription(v string) *AllocateIpamPoolCidrInput { + s.Description = &v + return s +} + +// SetDisallowedCidrs sets the DisallowedCidrs field's value. +func (s *AllocateIpamPoolCidrInput) SetDisallowedCidrs(v []*string) *AllocateIpamPoolCidrInput { + s.DisallowedCidrs = v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *AllocateIpamPoolCidrInput) SetDryRun(v bool) *AllocateIpamPoolCidrInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *AllocateIpamPoolCidrInput) SetIpamPoolId(v string) *AllocateIpamPoolCidrInput { + s.IpamPoolId = &v + return s +} + +// SetNetmaskLength sets the NetmaskLength field's value. +func (s *AllocateIpamPoolCidrInput) SetNetmaskLength(v int64) *AllocateIpamPoolCidrInput { + s.NetmaskLength = &v + return s +} + +// SetPreviewNextCidr sets the PreviewNextCidr field's value. +func (s *AllocateIpamPoolCidrInput) SetPreviewNextCidr(v bool) *AllocateIpamPoolCidrInput { + s.PreviewNextCidr = &v + return s +} + +type AllocateIpamPoolCidrOutput struct { + _ struct{} `type:"structure"` + + // Information about the allocation created. + IpamPoolAllocation *IpamPoolAllocation `locationName:"ipamPoolAllocation" 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 AllocateIpamPoolCidrOutput) 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 AllocateIpamPoolCidrOutput) GoString() string { + return s.String() +} + +// SetIpamPoolAllocation sets the IpamPoolAllocation field's value. +func (s *AllocateIpamPoolCidrOutput) SetIpamPoolAllocation(v *IpamPoolAllocation) *AllocateIpamPoolCidrOutput { + s.IpamPoolAllocation = v + return s +} + // Describes a principal. type AllowedPrincipal struct { _ struct{} `type:"structure"` @@ -46525,6 +50164,9 @@ type AnalysisComponent struct { // The ID of the component. Id *string `locationName:"id" type:"string"` + + // The name of the analysis component. + Name *string `locationName:"name" type:"string"` } // String returns the string representation. @@ -46557,6 +50199,12 @@ func (s *AnalysisComponent) SetId(v string) *AnalysisComponent { return s } +// SetName sets the Name field's value. +func (s *AnalysisComponent) SetName(v string) *AnalysisComponent { + s.Name = &v + return s +} + // Describes a load balancer listener. type AnalysisLoadBalancerListener struct { _ struct{} `type:"structure"` @@ -48600,6 +52248,17 @@ type AssociateVpcCidrBlockInput struct { // An IPv4 CIDR block to associate with the VPC. CidrBlock *string `type:"string"` + // Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information + // about Amazon VPC IP Address Manager (IPAM), see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. + Ipv4IpamPoolId *string `type:"string"` + + // The netmask length of the IPv4 CIDR you would like to associate from an Amazon + // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see + // What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM + // User Guide. + Ipv4NetmaskLength *int64 `type:"integer"` + // An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool // in the request. // @@ -48614,6 +52273,17 @@ type AssociateVpcCidrBlockInput struct { // You can have one IPv6 CIDR block association per network border group. Ipv6CidrBlockNetworkBorderGroup *string `type:"string"` + // Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information + // about Amazon VPC IP Address Manager (IPAM), see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. + Ipv6IpamPoolId *string `type:"string"` + + // The netmask length of the IPv6 CIDR you would like to associate from an Amazon + // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see + // What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM + // User Guide. + Ipv6NetmaskLength *int64 `type:"integer"` + // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Ipv6Pool *string `type:"string"` @@ -48666,6 +52336,18 @@ func (s *AssociateVpcCidrBlockInput) SetCidrBlock(v string) *AssociateVpcCidrBlo return s } +// SetIpv4IpamPoolId sets the Ipv4IpamPoolId field's value. +func (s *AssociateVpcCidrBlockInput) SetIpv4IpamPoolId(v string) *AssociateVpcCidrBlockInput { + s.Ipv4IpamPoolId = &v + return s +} + +// SetIpv4NetmaskLength sets the Ipv4NetmaskLength field's value. +func (s *AssociateVpcCidrBlockInput) SetIpv4NetmaskLength(v int64) *AssociateVpcCidrBlockInput { + s.Ipv4NetmaskLength = &v + return s +} + // SetIpv6CidrBlock sets the Ipv6CidrBlock field's value. func (s *AssociateVpcCidrBlockInput) SetIpv6CidrBlock(v string) *AssociateVpcCidrBlockInput { s.Ipv6CidrBlock = &v @@ -48678,6 +52360,18 @@ func (s *AssociateVpcCidrBlockInput) SetIpv6CidrBlockNetworkBorderGroup(v string return s } +// SetIpv6IpamPoolId sets the Ipv6IpamPoolId field's value. +func (s *AssociateVpcCidrBlockInput) SetIpv6IpamPoolId(v string) *AssociateVpcCidrBlockInput { + s.Ipv6IpamPoolId = &v + return s +} + +// SetIpv6NetmaskLength sets the Ipv6NetmaskLength field's value. +func (s *AssociateVpcCidrBlockInput) SetIpv6NetmaskLength(v int64) *AssociateVpcCidrBlockInput { + s.Ipv6NetmaskLength = &v + return s +} + // SetIpv6Pool sets the Ipv6Pool field's value. func (s *AssociateVpcCidrBlockInput) SetIpv6Pool(v string) *AssociateVpcCidrBlockInput { s.Ipv6Pool = &v @@ -58264,6 +61958,483 @@ func (s *CreateInternetGatewayOutput) SetInternetGateway(v *InternetGateway) *Cr return s } +type CreateIpamInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // A description for the IPAM. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The operating Regions for the IPAM. Operating Regions are Amazon Web Services + // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers + // and monitors resources in the Amazon Web Services Regions you select as operating + // Regions. + // + // For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) + // in the Amazon VPC IPAM User Guide. + OperatingRegions []*AddIpamOperatingRegion `locationName:"OperatingRegion" type:"list"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 CreateIpamInput) 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 CreateIpamInput) GoString() string { + return s.String() +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateIpamInput) SetClientToken(v string) *CreateIpamInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateIpamInput) SetDescription(v string) *CreateIpamInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *CreateIpamInput) SetDryRun(v bool) *CreateIpamInput { + s.DryRun = &v + return s +} + +// SetOperatingRegions sets the OperatingRegions field's value. +func (s *CreateIpamInput) SetOperatingRegions(v []*AddIpamOperatingRegion) *CreateIpamInput { + s.OperatingRegions = v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateIpamInput) SetTagSpecifications(v []*TagSpecification) *CreateIpamInput { + s.TagSpecifications = v + return s +} + +type CreateIpamOutput struct { + _ struct{} `type:"structure"` + + // Information about the IPAM created. + Ipam *Ipam `locationName:"ipam" 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 CreateIpamOutput) 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 CreateIpamOutput) GoString() string { + return s.String() +} + +// SetIpam sets the Ipam field's value. +func (s *CreateIpamOutput) SetIpam(v *Ipam) *CreateIpamOutput { + s.Ipam = v + return s +} + +type CreateIpamPoolInput struct { + _ struct{} `type:"structure"` + + // The IP protocol assigned to this IPAM pool. You must choose either IPv4 or + // IPv6 protocol for a pool. + AddressFamily *string `type:"string" enum:"AddressFamily"` + + // The default netmask length for allocations added to this pool. If, for example, + // the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations + // will default to 10.0.0.0/16. + AllocationDefaultNetmaskLength *int64 `type:"integer"` + + // The maximum netmask length possible for CIDR allocations in this IPAM pool + // to be compliant. The maximum netmask length must be greater than the minimum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. + AllocationMaxNetmaskLength *int64 `type:"integer"` + + // The minimum netmask length required for CIDR allocations in this IPAM pool + // to be compliant. The minimum netmask length must be less than the maximum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. + AllocationMinNetmaskLength *int64 `type:"integer"` + + // Tags that are required for resources that use CIDRs from this IPAM pool. + // Resources that do not have these tags will not be allowed to allocate space + // from the pool. If the resources have their tags changed after they have allocated + // space or if the allocation tagging requirements are changed on the pool, + // the resource may be marked as noncompliant. + AllocationResourceTags []*RequestIpamResourceTag `locationName:"AllocationResourceTag" locationNameList:"item" type:"list"` + + // If selected, IPAM will continuously look for resources within the CIDR range + // of this pool and automatically import them as allocations into your IPAM. + // The CIDRs that will be allocated for these resources must not already be + // allocated to other resources in order for the import to succeed. IPAM will + // import a CIDR regardless of its compliance with the pool's allocation rules, + // so a resource might be imported and subsequently marked as noncompliant. + // If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest + // CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will + // randomly import one of them only. + // + // A locale must be set on the pool for this feature to work. + AutoImport *bool `type:"boolean"` + + // Limits which service in Amazon Web Services that the pool can be used in. + // "ec2", for example, allows users to use space for Elastic IP addresses and + // VPCs. + AwsService *string `type:"string" enum:"IpamPoolAwsService"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // A description for the IPAM pool. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the scope in which you would like to create the IPAM pool. + // + // IpamScopeId is a required field + IpamScopeId *string `type:"string" required:"true"` + + // In IPAM, the locale is the Amazon Web Services Region where you want to make + // an IPAM pool available for allocations. Only resources in the same Region + // as the locale of the pool can get IP address allocations from the pool. You + // can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares + // a locale with the VPC’s Region. Note that once you choose a Locale for + // a pool, you cannot modify it. If you do not choose a locale, resources in + // Regions others than the IPAM's home region cannot use CIDRs from this pool. + // + // Possible values: Any Amazon Web Services Region, such as us-east-1. + Locale *string `type:"string"` + + // Determines if the pool is publicly advertisable. This option is not available + // for pools with AddressFamily set to ipv4. + PubliclyAdvertisable *bool `type:"boolean"` + + // The ID of the source IPAM pool. Use this option to create a pool within an + // existing pool. Note that the CIDR you provision for the pool within the source + // pool must be available in the source pool's CIDR range. + SourceIpamPoolId *string `type:"string"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 CreateIpamPoolInput) 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 CreateIpamPoolInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateIpamPoolInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateIpamPoolInput"} + if s.IpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAddressFamily sets the AddressFamily field's value. +func (s *CreateIpamPoolInput) SetAddressFamily(v string) *CreateIpamPoolInput { + s.AddressFamily = &v + return s +} + +// SetAllocationDefaultNetmaskLength sets the AllocationDefaultNetmaskLength field's value. +func (s *CreateIpamPoolInput) SetAllocationDefaultNetmaskLength(v int64) *CreateIpamPoolInput { + s.AllocationDefaultNetmaskLength = &v + return s +} + +// SetAllocationMaxNetmaskLength sets the AllocationMaxNetmaskLength field's value. +func (s *CreateIpamPoolInput) SetAllocationMaxNetmaskLength(v int64) *CreateIpamPoolInput { + s.AllocationMaxNetmaskLength = &v + return s +} + +// SetAllocationMinNetmaskLength sets the AllocationMinNetmaskLength field's value. +func (s *CreateIpamPoolInput) SetAllocationMinNetmaskLength(v int64) *CreateIpamPoolInput { + s.AllocationMinNetmaskLength = &v + return s +} + +// SetAllocationResourceTags sets the AllocationResourceTags field's value. +func (s *CreateIpamPoolInput) SetAllocationResourceTags(v []*RequestIpamResourceTag) *CreateIpamPoolInput { + s.AllocationResourceTags = v + return s +} + +// SetAutoImport sets the AutoImport field's value. +func (s *CreateIpamPoolInput) SetAutoImport(v bool) *CreateIpamPoolInput { + s.AutoImport = &v + return s +} + +// SetAwsService sets the AwsService field's value. +func (s *CreateIpamPoolInput) SetAwsService(v string) *CreateIpamPoolInput { + s.AwsService = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateIpamPoolInput) SetClientToken(v string) *CreateIpamPoolInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateIpamPoolInput) SetDescription(v string) *CreateIpamPoolInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *CreateIpamPoolInput) SetDryRun(v bool) *CreateIpamPoolInput { + s.DryRun = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *CreateIpamPoolInput) SetIpamScopeId(v string) *CreateIpamPoolInput { + s.IpamScopeId = &v + return s +} + +// SetLocale sets the Locale field's value. +func (s *CreateIpamPoolInput) SetLocale(v string) *CreateIpamPoolInput { + s.Locale = &v + return s +} + +// SetPubliclyAdvertisable sets the PubliclyAdvertisable field's value. +func (s *CreateIpamPoolInput) SetPubliclyAdvertisable(v bool) *CreateIpamPoolInput { + s.PubliclyAdvertisable = &v + return s +} + +// SetSourceIpamPoolId sets the SourceIpamPoolId field's value. +func (s *CreateIpamPoolInput) SetSourceIpamPoolId(v string) *CreateIpamPoolInput { + s.SourceIpamPoolId = &v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateIpamPoolInput) SetTagSpecifications(v []*TagSpecification) *CreateIpamPoolInput { + s.TagSpecifications = v + return s +} + +type CreateIpamPoolOutput struct { + _ struct{} `type:"structure"` + + // Information about the IPAM pool created. + IpamPool *IpamPool `locationName:"ipamPool" 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 CreateIpamPoolOutput) 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 CreateIpamPoolOutput) GoString() string { + return s.String() +} + +// SetIpamPool sets the IpamPool field's value. +func (s *CreateIpamPoolOutput) SetIpamPool(v *IpamPool) *CreateIpamPoolOutput { + s.IpamPool = v + return s +} + +type CreateIpamScopeInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // A description for the scope you're creating. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM for which you're creating this scope. + // + // IpamId is a required field + IpamId *string `type:"string" required:"true"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 CreateIpamScopeInput) 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 CreateIpamScopeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateIpamScopeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateIpamScopeInput"} + if s.IpamId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateIpamScopeInput) SetClientToken(v string) *CreateIpamScopeInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateIpamScopeInput) SetDescription(v string) *CreateIpamScopeInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *CreateIpamScopeInput) SetDryRun(v bool) *CreateIpamScopeInput { + s.DryRun = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *CreateIpamScopeInput) SetIpamId(v string) *CreateIpamScopeInput { + s.IpamId = &v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateIpamScopeInput) SetTagSpecifications(v []*TagSpecification) *CreateIpamScopeInput { + s.TagSpecifications = v + return s +} + +type CreateIpamScopeOutput struct { + _ struct{} `type:"structure"` + + // Information about the created scope. + IpamScope *IpamScope `locationName:"ipamScope" 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 CreateIpamScopeOutput) 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 CreateIpamScopeOutput) GoString() string { + return s.String() +} + +// SetIpamScope sets the IpamScope field's value. +func (s *CreateIpamScopeOutput) SetIpamScope(v *IpamScope) *CreateIpamScopeOutput { + s.IpamScope = v + return s +} + type CreateKeyPairInput struct { _ struct{} `type:"structure"` @@ -59549,6 +63720,117 @@ func (s *CreateNetworkAclOutput) SetNetworkAcl(v *NetworkAcl) *CreateNetworkAclO return s } +type CreateNetworkInsightsAccessScopeInput struct { + _ struct{} `type:"structure"` + + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The paths to exclude. + ExcludePaths []*AccessScopePathRequest `locationName:"ExcludePath" locationNameList:"item" type:"list"` + + // The paths to match. + MatchPaths []*AccessScopePathRequest `locationName:"MatchPath" locationNameList:"item" type:"list"` + + // The tags to apply. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 CreateNetworkInsightsAccessScopeInput) 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 CreateNetworkInsightsAccessScopeInput) GoString() string { + return s.String() +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateNetworkInsightsAccessScopeInput) SetClientToken(v string) *CreateNetworkInsightsAccessScopeInput { + s.ClientToken = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *CreateNetworkInsightsAccessScopeInput) SetDryRun(v bool) *CreateNetworkInsightsAccessScopeInput { + s.DryRun = &v + return s +} + +// SetExcludePaths sets the ExcludePaths field's value. +func (s *CreateNetworkInsightsAccessScopeInput) SetExcludePaths(v []*AccessScopePathRequest) *CreateNetworkInsightsAccessScopeInput { + s.ExcludePaths = v + return s +} + +// SetMatchPaths sets the MatchPaths field's value. +func (s *CreateNetworkInsightsAccessScopeInput) SetMatchPaths(v []*AccessScopePathRequest) *CreateNetworkInsightsAccessScopeInput { + s.MatchPaths = v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreateNetworkInsightsAccessScopeInput) SetTagSpecifications(v []*TagSpecification) *CreateNetworkInsightsAccessScopeInput { + s.TagSpecifications = v + return s +} + +type CreateNetworkInsightsAccessScopeOutput struct { + _ struct{} `type:"structure"` + + // The Network Access Scope. + NetworkInsightsAccessScope *NetworkInsightsAccessScope `locationName:"networkInsightsAccessScope" type:"structure"` + + // The Network Access Scope content. + NetworkInsightsAccessScopeContent *NetworkInsightsAccessScopeContent `locationName:"networkInsightsAccessScopeContent" 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 CreateNetworkInsightsAccessScopeOutput) 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 CreateNetworkInsightsAccessScopeOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScope sets the NetworkInsightsAccessScope field's value. +func (s *CreateNetworkInsightsAccessScopeOutput) SetNetworkInsightsAccessScope(v *NetworkInsightsAccessScope) *CreateNetworkInsightsAccessScopeOutput { + s.NetworkInsightsAccessScope = v + return s +} + +// SetNetworkInsightsAccessScopeContent sets the NetworkInsightsAccessScopeContent field's value. +func (s *CreateNetworkInsightsAccessScopeOutput) SetNetworkInsightsAccessScopeContent(v *NetworkInsightsAccessScopeContent) *CreateNetworkInsightsAccessScopeOutput { + s.NetworkInsightsAccessScopeContent = v + return s +} + type CreateNetworkInsightsPathInput struct { _ struct{} `type:"structure"` @@ -60200,6 +64482,83 @@ func (s *CreatePlacementGroupOutput) SetPlacementGroup(v *PlacementGroup) *Creat return s } +type CreatePublicIpv4PoolInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 CreatePublicIpv4PoolInput) 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 CreatePublicIpv4PoolInput) GoString() string { + return s.String() +} + +// SetDryRun sets the DryRun field's value. +func (s *CreatePublicIpv4PoolInput) SetDryRun(v bool) *CreatePublicIpv4PoolInput { + s.DryRun = &v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *CreatePublicIpv4PoolInput) SetTagSpecifications(v []*TagSpecification) *CreatePublicIpv4PoolInput { + s.TagSpecifications = v + return s +} + +type CreatePublicIpv4PoolOutput struct { + _ struct{} `type:"structure"` + + // The ID of the public IPv4 pool. + PoolId *string `locationName:"poolId" 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 CreatePublicIpv4PoolOutput) 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 CreatePublicIpv4PoolOutput) GoString() string { + return s.String() +} + +// SetPoolId sets the PoolId field's value. +func (s *CreatePublicIpv4PoolOutput) SetPoolId(v string) *CreatePublicIpv4PoolOutput { + s.PoolId = &v + return s +} + type CreateReplaceRootVolumeTaskInput struct { _ struct{} `type:"structure"` @@ -64620,9 +68979,7 @@ type CreateVpcInput struct { // The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. // We modify the specified CIDR block to its canonical form; for example, if // you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. - // - // CidrBlock is a required field - CidrBlock *string `type:"string" required:"true"` + CidrBlock *string `type:"string"` // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have @@ -64642,6 +68999,17 @@ type CreateVpcInput struct { // Default: default InstanceTenancy *string `locationName:"instanceTenancy" type:"string" enum:"Tenancy"` + // The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. + // For more information, see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. + Ipv4IpamPoolId *string `type:"string"` + + // The netmask length of the IPv4 CIDR you want to allocate to this VPC from + // an Amazon VPC IP Address Manager (IPAM) pool. For more information about + // IPAM, see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon + // VPC IPAM User Guide. + Ipv4NetmaskLength *int64 `type:"integer"` + // The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool // in the request. // @@ -64654,6 +69022,21 @@ type CreateVpcInput struct { // You must set AmazonProvidedIpv6CidrBlock to true to use this parameter. Ipv6CidrBlockNetworkBorderGroup *string `type:"string"` + // The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 + // CIDR. IPAM is a VPC feature that you can use to automate your IP address + // management workflows including assigning, tracking, troubleshooting, and + // auditing IP addresses across Amazon Web Services Regions and accounts throughout + // your Amazon Web Services Organization. For more information, see What is + // IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM User + // Guide. + Ipv6IpamPoolId *string `type:"string"` + + // The netmask length of the IPv6 CIDR you want to allocate to this VPC from + // an Amazon VPC IP Address Manager (IPAM) pool. For more information about + // IPAM, see What is IPAM? (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon + // VPC IPAM User Guide. + Ipv6NetmaskLength *int64 `type:"integer"` + // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Ipv6Pool *string `type:"string"` @@ -64679,19 +69062,6 @@ func (s CreateVpcInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateVpcInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateVpcInput"} - if s.CidrBlock == nil { - invalidParams.Add(request.NewErrParamRequired("CidrBlock")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - // SetAmazonProvidedIpv6CidrBlock sets the AmazonProvidedIpv6CidrBlock field's value. func (s *CreateVpcInput) SetAmazonProvidedIpv6CidrBlock(v bool) *CreateVpcInput { s.AmazonProvidedIpv6CidrBlock = &v @@ -64716,6 +69086,18 @@ func (s *CreateVpcInput) SetInstanceTenancy(v string) *CreateVpcInput { return s } +// SetIpv4IpamPoolId sets the Ipv4IpamPoolId field's value. +func (s *CreateVpcInput) SetIpv4IpamPoolId(v string) *CreateVpcInput { + s.Ipv4IpamPoolId = &v + return s +} + +// SetIpv4NetmaskLength sets the Ipv4NetmaskLength field's value. +func (s *CreateVpcInput) SetIpv4NetmaskLength(v int64) *CreateVpcInput { + s.Ipv4NetmaskLength = &v + return s +} + // SetIpv6CidrBlock sets the Ipv6CidrBlock field's value. func (s *CreateVpcInput) SetIpv6CidrBlock(v string) *CreateVpcInput { s.Ipv6CidrBlock = &v @@ -64728,6 +69110,18 @@ func (s *CreateVpcInput) SetIpv6CidrBlockNetworkBorderGroup(v string) *CreateVpc return s } +// SetIpv6IpamPoolId sets the Ipv6IpamPoolId field's value. +func (s *CreateVpcInput) SetIpv6IpamPoolId(v string) *CreateVpcInput { + s.Ipv6IpamPoolId = &v + return s +} + +// SetIpv6NetmaskLength sets the Ipv6NetmaskLength field's value. +func (s *CreateVpcInput) SetIpv6NetmaskLength(v int64) *CreateVpcInput { + s.Ipv6NetmaskLength = &v + return s +} + // SetIpv6Pool sets the Ipv6Pool field's value. func (s *CreateVpcInput) SetIpv6Pool(v string) *CreateVpcInput { s.Ipv6Pool = &v @@ -66563,6 +70957,273 @@ func (s DeleteInternetGatewayOutput) GoString() string { return s.String() } +type DeleteIpamInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM to delete. + // + // IpamId is a required field + IpamId *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 DeleteIpamInput) 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 DeleteIpamInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteIpamInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIpamInput"} + if s.IpamId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteIpamInput) SetDryRun(v bool) *DeleteIpamInput { + s.DryRun = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *DeleteIpamInput) SetIpamId(v string) *DeleteIpamInput { + s.IpamId = &v + return s +} + +type DeleteIpamOutput struct { + _ struct{} `type:"structure"` + + // Information about the results of the deletion. + Ipam *Ipam `locationName:"ipam" 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 DeleteIpamOutput) 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 DeleteIpamOutput) GoString() string { + return s.String() +} + +// SetIpam sets the Ipam field's value. +func (s *DeleteIpamOutput) SetIpam(v *Ipam) *DeleteIpamOutput { + s.Ipam = v + return s +} + +type DeleteIpamPoolInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the pool to delete. + // + // IpamPoolId is a required field + IpamPoolId *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 DeleteIpamPoolInput) 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 DeleteIpamPoolInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteIpamPoolInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIpamPoolInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteIpamPoolInput) SetDryRun(v bool) *DeleteIpamPoolInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *DeleteIpamPoolInput) SetIpamPoolId(v string) *DeleteIpamPoolInput { + s.IpamPoolId = &v + return s +} + +type DeleteIpamPoolOutput struct { + _ struct{} `type:"structure"` + + // Information about the results of the deletion. + IpamPool *IpamPool `locationName:"ipamPool" 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 DeleteIpamPoolOutput) 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 DeleteIpamPoolOutput) GoString() string { + return s.String() +} + +// SetIpamPool sets the IpamPool field's value. +func (s *DeleteIpamPoolOutput) SetIpamPool(v *IpamPool) *DeleteIpamPoolOutput { + s.IpamPool = v + return s +} + +type DeleteIpamScopeInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the scope to delete. + // + // IpamScopeId is a required field + IpamScopeId *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 DeleteIpamScopeInput) 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 DeleteIpamScopeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteIpamScopeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIpamScopeInput"} + if s.IpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteIpamScopeInput) SetDryRun(v bool) *DeleteIpamScopeInput { + s.DryRun = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *DeleteIpamScopeInput) SetIpamScopeId(v string) *DeleteIpamScopeInput { + s.IpamScopeId = &v + return s +} + +type DeleteIpamScopeOutput struct { + _ struct{} `type:"structure"` + + // Information about the results of the deletion. + IpamScope *IpamScope `locationName:"ipamScope" 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 DeleteIpamScopeOutput) 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 DeleteIpamScopeOutput) GoString() string { + return s.String() +} + +// SetIpamScope sets the IpamScope field's value. +func (s *DeleteIpamScopeOutput) SetIpamScope(v *IpamScope) *DeleteIpamScopeOutput { + s.IpamScope = v + return s +} + type DeleteKeyPairInput struct { _ struct{} `type:"structure"` @@ -67523,6 +72184,184 @@ func (s DeleteNetworkAclOutput) GoString() string { return s.String() } +type DeleteNetworkInsightsAccessScopeAnalysisInput struct { + _ struct{} `type:"structure"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the Network Access Scope analysis. + // + // NetworkInsightsAccessScopeAnalysisId is a required field + NetworkInsightsAccessScopeAnalysisId *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 DeleteNetworkInsightsAccessScopeAnalysisInput) 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 DeleteNetworkInsightsAccessScopeAnalysisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteNetworkInsightsAccessScopeAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteNetworkInsightsAccessScopeAnalysisInput"} + if s.NetworkInsightsAccessScopeAnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkInsightsAccessScopeAnalysisId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteNetworkInsightsAccessScopeAnalysisInput) SetDryRun(v bool) *DeleteNetworkInsightsAccessScopeAnalysisInput { + s.DryRun = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *DeleteNetworkInsightsAccessScopeAnalysisInput) SetNetworkInsightsAccessScopeAnalysisId(v string) *DeleteNetworkInsightsAccessScopeAnalysisInput { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +type DeleteNetworkInsightsAccessScopeAnalysisOutput struct { + _ struct{} `type:"structure"` + + // The ID of the Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysisId *string `locationName:"networkInsightsAccessScopeAnalysisId" 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 DeleteNetworkInsightsAccessScopeAnalysisOutput) 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 DeleteNetworkInsightsAccessScopeAnalysisOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *DeleteNetworkInsightsAccessScopeAnalysisOutput) SetNetworkInsightsAccessScopeAnalysisId(v string) *DeleteNetworkInsightsAccessScopeAnalysisOutput { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +type DeleteNetworkInsightsAccessScopeInput struct { + _ struct{} `type:"structure"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the Network Access Scope. + // + // NetworkInsightsAccessScopeId is a required field + NetworkInsightsAccessScopeId *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 DeleteNetworkInsightsAccessScopeInput) 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 DeleteNetworkInsightsAccessScopeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteNetworkInsightsAccessScopeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteNetworkInsightsAccessScopeInput"} + if s.NetworkInsightsAccessScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkInsightsAccessScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeleteNetworkInsightsAccessScopeInput) SetDryRun(v bool) *DeleteNetworkInsightsAccessScopeInput { + s.DryRun = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *DeleteNetworkInsightsAccessScopeInput) SetNetworkInsightsAccessScopeId(v string) *DeleteNetworkInsightsAccessScopeInput { + s.NetworkInsightsAccessScopeId = &v + return s +} + +type DeleteNetworkInsightsAccessScopeOutput struct { + _ struct{} `type:"structure"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `locationName:"networkInsightsAccessScopeId" 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 DeleteNetworkInsightsAccessScopeOutput) 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 DeleteNetworkInsightsAccessScopeOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *DeleteNetworkInsightsAccessScopeOutput) SetNetworkInsightsAccessScopeId(v string) *DeleteNetworkInsightsAccessScopeOutput { + s.NetworkInsightsAccessScopeId = &v + return s +} + type DeleteNetworkInsightsAnalysisInput struct { _ struct{} `type:"structure"` @@ -67963,6 +72802,95 @@ func (s DeletePlacementGroupOutput) GoString() string { return s.String() } +type DeletePublicIpv4PoolInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the public IPv4 pool you want to delete. + // + // PoolId is a required field + PoolId *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 DeletePublicIpv4PoolInput) 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 DeletePublicIpv4PoolInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePublicIpv4PoolInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePublicIpv4PoolInput"} + if s.PoolId == nil { + invalidParams.Add(request.NewErrParamRequired("PoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DeletePublicIpv4PoolInput) SetDryRun(v bool) *DeletePublicIpv4PoolInput { + s.DryRun = &v + return s +} + +// SetPoolId sets the PoolId field's value. +func (s *DeletePublicIpv4PoolInput) SetPoolId(v string) *DeletePublicIpv4PoolInput { + s.PoolId = &v + return s +} + +type DeletePublicIpv4PoolOutput struct { + _ struct{} `type:"structure"` + + // Information about the result of deleting the public IPv4 pool. + ReturnValue *bool `locationName:"returnValue" type:"boolean"` +} + +// 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 DeletePublicIpv4PoolOutput) 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 DeletePublicIpv4PoolOutput) GoString() string { + return s.String() +} + +// SetReturnValue sets the ReturnValue field's value. +func (s *DeletePublicIpv4PoolOutput) SetReturnValue(v bool) *DeletePublicIpv4PoolOutput { + s.ReturnValue = &v + return s +} + // Describes the error for a Reserved Instance whose queued purchase could not // be deleted. type DeleteQueuedReservedInstancesError struct { @@ -70816,6 +75744,216 @@ func (s *DeprovisionByoipCidrOutput) SetByoipCidr(v *ByoipCidr) *DeprovisionByoi return s } +type DeprovisionIpamPoolCidrInput struct { + _ struct{} `type:"structure"` + + // The CIDR which you want to deprovision from the pool. + Cidr *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the pool that has the CIDR you want to deprovision. + // + // IpamPoolId is a required field + IpamPoolId *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 DeprovisionIpamPoolCidrInput) 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 DeprovisionIpamPoolCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeprovisionIpamPoolCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeprovisionIpamPoolCidrInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *DeprovisionIpamPoolCidrInput) SetCidr(v string) *DeprovisionIpamPoolCidrInput { + s.Cidr = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *DeprovisionIpamPoolCidrInput) SetDryRun(v bool) *DeprovisionIpamPoolCidrInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *DeprovisionIpamPoolCidrInput) SetIpamPoolId(v string) *DeprovisionIpamPoolCidrInput { + s.IpamPoolId = &v + return s +} + +type DeprovisionIpamPoolCidrOutput struct { + _ struct{} `type:"structure"` + + // The deprovisioned pool CIDR. + IpamPoolCidr *IpamPoolCidr `locationName:"ipamPoolCidr" 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 DeprovisionIpamPoolCidrOutput) 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 DeprovisionIpamPoolCidrOutput) GoString() string { + return s.String() +} + +// SetIpamPoolCidr sets the IpamPoolCidr field's value. +func (s *DeprovisionIpamPoolCidrOutput) SetIpamPoolCidr(v *IpamPoolCidr) *DeprovisionIpamPoolCidrOutput { + s.IpamPoolCidr = v + return s +} + +type DeprovisionPublicIpv4PoolCidrInput struct { + _ struct{} `type:"structure"` + + // The CIDR you want to deprovision from the pool. + // + // Cidr is a required field + Cidr *string `type:"string" required:"true"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the pool that you want to deprovision the CIDR from. + // + // PoolId is a required field + PoolId *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 DeprovisionPublicIpv4PoolCidrInput) 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 DeprovisionPublicIpv4PoolCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeprovisionPublicIpv4PoolCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeprovisionPublicIpv4PoolCidrInput"} + if s.Cidr == nil { + invalidParams.Add(request.NewErrParamRequired("Cidr")) + } + if s.PoolId == nil { + invalidParams.Add(request.NewErrParamRequired("PoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *DeprovisionPublicIpv4PoolCidrInput) SetCidr(v string) *DeprovisionPublicIpv4PoolCidrInput { + s.Cidr = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *DeprovisionPublicIpv4PoolCidrInput) SetDryRun(v bool) *DeprovisionPublicIpv4PoolCidrInput { + s.DryRun = &v + return s +} + +// SetPoolId sets the PoolId field's value. +func (s *DeprovisionPublicIpv4PoolCidrInput) SetPoolId(v string) *DeprovisionPublicIpv4PoolCidrInput { + s.PoolId = &v + return s +} + +type DeprovisionPublicIpv4PoolCidrOutput struct { + _ struct{} `type:"structure"` + + // The deprovisioned CIDRs. + DeprovisionedAddresses []*string `locationName:"deprovisionedAddressSet" locationNameList:"item" type:"list"` + + // The ID of the pool that you deprovisioned the CIDR from. + PoolId *string `locationName:"poolId" 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 DeprovisionPublicIpv4PoolCidrOutput) 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 DeprovisionPublicIpv4PoolCidrOutput) GoString() string { + return s.String() +} + +// SetDeprovisionedAddresses sets the DeprovisionedAddresses field's value. +func (s *DeprovisionPublicIpv4PoolCidrOutput) SetDeprovisionedAddresses(v []*string) *DeprovisionPublicIpv4PoolCidrOutput { + s.DeprovisionedAddresses = v + return s +} + +// SetPoolId sets the PoolId field's value. +func (s *DeprovisionPublicIpv4PoolCidrOutput) SetPoolId(v string) *DeprovisionPublicIpv4PoolCidrOutput { + s.PoolId = &v + return s +} + // Contains the parameters for DeregisterImage. type DeregisterImageInput struct { _ struct{} `type:"structure"` @@ -78396,6 +83534,381 @@ func (s *DescribeInternetGatewaysOutput) SetNextToken(v string) *DescribeInterne return s } +type DescribeIpamPoolsInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The IDs of the IPAM pools you would like information on. + IpamPoolIds []*string `locationName:"IpamPoolId" locationNameList:"item" type:"list"` + + // The maximum number of results to return in the request. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *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 DescribeIpamPoolsInput) 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 DescribeIpamPoolsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeIpamPoolsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeIpamPoolsInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeIpamPoolsInput) SetDryRun(v bool) *DescribeIpamPoolsInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeIpamPoolsInput) SetFilters(v []*Filter) *DescribeIpamPoolsInput { + s.Filters = v + return s +} + +// SetIpamPoolIds sets the IpamPoolIds field's value. +func (s *DescribeIpamPoolsInput) SetIpamPoolIds(v []*string) *DescribeIpamPoolsInput { + s.IpamPoolIds = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeIpamPoolsInput) SetMaxResults(v int64) *DescribeIpamPoolsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamPoolsInput) SetNextToken(v string) *DescribeIpamPoolsInput { + s.NextToken = &v + return s +} + +type DescribeIpamPoolsOutput struct { + _ struct{} `type:"structure"` + + // Information about the IPAM pools. + IpamPools []*IpamPool `locationName:"ipamPoolSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamPoolsOutput) 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 DescribeIpamPoolsOutput) GoString() string { + return s.String() +} + +// SetIpamPools sets the IpamPools field's value. +func (s *DescribeIpamPoolsOutput) SetIpamPools(v []*IpamPool) *DescribeIpamPoolsOutput { + s.IpamPools = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamPoolsOutput) SetNextToken(v string) *DescribeIpamPoolsOutput { + s.NextToken = &v + return s +} + +type DescribeIpamScopesInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The IDs of the scopes you want information on. + IpamScopeIds []*string `locationName:"IpamScopeId" locationNameList:"item" type:"list"` + + // The maximum number of results to return in the request. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *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 DescribeIpamScopesInput) 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 DescribeIpamScopesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeIpamScopesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeIpamScopesInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeIpamScopesInput) SetDryRun(v bool) *DescribeIpamScopesInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeIpamScopesInput) SetFilters(v []*Filter) *DescribeIpamScopesInput { + s.Filters = v + return s +} + +// SetIpamScopeIds sets the IpamScopeIds field's value. +func (s *DescribeIpamScopesInput) SetIpamScopeIds(v []*string) *DescribeIpamScopesInput { + s.IpamScopeIds = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeIpamScopesInput) SetMaxResults(v int64) *DescribeIpamScopesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamScopesInput) SetNextToken(v string) *DescribeIpamScopesInput { + s.NextToken = &v + return s +} + +type DescribeIpamScopesOutput struct { + _ struct{} `type:"structure"` + + // The scopes you want information on. + IpamScopes []*IpamScope `locationName:"ipamScopeSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamScopesOutput) 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 DescribeIpamScopesOutput) GoString() string { + return s.String() +} + +// SetIpamScopes sets the IpamScopes field's value. +func (s *DescribeIpamScopesOutput) SetIpamScopes(v []*IpamScope) *DescribeIpamScopesOutput { + s.IpamScopes = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamScopesOutput) SetNextToken(v string) *DescribeIpamScopesOutput { + s.NextToken = &v + return s +} + +type DescribeIpamsInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The IDs of the IPAMs you want information on. + IpamIds []*string `locationName:"IpamId" locationNameList:"item" type:"list"` + + // The maximum number of results to return in the request. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *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 DescribeIpamsInput) 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 DescribeIpamsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeIpamsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeIpamsInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeIpamsInput) SetDryRun(v bool) *DescribeIpamsInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeIpamsInput) SetFilters(v []*Filter) *DescribeIpamsInput { + s.Filters = v + return s +} + +// SetIpamIds sets the IpamIds field's value. +func (s *DescribeIpamsInput) SetIpamIds(v []*string) *DescribeIpamsInput { + s.IpamIds = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeIpamsInput) SetMaxResults(v int64) *DescribeIpamsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamsInput) SetNextToken(v string) *DescribeIpamsInput { + s.NextToken = &v + return s +} + +type DescribeIpamsOutput struct { + _ struct{} `type:"structure"` + + // Information about the IPAMs. + Ipams []*Ipam `locationName:"ipamSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIpamsOutput) 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 DescribeIpamsOutput) GoString() string { + return s.String() +} + +// SetIpams sets the Ipams field's value. +func (s *DescribeIpamsOutput) SetIpams(v []*Ipam) *DescribeIpamsOutput { + s.Ipams = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeIpamsOutput) SetNextToken(v string) *DescribeIpamsOutput { + s.NextToken = &v + return s +} + type DescribeIpv6PoolsInput struct { _ struct{} `type:"structure"` @@ -80370,6 +85883,285 @@ func (s *DescribeNetworkAclsOutput) SetNextToken(v string) *DescribeNetworkAclsO return s } +type DescribeNetworkInsightsAccessScopeAnalysesInput struct { + _ struct{} `type:"structure"` + + // Filters the results based on the start time. The analysis must have started + // on or after this time. + AnalysisStartTimeBegin *time.Time `type:"timestamp"` + + // Filters the results based on the start time. The analysis must have started + // on or before this time. + AnalysisStartTimeEnd *time.Time `type:"timestamp"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // There are no supported filters. + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `min:"1" type:"integer"` + + // The IDs of the Network Access Scope analyses. + NetworkInsightsAccessScopeAnalysisIds []*string `locationName:"NetworkInsightsAccessScopeAnalysisId" locationNameList:"item" type:"list"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `type:"string"` + + // The token for the next page of results. + NextToken *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 DescribeNetworkInsightsAccessScopeAnalysesInput) 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 DescribeNetworkInsightsAccessScopeAnalysesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeNetworkInsightsAccessScopeAnalysesInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisStartTimeBegin sets the AnalysisStartTimeBegin field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetAnalysisStartTimeBegin(v time.Time) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.AnalysisStartTimeBegin = &v + return s +} + +// SetAnalysisStartTimeEnd sets the AnalysisStartTimeEnd field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetAnalysisStartTimeEnd(v time.Time) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.AnalysisStartTimeEnd = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetDryRun(v bool) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetFilters(v []*Filter) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetMaxResults(v int64) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.MaxResults = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisIds sets the NetworkInsightsAccessScopeAnalysisIds field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetNetworkInsightsAccessScopeAnalysisIds(v []*string) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.NetworkInsightsAccessScopeAnalysisIds = v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetNetworkInsightsAccessScopeId(v string) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.NetworkInsightsAccessScopeId = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesInput) SetNextToken(v string) *DescribeNetworkInsightsAccessScopeAnalysesInput { + s.NextToken = &v + return s +} + +type DescribeNetworkInsightsAccessScopeAnalysesOutput struct { + _ struct{} `type:"structure"` + + // The Network Access Scope analyses. + NetworkInsightsAccessScopeAnalyses []*NetworkInsightsAccessScopeAnalysis `locationName:"networkInsightsAccessScopeAnalysisSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNetworkInsightsAccessScopeAnalysesOutput) 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 DescribeNetworkInsightsAccessScopeAnalysesOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopeAnalyses sets the NetworkInsightsAccessScopeAnalyses field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesOutput) SetNetworkInsightsAccessScopeAnalyses(v []*NetworkInsightsAccessScopeAnalysis) *DescribeNetworkInsightsAccessScopeAnalysesOutput { + s.NetworkInsightsAccessScopeAnalyses = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeNetworkInsightsAccessScopeAnalysesOutput) SetNextToken(v string) *DescribeNetworkInsightsAccessScopeAnalysesOutput { + s.NextToken = &v + return s +} + +type DescribeNetworkInsightsAccessScopesInput struct { + _ struct{} `type:"structure"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // There are no supported filters. + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `min:"1" type:"integer"` + + // The IDs of the Network Access Scopes. + NetworkInsightsAccessScopeIds []*string `locationName:"NetworkInsightsAccessScopeId" locationNameList:"item" type:"list"` + + // The token for the next page of results. + NextToken *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 DescribeNetworkInsightsAccessScopesInput) 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 DescribeNetworkInsightsAccessScopesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeNetworkInsightsAccessScopesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeNetworkInsightsAccessScopesInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *DescribeNetworkInsightsAccessScopesInput) SetDryRun(v bool) *DescribeNetworkInsightsAccessScopesInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *DescribeNetworkInsightsAccessScopesInput) SetFilters(v []*Filter) *DescribeNetworkInsightsAccessScopesInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeNetworkInsightsAccessScopesInput) SetMaxResults(v int64) *DescribeNetworkInsightsAccessScopesInput { + s.MaxResults = &v + return s +} + +// SetNetworkInsightsAccessScopeIds sets the NetworkInsightsAccessScopeIds field's value. +func (s *DescribeNetworkInsightsAccessScopesInput) SetNetworkInsightsAccessScopeIds(v []*string) *DescribeNetworkInsightsAccessScopesInput { + s.NetworkInsightsAccessScopeIds = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeNetworkInsightsAccessScopesInput) SetNextToken(v string) *DescribeNetworkInsightsAccessScopesInput { + s.NextToken = &v + return s +} + +type DescribeNetworkInsightsAccessScopesOutput struct { + _ struct{} `type:"structure"` + + // The Network Access Scopes. + NetworkInsightsAccessScopes []*NetworkInsightsAccessScope `locationName:"networkInsightsAccessScopeSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNetworkInsightsAccessScopesOutput) 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 DescribeNetworkInsightsAccessScopesOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopes sets the NetworkInsightsAccessScopes field's value. +func (s *DescribeNetworkInsightsAccessScopesOutput) SetNetworkInsightsAccessScopes(v []*NetworkInsightsAccessScope) *DescribeNetworkInsightsAccessScopesOutput { + s.NetworkInsightsAccessScopes = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeNetworkInsightsAccessScopesOutput) SetNextToken(v string) *DescribeNetworkInsightsAccessScopesOutput { + s.NextToken = &v + return s +} + type DescribeNetworkInsightsAnalysesInput struct { _ struct{} `type:"structure"` @@ -90524,6 +96316,95 @@ func (s *DisableImageDeprecationOutput) SetReturn(v bool) *DisableImageDeprecati return s } +type DisableIpamOrganizationAdminAccountInput struct { + _ struct{} `type:"structure"` + + // The Organizations member account ID that you want to disable as IPAM account. + // + // DelegatedAdminAccountId is a required field + DelegatedAdminAccountId *string `type:"string" required:"true"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` +} + +// 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 DisableIpamOrganizationAdminAccountInput) 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 DisableIpamOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisableIpamOrganizationAdminAccountInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisableIpamOrganizationAdminAccountInput"} + if s.DelegatedAdminAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("DelegatedAdminAccountId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDelegatedAdminAccountId sets the DelegatedAdminAccountId field's value. +func (s *DisableIpamOrganizationAdminAccountInput) SetDelegatedAdminAccountId(v string) *DisableIpamOrganizationAdminAccountInput { + s.DelegatedAdminAccountId = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *DisableIpamOrganizationAdminAccountInput) SetDryRun(v bool) *DisableIpamOrganizationAdminAccountInput { + s.DryRun = &v + return s +} + +type DisableIpamOrganizationAdminAccountOutput struct { + _ struct{} `type:"structure"` + + // The result of disabling the IPAM account. + Success *bool `locationName:"success" type:"boolean"` +} + +// 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 DisableIpamOrganizationAdminAccountOutput) 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 DisableIpamOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +// SetSuccess sets the Success field's value. +func (s *DisableIpamOrganizationAdminAccountOutput) SetSuccess(v bool) *DisableIpamOrganizationAdminAccountOutput { + s.Success = &v + return s +} + type DisableSerialConsoleAccessInput struct { _ struct{} `type:"structure"` @@ -93781,6 +99662,95 @@ func (s *EnableImageDeprecationOutput) SetReturn(v bool) *EnableImageDeprecation return s } +type EnableIpamOrganizationAdminAccountInput struct { + _ struct{} `type:"structure"` + + // The Organizations member account ID that you want to enable as the IPAM account. + // + // DelegatedAdminAccountId is a required field + DelegatedAdminAccountId *string `type:"string" required:"true"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` +} + +// 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 EnableIpamOrganizationAdminAccountInput) 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 EnableIpamOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EnableIpamOrganizationAdminAccountInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnableIpamOrganizationAdminAccountInput"} + if s.DelegatedAdminAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("DelegatedAdminAccountId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDelegatedAdminAccountId sets the DelegatedAdminAccountId field's value. +func (s *EnableIpamOrganizationAdminAccountInput) SetDelegatedAdminAccountId(v string) *EnableIpamOrganizationAdminAccountInput { + s.DelegatedAdminAccountId = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *EnableIpamOrganizationAdminAccountInput) SetDryRun(v bool) *EnableIpamOrganizationAdminAccountInput { + s.DryRun = &v + return s +} + +type EnableIpamOrganizationAdminAccountOutput struct { + _ struct{} `type:"structure"` + + // The result of enabling the IPAM account. + Success *bool `locationName:"success" type:"boolean"` +} + +// 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 EnableIpamOrganizationAdminAccountOutput) 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 EnableIpamOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +// SetSuccess sets the Success field's value. +func (s *EnableIpamOrganizationAdminAccountOutput) SetSuccess(v bool) *EnableIpamOrganizationAdminAccountOutput { + s.Success = &v + return s +} + type EnableSerialConsoleAccessInput struct { _ struct{} `type:"structure"` @@ -99254,6 +105224,618 @@ func (s *GetInstanceTypesFromInstanceRequirementsOutput) SetNextToken(v string) return s } +type GetIpamAddressHistoryInput struct { + _ struct{} `type:"structure"` + + // The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address + // range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. + // You will not get records for any subnets within the /16 CIDR. + // + // Cidr is a required field + Cidr *string `type:"string" required:"true"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The end of the time period for which you are looking for history. If you + // omit this option, it will default to the current time. + EndTime *time.Time `type:"timestamp"` + + // The ID of the IPAM scope that the CIDR is in. + // + // IpamScopeId is a required field + IpamScopeId *string `type:"string" required:"true"` + + // The maximum number of historical results you would like returned per page. + // Defaults to 100. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `type:"string"` + + // The start of the time period for which you are looking for history. If you + // omit this option, it will default to the value of EndTime. + StartTime *time.Time `type:"timestamp"` + + // The ID of the VPC you want your history records filtered by. + VpcId *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 GetIpamAddressHistoryInput) 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 GetIpamAddressHistoryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetIpamAddressHistoryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetIpamAddressHistoryInput"} + if s.Cidr == nil { + invalidParams.Add(request.NewErrParamRequired("Cidr")) + } + if s.IpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamScopeId")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *GetIpamAddressHistoryInput) SetCidr(v string) *GetIpamAddressHistoryInput { + s.Cidr = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *GetIpamAddressHistoryInput) SetDryRun(v bool) *GetIpamAddressHistoryInput { + s.DryRun = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *GetIpamAddressHistoryInput) SetEndTime(v time.Time) *GetIpamAddressHistoryInput { + s.EndTime = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *GetIpamAddressHistoryInput) SetIpamScopeId(v string) *GetIpamAddressHistoryInput { + s.IpamScopeId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetIpamAddressHistoryInput) SetMaxResults(v int64) *GetIpamAddressHistoryInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamAddressHistoryInput) SetNextToken(v string) *GetIpamAddressHistoryInput { + s.NextToken = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *GetIpamAddressHistoryInput) SetStartTime(v time.Time) *GetIpamAddressHistoryInput { + s.StartTime = &v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *GetIpamAddressHistoryInput) SetVpcId(v string) *GetIpamAddressHistoryInput { + s.VpcId = &v + return s +} + +type GetIpamAddressHistoryOutput struct { + _ struct{} `type:"structure"` + + // A historical record for a CIDR within an IPAM scope. If the CIDR is associated + // with an EC2 instance, you will see an object in the response for the instance + // and one for the network interface. + HistoryRecords []*IpamAddressHistoryRecord `locationName:"historyRecordSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetIpamAddressHistoryOutput) 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 GetIpamAddressHistoryOutput) GoString() string { + return s.String() +} + +// SetHistoryRecords sets the HistoryRecords field's value. +func (s *GetIpamAddressHistoryOutput) SetHistoryRecords(v []*IpamAddressHistoryRecord) *GetIpamAddressHistoryOutput { + s.HistoryRecords = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamAddressHistoryOutput) SetNextToken(v string) *GetIpamAddressHistoryOutput { + s.NextToken = &v + return s +} + +type GetIpamPoolAllocationsInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The ID of the allocation. + IpamPoolAllocationId *string `type:"string"` + + // The ID of the IPAM pool you want to see the allocations for. + // + // IpamPoolId is a required field + IpamPoolId *string `type:"string" required:"true"` + + // The maximum number of results you would like returned per page. + MaxResults *int64 `min:"1000" type:"integer"` + + // The token for the next page of results. + NextToken *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 GetIpamPoolAllocationsInput) 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 GetIpamPoolAllocationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetIpamPoolAllocationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetIpamPoolAllocationsInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + if s.MaxResults != nil && *s.MaxResults < 1000 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1000)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *GetIpamPoolAllocationsInput) SetDryRun(v bool) *GetIpamPoolAllocationsInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *GetIpamPoolAllocationsInput) SetFilters(v []*Filter) *GetIpamPoolAllocationsInput { + s.Filters = v + return s +} + +// SetIpamPoolAllocationId sets the IpamPoolAllocationId field's value. +func (s *GetIpamPoolAllocationsInput) SetIpamPoolAllocationId(v string) *GetIpamPoolAllocationsInput { + s.IpamPoolAllocationId = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *GetIpamPoolAllocationsInput) SetIpamPoolId(v string) *GetIpamPoolAllocationsInput { + s.IpamPoolId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetIpamPoolAllocationsInput) SetMaxResults(v int64) *GetIpamPoolAllocationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamPoolAllocationsInput) SetNextToken(v string) *GetIpamPoolAllocationsInput { + s.NextToken = &v + return s +} + +type GetIpamPoolAllocationsOutput struct { + _ struct{} `type:"structure"` + + // The IPAM pool allocations you want information on. + IpamPoolAllocations []*IpamPoolAllocation `locationName:"ipamPoolAllocationSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetIpamPoolAllocationsOutput) 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 GetIpamPoolAllocationsOutput) GoString() string { + return s.String() +} + +// SetIpamPoolAllocations sets the IpamPoolAllocations field's value. +func (s *GetIpamPoolAllocationsOutput) SetIpamPoolAllocations(v []*IpamPoolAllocation) *GetIpamPoolAllocationsOutput { + s.IpamPoolAllocations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamPoolAllocationsOutput) SetNextToken(v string) *GetIpamPoolAllocationsOutput { + s.NextToken = &v + return s +} + +type GetIpamPoolCidrsInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The ID of the IPAM pool you want the CIDR for. + // + // IpamPoolId is a required field + IpamPoolId *string `type:"string" required:"true"` + + // The maximum number of results to return in the request. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *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 GetIpamPoolCidrsInput) 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 GetIpamPoolCidrsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetIpamPoolCidrsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetIpamPoolCidrsInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *GetIpamPoolCidrsInput) SetDryRun(v bool) *GetIpamPoolCidrsInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *GetIpamPoolCidrsInput) SetFilters(v []*Filter) *GetIpamPoolCidrsInput { + s.Filters = v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *GetIpamPoolCidrsInput) SetIpamPoolId(v string) *GetIpamPoolCidrsInput { + s.IpamPoolId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetIpamPoolCidrsInput) SetMaxResults(v int64) *GetIpamPoolCidrsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamPoolCidrsInput) SetNextToken(v string) *GetIpamPoolCidrsInput { + s.NextToken = &v + return s +} + +type GetIpamPoolCidrsOutput struct { + _ struct{} `type:"structure"` + + // Information about the CIDRs provisioned to an IPAM pool. + IpamPoolCidrs []*IpamPoolCidr `locationName:"ipamPoolCidrSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetIpamPoolCidrsOutput) 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 GetIpamPoolCidrsOutput) GoString() string { + return s.String() +} + +// SetIpamPoolCidrs sets the IpamPoolCidrs field's value. +func (s *GetIpamPoolCidrsOutput) SetIpamPoolCidrs(v []*IpamPoolCidr) *GetIpamPoolCidrsOutput { + s.IpamPoolCidrs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamPoolCidrsOutput) SetNextToken(v string) *GetIpamPoolCidrsOutput { + s.NextToken = &v + return s +} + +type GetIpamResourceCidrsInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // One or more filters for the request. For more information about filtering, + // see Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` + + // The ID of the IPAM pool that the resource is in. + IpamPoolId *string `type:"string"` + + // The ID of the scope that the resource is in. + // + // IpamScopeId is a required field + IpamScopeId *string `type:"string" required:"true"` + + // The maximum number of results to return in the request. + MaxResults *int64 `min:"5" type:"integer"` + + // The token for the next page of results. + NextToken *string `type:"string"` + + // The ID of the resource. + ResourceId *string `type:"string"` + + // The ID of the Amazon Web Services account that owns the resource. + ResourceOwner *string `type:"string"` + + // A tag on an IPAM resource. + ResourceTag *RequestIpamResourceTag `type:"structure"` + + // The resource type. + ResourceType *string `type:"string" enum:"IpamResourceType"` +} + +// 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 GetIpamResourceCidrsInput) 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 GetIpamResourceCidrsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetIpamResourceCidrsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetIpamResourceCidrsInput"} + if s.IpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamScopeId")) + } + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *GetIpamResourceCidrsInput) SetDryRun(v bool) *GetIpamResourceCidrsInput { + s.DryRun = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *GetIpamResourceCidrsInput) SetFilters(v []*Filter) *GetIpamResourceCidrsInput { + s.Filters = v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *GetIpamResourceCidrsInput) SetIpamPoolId(v string) *GetIpamResourceCidrsInput { + s.IpamPoolId = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *GetIpamResourceCidrsInput) SetIpamScopeId(v string) *GetIpamResourceCidrsInput { + s.IpamScopeId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetIpamResourceCidrsInput) SetMaxResults(v int64) *GetIpamResourceCidrsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamResourceCidrsInput) SetNextToken(v string) *GetIpamResourceCidrsInput { + s.NextToken = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *GetIpamResourceCidrsInput) SetResourceId(v string) *GetIpamResourceCidrsInput { + s.ResourceId = &v + return s +} + +// SetResourceOwner sets the ResourceOwner field's value. +func (s *GetIpamResourceCidrsInput) SetResourceOwner(v string) *GetIpamResourceCidrsInput { + s.ResourceOwner = &v + return s +} + +// SetResourceTag sets the ResourceTag field's value. +func (s *GetIpamResourceCidrsInput) SetResourceTag(v *RequestIpamResourceTag) *GetIpamResourceCidrsInput { + s.ResourceTag = v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *GetIpamResourceCidrsInput) SetResourceType(v string) *GetIpamResourceCidrsInput { + s.ResourceType = &v + return s +} + +type GetIpamResourceCidrsOutput struct { + _ struct{} `type:"structure"` + + // The resource CIDRs. + IpamResourceCidrs []*IpamResourceCidr `locationName:"ipamResourceCidrSet" locationNameList:"item" type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetIpamResourceCidrsOutput) 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 GetIpamResourceCidrsOutput) GoString() string { + return s.String() +} + +// SetIpamResourceCidrs sets the IpamResourceCidrs field's value. +func (s *GetIpamResourceCidrsOutput) SetIpamResourceCidrs(v []*IpamResourceCidr) *GetIpamResourceCidrsOutput { + s.IpamResourceCidrs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetIpamResourceCidrsOutput) SetNextToken(v string) *GetIpamResourceCidrsOutput { + s.NextToken = &v + return s +} + type GetLaunchTemplateDataInput struct { _ struct{} `type:"structure"` @@ -99595,6 +106177,234 @@ func (s *GetManagedPrefixListEntriesOutput) SetNextToken(v string) *GetManagedPr return s } +type GetNetworkInsightsAccessScopeAnalysisFindingsInput struct { + _ struct{} `type:"structure"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `min:"1" type:"integer"` + + // The ID of the Network Access Scope analysis. + // + // NetworkInsightsAccessScopeAnalysisId is a required field + NetworkInsightsAccessScopeAnalysisId *string `type:"string" required:"true"` + + // The token for the next page of results. + NextToken *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 GetNetworkInsightsAccessScopeAnalysisFindingsInput) 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 GetNetworkInsightsAccessScopeAnalysisFindingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetNetworkInsightsAccessScopeAnalysisFindingsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NetworkInsightsAccessScopeAnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkInsightsAccessScopeAnalysisId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsInput) SetDryRun(v bool) *GetNetworkInsightsAccessScopeAnalysisFindingsInput { + s.DryRun = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsInput) SetMaxResults(v int64) *GetNetworkInsightsAccessScopeAnalysisFindingsInput { + s.MaxResults = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsInput) SetNetworkInsightsAccessScopeAnalysisId(v string) *GetNetworkInsightsAccessScopeAnalysisFindingsInput { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsInput) SetNextToken(v string) *GetNetworkInsightsAccessScopeAnalysisFindingsInput { + s.NextToken = &v + return s +} + +type GetNetworkInsightsAccessScopeAnalysisFindingsOutput struct { + _ struct{} `type:"structure"` + + // The findings associated with Network Access Scope Analysis. + AnalysisFindings []*AccessScopeAnalysisFinding `locationName:"analysisFindingSet" locationNameList:"item" type:"list"` + + // The status of Network Access Scope Analysis. + AnalysisStatus *string `locationName:"analysisStatus" type:"string" enum:"AnalysisStatus"` + + // The ID of the Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysisId *string `locationName:"networkInsightsAccessScopeAnalysisId" type:"string"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetNetworkInsightsAccessScopeAnalysisFindingsOutput) 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 GetNetworkInsightsAccessScopeAnalysisFindingsOutput) GoString() string { + return s.String() +} + +// SetAnalysisFindings sets the AnalysisFindings field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsOutput) SetAnalysisFindings(v []*AccessScopeAnalysisFinding) *GetNetworkInsightsAccessScopeAnalysisFindingsOutput { + s.AnalysisFindings = v + return s +} + +// SetAnalysisStatus sets the AnalysisStatus field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsOutput) SetAnalysisStatus(v string) *GetNetworkInsightsAccessScopeAnalysisFindingsOutput { + s.AnalysisStatus = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsOutput) SetNetworkInsightsAccessScopeAnalysisId(v string) *GetNetworkInsightsAccessScopeAnalysisFindingsOutput { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetNetworkInsightsAccessScopeAnalysisFindingsOutput) SetNextToken(v string) *GetNetworkInsightsAccessScopeAnalysisFindingsOutput { + s.NextToken = &v + return s +} + +type GetNetworkInsightsAccessScopeContentInput struct { + _ struct{} `type:"structure"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the Network Access Scope. + // + // NetworkInsightsAccessScopeId is a required field + NetworkInsightsAccessScopeId *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 GetNetworkInsightsAccessScopeContentInput) 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 GetNetworkInsightsAccessScopeContentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetNetworkInsightsAccessScopeContentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetNetworkInsightsAccessScopeContentInput"} + if s.NetworkInsightsAccessScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkInsightsAccessScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *GetNetworkInsightsAccessScopeContentInput) SetDryRun(v bool) *GetNetworkInsightsAccessScopeContentInput { + s.DryRun = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *GetNetworkInsightsAccessScopeContentInput) SetNetworkInsightsAccessScopeId(v string) *GetNetworkInsightsAccessScopeContentInput { + s.NetworkInsightsAccessScopeId = &v + return s +} + +type GetNetworkInsightsAccessScopeContentOutput struct { + _ struct{} `type:"structure"` + + // The Network Access Scope content. + NetworkInsightsAccessScopeContent *NetworkInsightsAccessScopeContent `locationName:"networkInsightsAccessScopeContent" 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 GetNetworkInsightsAccessScopeContentOutput) 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 GetNetworkInsightsAccessScopeContentOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopeContent sets the NetworkInsightsAccessScopeContent field's value. +func (s *GetNetworkInsightsAccessScopeContentOutput) SetNetworkInsightsAccessScopeContent(v *NetworkInsightsAccessScopeContent) *GetNetworkInsightsAccessScopeContentOutput { + s.NetworkInsightsAccessScopeContent = v + return s +} + type GetPasswordDataInput struct { _ struct{} `type:"structure"` @@ -109008,6 +115818,1151 @@ func (s *IpRange) SetDescription(v string) *IpRange { return s } +// IPAM is a VPC feature that you can use to automate your IP address management +// workflows including assigning, tracking, troubleshooting, and auditing IP +// addresses across Amazon Web Services Regions and accounts throughout your +// Amazon Web Services Organization. For more information, see What is IPAM? +// (/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM User Guide. +type Ipam struct { + _ struct{} `type:"structure"` + + // The description for the IPAM. + Description *string `locationName:"description" type:"string"` + + // The ARN of the IPAM. + IpamArn *string `locationName:"ipamArn" min:"1" type:"string"` + + // The ID of the IPAM. + IpamId *string `locationName:"ipamId" type:"string"` + + // The Amazon Web Services Region of the IPAM. + IpamRegion *string `locationName:"ipamRegion" type:"string"` + + // The operating Regions for an IPAM. Operating Regions are Amazon Web Services + // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers + // and monitors resources in the Amazon Web Services Regions you select as operating + // Regions. + // + // For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) + // in the Amazon VPC IPAM User Guide. + OperatingRegions []*IpamOperatingRegion `locationName:"operatingRegionSet" locationNameList:"item" type:"list"` + + // The Amazon Web Services account ID of the owner of the IPAM. + OwnerId *string `locationName:"ownerId" type:"string"` + + // The ID of the IPAM's default private scope. + PrivateDefaultScopeId *string `locationName:"privateDefaultScopeId" type:"string"` + + // The ID of the IPAM's default public scope. + PublicDefaultScopeId *string `locationName:"publicDefaultScopeId" type:"string"` + + // The number of scopes in the IPAM. The scope quota is 5. For more information + // on quotas, see Quotas in IPAM (/vpc/latest/ipam/quotas-ipam.html) in the + // Amazon VPC IPAM User Guide. + ScopeCount *int64 `locationName:"scopeCount" type:"integer"` + + // The state of the IPAM. + State *string `locationName:"state" type:"string" enum:"IpamState"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" 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 Ipam) 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 Ipam) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *Ipam) SetDescription(v string) *Ipam { + s.Description = &v + return s +} + +// SetIpamArn sets the IpamArn field's value. +func (s *Ipam) SetIpamArn(v string) *Ipam { + s.IpamArn = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *Ipam) SetIpamId(v string) *Ipam { + s.IpamId = &v + return s +} + +// SetIpamRegion sets the IpamRegion field's value. +func (s *Ipam) SetIpamRegion(v string) *Ipam { + s.IpamRegion = &v + return s +} + +// SetOperatingRegions sets the OperatingRegions field's value. +func (s *Ipam) SetOperatingRegions(v []*IpamOperatingRegion) *Ipam { + s.OperatingRegions = v + return s +} + +// SetOwnerId sets the OwnerId field's value. +func (s *Ipam) SetOwnerId(v string) *Ipam { + s.OwnerId = &v + return s +} + +// SetPrivateDefaultScopeId sets the PrivateDefaultScopeId field's value. +func (s *Ipam) SetPrivateDefaultScopeId(v string) *Ipam { + s.PrivateDefaultScopeId = &v + return s +} + +// SetPublicDefaultScopeId sets the PublicDefaultScopeId field's value. +func (s *Ipam) SetPublicDefaultScopeId(v string) *Ipam { + s.PublicDefaultScopeId = &v + return s +} + +// SetScopeCount sets the ScopeCount field's value. +func (s *Ipam) SetScopeCount(v int64) *Ipam { + s.ScopeCount = &v + return s +} + +// SetState sets the State field's value. +func (s *Ipam) SetState(v string) *Ipam { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *Ipam) SetTags(v []*Tag) *Ipam { + s.Tags = v + return s +} + +// The historical record of a CIDR within an IPAM scope. For more information, +// see View the history of IP addresses (/vpc/latest/ipam/view-history-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. +type IpamAddressHistoryRecord struct { + _ struct{} `type:"structure"` + + // The CIDR of the resource. + ResourceCidr *string `locationName:"resourceCidr" type:"string"` + + // The compliance status of a resource. For more information on compliance statuses, + // see Monitor CIDR usage by resource (/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // in the Amazon VPC IPAM User Guide. + ResourceComplianceStatus *string `locationName:"resourceComplianceStatus" type:"string" enum:"IpamComplianceStatus"` + + // The ID of the resource. + ResourceId *string `locationName:"resourceId" type:"string"` + + // The name of the resource. + ResourceName *string `locationName:"resourceName" type:"string"` + + // The overlap status of an IPAM resource. The overlap status tells you if the + // CIDR for a resource overlaps with another CIDR in the scope. For more information + // on overlap statuses, see Monitor CIDR usage by resource (/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // in the Amazon VPC IPAM User Guide. + ResourceOverlapStatus *string `locationName:"resourceOverlapStatus" type:"string" enum:"IpamOverlapStatus"` + + // The ID of the resource owner. + ResourceOwnerId *string `locationName:"resourceOwnerId" type:"string"` + + // The Amazon Web Services Region of the resource. + ResourceRegion *string `locationName:"resourceRegion" type:"string"` + + // The type of the resource. + ResourceType *string `locationName:"resourceType" type:"string" enum:"IpamAddressHistoryResourceType"` + + // Sampled end time of the resource-to-CIDR association within the IPAM scope. + // Changes are picked up in periodic snapshots, so the end time may have occurred + // before this specific time. + SampledEndTime *time.Time `locationName:"sampledEndTime" type:"timestamp"` + + // Sampled start time of the resource-to-CIDR association within the IPAM scope. + // Changes are picked up in periodic snapshots, so the start time may have occurred + // before this specific time. + SampledStartTime *time.Time `locationName:"sampledStartTime" type:"timestamp"` + + // The VPC ID of the resource. + VpcId *string `locationName:"vpcId" 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 IpamAddressHistoryRecord) 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 IpamAddressHistoryRecord) GoString() string { + return s.String() +} + +// SetResourceCidr sets the ResourceCidr field's value. +func (s *IpamAddressHistoryRecord) SetResourceCidr(v string) *IpamAddressHistoryRecord { + s.ResourceCidr = &v + return s +} + +// SetResourceComplianceStatus sets the ResourceComplianceStatus field's value. +func (s *IpamAddressHistoryRecord) SetResourceComplianceStatus(v string) *IpamAddressHistoryRecord { + s.ResourceComplianceStatus = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *IpamAddressHistoryRecord) SetResourceId(v string) *IpamAddressHistoryRecord { + s.ResourceId = &v + return s +} + +// SetResourceName sets the ResourceName field's value. +func (s *IpamAddressHistoryRecord) SetResourceName(v string) *IpamAddressHistoryRecord { + s.ResourceName = &v + return s +} + +// SetResourceOverlapStatus sets the ResourceOverlapStatus field's value. +func (s *IpamAddressHistoryRecord) SetResourceOverlapStatus(v string) *IpamAddressHistoryRecord { + s.ResourceOverlapStatus = &v + return s +} + +// SetResourceOwnerId sets the ResourceOwnerId field's value. +func (s *IpamAddressHistoryRecord) SetResourceOwnerId(v string) *IpamAddressHistoryRecord { + s.ResourceOwnerId = &v + return s +} + +// SetResourceRegion sets the ResourceRegion field's value. +func (s *IpamAddressHistoryRecord) SetResourceRegion(v string) *IpamAddressHistoryRecord { + s.ResourceRegion = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *IpamAddressHistoryRecord) SetResourceType(v string) *IpamAddressHistoryRecord { + s.ResourceType = &v + return s +} + +// SetSampledEndTime sets the SampledEndTime field's value. +func (s *IpamAddressHistoryRecord) SetSampledEndTime(v time.Time) *IpamAddressHistoryRecord { + s.SampledEndTime = &v + return s +} + +// SetSampledStartTime sets the SampledStartTime field's value. +func (s *IpamAddressHistoryRecord) SetSampledStartTime(v time.Time) *IpamAddressHistoryRecord { + s.SampledStartTime = &v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *IpamAddressHistoryRecord) SetVpcId(v string) *IpamAddressHistoryRecord { + s.VpcId = &v + return s +} + +// A signed document that proves that you are authorized to bring the specified +// IP address range to Amazon using BYOIP. +type IpamCidrAuthorizationContext struct { + _ struct{} `type:"structure"` + + // The plain-text authorization message for the prefix and account. + Message *string `type:"string"` + + // The signed authorization message for the prefix and account. + Signature *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 IpamCidrAuthorizationContext) 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 IpamCidrAuthorizationContext) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *IpamCidrAuthorizationContext) SetMessage(v string) *IpamCidrAuthorizationContext { + s.Message = &v + return s +} + +// SetSignature sets the Signature field's value. +func (s *IpamCidrAuthorizationContext) SetSignature(v string) *IpamCidrAuthorizationContext { + s.Signature = &v + return s +} + +// The operating Regions for an IPAM. Operating Regions are Amazon Web Services +// Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers +// and monitors resources in the Amazon Web Services Regions you select as operating +// Regions. +// +// For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) +// in the Amazon VPC IPAM User Guide. +type IpamOperatingRegion struct { + _ struct{} `type:"structure"` + + // The name of the operating Region. + RegionName *string `locationName:"regionName" 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 IpamOperatingRegion) 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 IpamOperatingRegion) GoString() string { + return s.String() +} + +// SetRegionName sets the RegionName field's value. +func (s *IpamOperatingRegion) SetRegionName(v string) *IpamOperatingRegion { + s.RegionName = &v + return s +} + +// In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable +// you to organize your IP addresses according to your routing and security +// needs. For example, if you have separate routing and security needs for development +// and production applications, you can create a pool for each. +type IpamPool struct { + _ struct{} `type:"structure"` + + // The address family of the pool. + AddressFamily *string `locationName:"addressFamily" type:"string" enum:"AddressFamily"` + + // The default netmask length for allocations added to this pool. If, for example, + // the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations + // will default to 10.0.0.0/16. + AllocationDefaultNetmaskLength *int64 `locationName:"allocationDefaultNetmaskLength" type:"integer"` + + // The maximum netmask length possible for CIDR allocations in this IPAM pool + // to be compliant. The maximum netmask length must be greater than the minimum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. + AllocationMaxNetmaskLength *int64 `locationName:"allocationMaxNetmaskLength" type:"integer"` + + // The minimum netmask length required for CIDR allocations in this IPAM pool + // to be compliant. The minimum netmask length must be less than the maximum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. + AllocationMinNetmaskLength *int64 `locationName:"allocationMinNetmaskLength" type:"integer"` + + // Tags that are required for resources that use CIDRs from this IPAM pool. + // Resources that do not have these tags will not be allowed to allocate space + // from the pool. If the resources have their tags changed after they have allocated + // space or if the allocation tagging requirements are changed on the pool, + // the resource may be marked as noncompliant. + AllocationResourceTags []*IpamResourceTag `locationName:"allocationResourceTagSet" locationNameList:"item" type:"list"` + + // If selected, IPAM will continuously look for resources within the CIDR range + // of this pool and automatically import them as allocations into your IPAM. + // The CIDRs that will be allocated for these resources must not already be + // allocated to other resources in order for the import to succeed. IPAM will + // import a CIDR regardless of its compliance with the pool's allocation rules, + // so a resource might be imported and subsequently marked as noncompliant. + // If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest + // CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will + // randomly import one of them only. + // + // A locale must be set on the pool for this feature to work. + AutoImport *bool `locationName:"autoImport" type:"boolean"` + + // Limits which service in Amazon Web Services that the pool can be used in. + // "ec2", for example, allows users to use space for Elastic IP addresses and + // VPCs. + AwsService *string `locationName:"awsService" type:"string" enum:"IpamPoolAwsService"` + + // The description of the IPAM pool. + Description *string `locationName:"description" type:"string"` + + // The ARN of the IPAM. + IpamArn *string `locationName:"ipamArn" min:"1" type:"string"` + + // The ARN of the IPAM pool. + IpamPoolArn *string `locationName:"ipamPoolArn" min:"1" type:"string"` + + // The ID of the IPAM pool. + IpamPoolId *string `locationName:"ipamPoolId" type:"string"` + + // The Amazon Web Services Region of the IPAM pool. + IpamRegion *string `locationName:"ipamRegion" type:"string"` + + // The ARN of the scope of the IPAM pool. + IpamScopeArn *string `locationName:"ipamScopeArn" min:"1" type:"string"` + + // In IPAM, a scope is the highest-level container within IPAM. An IPAM contains + // two default scopes. Each scope represents the IP space for a single network. + // The private scope is intended for all private IP address space. The public + // scope is intended for all public IP address space. Scopes enable you to reuse + // IP addresses across multiple unconnected networks without causing IP address + // overlap or conflict. + IpamScopeType *string `locationName:"ipamScopeType" type:"string" enum:"IpamScopeType"` + + // The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services + // Region where you want to make an IPAM pool available for allocations. Only + // resources in the same Region as the locale of the pool can get IP address + // allocations from the pool. You can only allocate a CIDR for a VPC, for example, + // from an IPAM pool that shares a locale with the VPC’s Region. Note that + // once you choose a Locale for a pool, you cannot modify it. If you choose + // an Amazon Web Services Region for locale that has not been configured as + // an operating Region for the IPAM, you'll get an error. + Locale *string `locationName:"locale" type:"string"` + + // The Amazon Web Services account ID of the owner of the IPAM pool. + OwnerId *string `locationName:"ownerId" type:"string"` + + // The depth of pools in your IPAM pool. The pool depth quota is 10. For more + // information, see Quotas in IPAM (/vpc/latest/ipam/quotas-ipam.html) in the + // Amazon VPC IPAM User Guide. + PoolDepth *int64 `locationName:"poolDepth" type:"integer"` + + // Determines if a pool is publicly advertisable. This option is not available + // for pools with AddressFamily set to ipv4. + PubliclyAdvertisable *bool `locationName:"publiclyAdvertisable" type:"boolean"` + + // The ID of the source IPAM pool. You can use this option to create an IPAM + // pool within an existing source pool. + SourceIpamPoolId *string `locationName:"sourceIpamPoolId" type:"string"` + + // The state of the IPAM pool. + State *string `locationName:"state" type:"string" enum:"IpamPoolState"` + + // A message related to the failed creation of an IPAM pool. + StateMessage *string `locationName:"stateMessage" type:"string"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" 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 IpamPool) 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 IpamPool) GoString() string { + return s.String() +} + +// SetAddressFamily sets the AddressFamily field's value. +func (s *IpamPool) SetAddressFamily(v string) *IpamPool { + s.AddressFamily = &v + return s +} + +// SetAllocationDefaultNetmaskLength sets the AllocationDefaultNetmaskLength field's value. +func (s *IpamPool) SetAllocationDefaultNetmaskLength(v int64) *IpamPool { + s.AllocationDefaultNetmaskLength = &v + return s +} + +// SetAllocationMaxNetmaskLength sets the AllocationMaxNetmaskLength field's value. +func (s *IpamPool) SetAllocationMaxNetmaskLength(v int64) *IpamPool { + s.AllocationMaxNetmaskLength = &v + return s +} + +// SetAllocationMinNetmaskLength sets the AllocationMinNetmaskLength field's value. +func (s *IpamPool) SetAllocationMinNetmaskLength(v int64) *IpamPool { + s.AllocationMinNetmaskLength = &v + return s +} + +// SetAllocationResourceTags sets the AllocationResourceTags field's value. +func (s *IpamPool) SetAllocationResourceTags(v []*IpamResourceTag) *IpamPool { + s.AllocationResourceTags = v + return s +} + +// SetAutoImport sets the AutoImport field's value. +func (s *IpamPool) SetAutoImport(v bool) *IpamPool { + s.AutoImport = &v + return s +} + +// SetAwsService sets the AwsService field's value. +func (s *IpamPool) SetAwsService(v string) *IpamPool { + s.AwsService = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *IpamPool) SetDescription(v string) *IpamPool { + s.Description = &v + return s +} + +// SetIpamArn sets the IpamArn field's value. +func (s *IpamPool) SetIpamArn(v string) *IpamPool { + s.IpamArn = &v + return s +} + +// SetIpamPoolArn sets the IpamPoolArn field's value. +func (s *IpamPool) SetIpamPoolArn(v string) *IpamPool { + s.IpamPoolArn = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *IpamPool) SetIpamPoolId(v string) *IpamPool { + s.IpamPoolId = &v + return s +} + +// SetIpamRegion sets the IpamRegion field's value. +func (s *IpamPool) SetIpamRegion(v string) *IpamPool { + s.IpamRegion = &v + return s +} + +// SetIpamScopeArn sets the IpamScopeArn field's value. +func (s *IpamPool) SetIpamScopeArn(v string) *IpamPool { + s.IpamScopeArn = &v + return s +} + +// SetIpamScopeType sets the IpamScopeType field's value. +func (s *IpamPool) SetIpamScopeType(v string) *IpamPool { + s.IpamScopeType = &v + return s +} + +// SetLocale sets the Locale field's value. +func (s *IpamPool) SetLocale(v string) *IpamPool { + s.Locale = &v + return s +} + +// SetOwnerId sets the OwnerId field's value. +func (s *IpamPool) SetOwnerId(v string) *IpamPool { + s.OwnerId = &v + return s +} + +// SetPoolDepth sets the PoolDepth field's value. +func (s *IpamPool) SetPoolDepth(v int64) *IpamPool { + s.PoolDepth = &v + return s +} + +// SetPubliclyAdvertisable sets the PubliclyAdvertisable field's value. +func (s *IpamPool) SetPubliclyAdvertisable(v bool) *IpamPool { + s.PubliclyAdvertisable = &v + return s +} + +// SetSourceIpamPoolId sets the SourceIpamPoolId field's value. +func (s *IpamPool) SetSourceIpamPoolId(v string) *IpamPool { + s.SourceIpamPoolId = &v + return s +} + +// SetState sets the State field's value. +func (s *IpamPool) SetState(v string) *IpamPool { + s.State = &v + return s +} + +// SetStateMessage sets the StateMessage field's value. +func (s *IpamPool) SetStateMessage(v string) *IpamPool { + s.StateMessage = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *IpamPool) SetTags(v []*Tag) *IpamPool { + s.Tags = v + return s +} + +// In IPAM, an allocation is a CIDR assignment from an IPAM pool to another +// resource or IPAM pool. +type IpamPoolAllocation struct { + _ struct{} `type:"structure"` + + // The CIDR for the allocation. A CIDR is a representation of an IP address + // and its associated network mask (or netmask) and refers to a range of IP + // addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is + // 2001:DB8::/32. + Cidr *string `locationName:"cidr" type:"string"` + + // A description of the pool allocation. + Description *string `locationName:"description" type:"string"` + + // The ID of an allocation. + IpamPoolAllocationId *string `locationName:"ipamPoolAllocationId" type:"string"` + + // The ID of the resource. + ResourceId *string `locationName:"resourceId" type:"string"` + + // The owner of the resource. + ResourceOwner *string `locationName:"resourceOwner" type:"string"` + + // The Amazon Web Services Region of the resource. + ResourceRegion *string `locationName:"resourceRegion" type:"string"` + + // The type of the resource. + ResourceType *string `locationName:"resourceType" type:"string" enum:"IpamPoolAllocationResourceType"` +} + +// 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 IpamPoolAllocation) 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 IpamPoolAllocation) GoString() string { + return s.String() +} + +// SetCidr sets the Cidr field's value. +func (s *IpamPoolAllocation) SetCidr(v string) *IpamPoolAllocation { + s.Cidr = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *IpamPoolAllocation) SetDescription(v string) *IpamPoolAllocation { + s.Description = &v + return s +} + +// SetIpamPoolAllocationId sets the IpamPoolAllocationId field's value. +func (s *IpamPoolAllocation) SetIpamPoolAllocationId(v string) *IpamPoolAllocation { + s.IpamPoolAllocationId = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *IpamPoolAllocation) SetResourceId(v string) *IpamPoolAllocation { + s.ResourceId = &v + return s +} + +// SetResourceOwner sets the ResourceOwner field's value. +func (s *IpamPoolAllocation) SetResourceOwner(v string) *IpamPoolAllocation { + s.ResourceOwner = &v + return s +} + +// SetResourceRegion sets the ResourceRegion field's value. +func (s *IpamPoolAllocation) SetResourceRegion(v string) *IpamPoolAllocation { + s.ResourceRegion = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *IpamPoolAllocation) SetResourceType(v string) *IpamPoolAllocation { + s.ResourceType = &v + return s +} + +// A CIDR provisioned to an IPAM pool. +type IpamPoolCidr struct { + _ struct{} `type:"structure"` + + // The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP + // address and its associated network mask (or netmask) and refers to a range + // of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example + // is 2001:DB8::/32. + Cidr *string `locationName:"cidr" type:"string"` + + // Details related to why an IPAM pool CIDR failed to be provisioned. + FailureReason *IpamPoolCidrFailureReason `locationName:"failureReason" type:"structure"` + + // The state of the CIDR. + State *string `locationName:"state" type:"string" enum:"IpamPoolCidrState"` +} + +// 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 IpamPoolCidr) 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 IpamPoolCidr) GoString() string { + return s.String() +} + +// SetCidr sets the Cidr field's value. +func (s *IpamPoolCidr) SetCidr(v string) *IpamPoolCidr { + s.Cidr = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *IpamPoolCidr) SetFailureReason(v *IpamPoolCidrFailureReason) *IpamPoolCidr { + s.FailureReason = v + return s +} + +// SetState sets the State field's value. +func (s *IpamPoolCidr) SetState(v string) *IpamPoolCidr { + s.State = &v + return s +} + +// Details related to why an IPAM pool CIDR failed to be provisioned. +type IpamPoolCidrFailureReason struct { + _ struct{} `type:"structure"` + + // An error code related to why an IPAM pool CIDR failed to be provisioned. + Code *string `locationName:"code" type:"string" enum:"IpamPoolCidrFailureCode"` + + // A message related to why an IPAM pool CIDR failed to be provisioned. + 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 IpamPoolCidrFailureReason) 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 IpamPoolCidrFailureReason) GoString() string { + return s.String() +} + +// SetCode sets the Code field's value. +func (s *IpamPoolCidrFailureReason) SetCode(v string) *IpamPoolCidrFailureReason { + s.Code = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *IpamPoolCidrFailureReason) SetMessage(v string) *IpamPoolCidrFailureReason { + s.Message = &v + return s +} + +// The CIDR for an IPAM resource. +type IpamResourceCidr struct { + _ struct{} `type:"structure"` + + // The compliance status of the IPAM resource. For more information on compliance + // statuses, see Monitor CIDR usage by resource (/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // in the Amazon VPC IPAM User Guide. + ComplianceStatus *string `locationName:"complianceStatus" type:"string" enum:"IpamComplianceStatus"` + + // The IP address space in the IPAM pool that is allocated to this resource. + // To convert the decimal to a percentage, multiply the decimal by 100. + IpUsage *float64 `locationName:"ipUsage" type:"double"` + + // The IPAM ID for an IPAM resource. + IpamId *string `locationName:"ipamId" type:"string"` + + // The pool ID for an IPAM resource. + IpamPoolId *string `locationName:"ipamPoolId" type:"string"` + + // The scope ID for an IPAM resource. + IpamScopeId *string `locationName:"ipamScopeId" type:"string"` + + // The management state of the resource. For more information about management + // states, see Monitor CIDR usage by resource (/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // in the Amazon VPC IPAM User Guide. + ManagementState *string `locationName:"managementState" type:"string" enum:"IpamManagementState"` + + // The overlap status of an IPAM resource. The overlap status tells you if the + // CIDR for a resource overlaps with another CIDR in the scope. For more information + // on overlap statuses, see Monitor CIDR usage by resource (/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // in the Amazon VPC IPAM User Guide. + OverlapStatus *string `locationName:"overlapStatus" type:"string" enum:"IpamOverlapStatus"` + + // The CIDR for an IPAM resource. + ResourceCidr *string `locationName:"resourceCidr" type:"string"` + + // The ID of an IPAM resource. + ResourceId *string `locationName:"resourceId" type:"string"` + + // The name of an IPAM resource. + ResourceName *string `locationName:"resourceName" type:"string"` + + // The Amazon Web Services account number of the owner of an IPAM resource. + ResourceOwnerId *string `locationName:"resourceOwnerId" type:"string"` + + // The Amazon Web Services Region for an IPAM resource. + ResourceRegion *string `locationName:"resourceRegion" type:"string"` + + // The tags for an IPAM resource. + ResourceTags []*IpamResourceTag `locationName:"resourceTagSet" locationNameList:"item" type:"list"` + + // The type of IPAM resource. + ResourceType *string `locationName:"resourceType" type:"string" enum:"IpamResourceType"` + + // The ID of a VPC. + VpcId *string `locationName:"vpcId" 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 IpamResourceCidr) 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 IpamResourceCidr) GoString() string { + return s.String() +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *IpamResourceCidr) SetComplianceStatus(v string) *IpamResourceCidr { + s.ComplianceStatus = &v + return s +} + +// SetIpUsage sets the IpUsage field's value. +func (s *IpamResourceCidr) SetIpUsage(v float64) *IpamResourceCidr { + s.IpUsage = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *IpamResourceCidr) SetIpamId(v string) *IpamResourceCidr { + s.IpamId = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *IpamResourceCidr) SetIpamPoolId(v string) *IpamResourceCidr { + s.IpamPoolId = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *IpamResourceCidr) SetIpamScopeId(v string) *IpamResourceCidr { + s.IpamScopeId = &v + return s +} + +// SetManagementState sets the ManagementState field's value. +func (s *IpamResourceCidr) SetManagementState(v string) *IpamResourceCidr { + s.ManagementState = &v + return s +} + +// SetOverlapStatus sets the OverlapStatus field's value. +func (s *IpamResourceCidr) SetOverlapStatus(v string) *IpamResourceCidr { + s.OverlapStatus = &v + return s +} + +// SetResourceCidr sets the ResourceCidr field's value. +func (s *IpamResourceCidr) SetResourceCidr(v string) *IpamResourceCidr { + s.ResourceCidr = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *IpamResourceCidr) SetResourceId(v string) *IpamResourceCidr { + s.ResourceId = &v + return s +} + +// SetResourceName sets the ResourceName field's value. +func (s *IpamResourceCidr) SetResourceName(v string) *IpamResourceCidr { + s.ResourceName = &v + return s +} + +// SetResourceOwnerId sets the ResourceOwnerId field's value. +func (s *IpamResourceCidr) SetResourceOwnerId(v string) *IpamResourceCidr { + s.ResourceOwnerId = &v + return s +} + +// SetResourceRegion sets the ResourceRegion field's value. +func (s *IpamResourceCidr) SetResourceRegion(v string) *IpamResourceCidr { + s.ResourceRegion = &v + return s +} + +// SetResourceTags sets the ResourceTags field's value. +func (s *IpamResourceCidr) SetResourceTags(v []*IpamResourceTag) *IpamResourceCidr { + s.ResourceTags = v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *IpamResourceCidr) SetResourceType(v string) *IpamResourceCidr { + s.ResourceType = &v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *IpamResourceCidr) SetVpcId(v string) *IpamResourceCidr { + s.VpcId = &v + return s +} + +// The key/value combination of a tag assigned to the resource. Use the tag +// key in the filter name and the tag value as the filter value. For example, +// to find all resources that have a tag with the key Owner and the value TeamA, +// specify tag:Owner for the filter name and TeamA for the filter value. +type IpamResourceTag struct { + _ struct{} `type:"structure"` + + // The key of a tag assigned to the resource. Use this filter to find all resources + // assigned a tag with a specific key, regardless of the tag value. + Key *string `locationName:"key" type:"string"` + + // The value of the tag. + Value *string `locationName:"value" 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 IpamResourceTag) 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 IpamResourceTag) GoString() string { + return s.String() +} + +// SetKey sets the Key field's value. +func (s *IpamResourceTag) SetKey(v string) *IpamResourceTag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *IpamResourceTag) SetValue(v string) *IpamResourceTag { + s.Value = &v + return s +} + +// In IPAM, a scope is the highest-level container within IPAM. An IPAM contains +// two default scopes. Each scope represents the IP space for a single network. +// The private scope is intended for all private IP address space. The public +// scope is intended for all public IP address space. Scopes enable you to reuse +// IP addresses across multiple unconnected networks without causing IP address +// overlap or conflict. +// +// For more information, see How IPAM works (/vpc/latest/ipam/how-it-works-ipam.html) +// in the Amazon VPC IPAM User Guide +type IpamScope struct { + _ struct{} `type:"structure"` + + // The description of the scope. + Description *string `locationName:"description" type:"string"` + + // The ARN of the IPAM. + IpamArn *string `locationName:"ipamArn" min:"1" type:"string"` + + // The Amazon Web Services Region of the IPAM scope. + IpamRegion *string `locationName:"ipamRegion" type:"string"` + + // The ARN of the scope. + IpamScopeArn *string `locationName:"ipamScopeArn" min:"1" type:"string"` + + // The ID of the scope. + IpamScopeId *string `locationName:"ipamScopeId" type:"string"` + + // The type of the scope. + IpamScopeType *string `locationName:"ipamScopeType" type:"string" enum:"IpamScopeType"` + + // Defines if the scope is the default scope or not. + IsDefault *bool `locationName:"isDefault" type:"boolean"` + + // The Amazon Web Services account ID of the owner of the scope. + OwnerId *string `locationName:"ownerId" type:"string"` + + // The number of pools in the scope. + PoolCount *int64 `locationName:"poolCount" type:"integer"` + + // The state of the IPAM scope. + State *string `locationName:"state" type:"string" enum:"IpamScopeState"` + + // The key/value combination of a tag assigned to the resource. Use the tag + // key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA, + // specify tag:Owner for the filter name and TeamA for the filter value. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" 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 IpamScope) 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 IpamScope) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *IpamScope) SetDescription(v string) *IpamScope { + s.Description = &v + return s +} + +// SetIpamArn sets the IpamArn field's value. +func (s *IpamScope) SetIpamArn(v string) *IpamScope { + s.IpamArn = &v + return s +} + +// SetIpamRegion sets the IpamRegion field's value. +func (s *IpamScope) SetIpamRegion(v string) *IpamScope { + s.IpamRegion = &v + return s +} + +// SetIpamScopeArn sets the IpamScopeArn field's value. +func (s *IpamScope) SetIpamScopeArn(v string) *IpamScope { + s.IpamScopeArn = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *IpamScope) SetIpamScopeId(v string) *IpamScope { + s.IpamScopeId = &v + return s +} + +// SetIpamScopeType sets the IpamScopeType field's value. +func (s *IpamScope) SetIpamScopeType(v string) *IpamScope { + s.IpamScopeType = &v + return s +} + +// SetIsDefault sets the IsDefault field's value. +func (s *IpamScope) SetIsDefault(v bool) *IpamScope { + s.IsDefault = &v + return s +} + +// SetOwnerId sets the OwnerId field's value. +func (s *IpamScope) SetOwnerId(v string) *IpamScope { + s.OwnerId = &v + return s +} + +// SetPoolCount sets the PoolCount field's value. +func (s *IpamScope) SetPoolCount(v int64) *IpamScope { + s.PoolCount = &v + return s +} + +// SetState sets the State field's value. +func (s *IpamScope) SetState(v string) *IpamScope { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *IpamScope) SetTags(v []*Tag) *IpamScope { + s.Tags = v + return s +} + // Describes an IPv4 prefix. type Ipv4PrefixSpecification struct { _ struct{} `type:"structure"` @@ -116462,6 +124417,563 @@ func (s *ModifyInstancePlacementOutput) SetReturn(v bool) *ModifyInstancePlaceme return s } +type ModifyIpamInput struct { + _ struct{} `type:"structure"` + + // Choose the operating Regions for the IPAM. Operating Regions are Amazon Web + // Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM + // only discovers and monitors resources in the Amazon Web Services Regions + // you select as operating Regions. + // + // For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) + // in the Amazon VPC IPAM User Guide. + AddOperatingRegions []*AddIpamOperatingRegion `locationName:"AddOperatingRegion" type:"list"` + + // The description of the IPAM you want to modify. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM you want to modify. + // + // IpamId is a required field + IpamId *string `type:"string" required:"true"` + + // The operating Regions to remove. + RemoveOperatingRegions []*RemoveIpamOperatingRegion `locationName:"RemoveOperatingRegion" 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 ModifyIpamInput) 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 ModifyIpamInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyIpamInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyIpamInput"} + if s.IpamId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAddOperatingRegions sets the AddOperatingRegions field's value. +func (s *ModifyIpamInput) SetAddOperatingRegions(v []*AddIpamOperatingRegion) *ModifyIpamInput { + s.AddOperatingRegions = v + return s +} + +// SetDescription sets the Description field's value. +func (s *ModifyIpamInput) SetDescription(v string) *ModifyIpamInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ModifyIpamInput) SetDryRun(v bool) *ModifyIpamInput { + s.DryRun = &v + return s +} + +// SetIpamId sets the IpamId field's value. +func (s *ModifyIpamInput) SetIpamId(v string) *ModifyIpamInput { + s.IpamId = &v + return s +} + +// SetRemoveOperatingRegions sets the RemoveOperatingRegions field's value. +func (s *ModifyIpamInput) SetRemoveOperatingRegions(v []*RemoveIpamOperatingRegion) *ModifyIpamInput { + s.RemoveOperatingRegions = v + return s +} + +type ModifyIpamOutput struct { + _ struct{} `type:"structure"` + + // The results of the modification. + Ipam *Ipam `locationName:"ipam" 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 ModifyIpamOutput) 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 ModifyIpamOutput) GoString() string { + return s.String() +} + +// SetIpam sets the Ipam field's value. +func (s *ModifyIpamOutput) SetIpam(v *Ipam) *ModifyIpamOutput { + s.Ipam = v + return s +} + +type ModifyIpamPoolInput struct { + _ struct{} `type:"structure"` + + // Add tag allocation rules to a pool. For more information about allocation + // rules, see Create a top-level pool (/vpc/latest/ipam/create-top-ipam.html) + // in the Amazon VPC IPAM User Guide. + AddAllocationResourceTags []*RequestIpamResourceTag `locationName:"AddAllocationResourceTag" locationNameList:"item" type:"list"` + + // The default netmask length for allocations added to this pool. If, for example, + // the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations + // will default to 10.0.0.0/16. + AllocationDefaultNetmaskLength *int64 `type:"integer"` + + // The maximum netmask length possible for CIDR allocations in this IPAM pool + // to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. + // Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask + // length must be greater than the minimum netmask length. + AllocationMaxNetmaskLength *int64 `type:"integer"` + + // The minimum netmask length required for CIDR allocations in this IPAM pool + // to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. + // Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask + // length must be less than the maximum netmask length. + AllocationMinNetmaskLength *int64 `type:"integer"` + + // If true, IPAM will continuously look for resources within the CIDR range + // of this pool and automatically import them as allocations into your IPAM. + // The CIDRs that will be allocated for these resources must not already be + // allocated to other resources in order for the import to succeed. IPAM will + // import a CIDR regardless of its compliance with the pool's allocation rules, + // so a resource might be imported and subsequently marked as noncompliant. + // If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest + // CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will + // randomly import one of them only. + // + // A locale must be set on the pool for this feature to work. + AutoImport *bool `type:"boolean"` + + // Clear the default netmask length allocation rule for this pool. + ClearAllocationDefaultNetmaskLength *bool `type:"boolean"` + + // The description of the IPAM pool you want to modify. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM pool you want to modify. + // + // IpamPoolId is a required field + IpamPoolId *string `type:"string" required:"true"` + + // Remove tag allocation rules from a pool. + RemoveAllocationResourceTags []*RequestIpamResourceTag `locationName:"RemoveAllocationResourceTag" locationNameList:"item" 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 ModifyIpamPoolInput) 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 ModifyIpamPoolInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyIpamPoolInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyIpamPoolInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAddAllocationResourceTags sets the AddAllocationResourceTags field's value. +func (s *ModifyIpamPoolInput) SetAddAllocationResourceTags(v []*RequestIpamResourceTag) *ModifyIpamPoolInput { + s.AddAllocationResourceTags = v + return s +} + +// SetAllocationDefaultNetmaskLength sets the AllocationDefaultNetmaskLength field's value. +func (s *ModifyIpamPoolInput) SetAllocationDefaultNetmaskLength(v int64) *ModifyIpamPoolInput { + s.AllocationDefaultNetmaskLength = &v + return s +} + +// SetAllocationMaxNetmaskLength sets the AllocationMaxNetmaskLength field's value. +func (s *ModifyIpamPoolInput) SetAllocationMaxNetmaskLength(v int64) *ModifyIpamPoolInput { + s.AllocationMaxNetmaskLength = &v + return s +} + +// SetAllocationMinNetmaskLength sets the AllocationMinNetmaskLength field's value. +func (s *ModifyIpamPoolInput) SetAllocationMinNetmaskLength(v int64) *ModifyIpamPoolInput { + s.AllocationMinNetmaskLength = &v + return s +} + +// SetAutoImport sets the AutoImport field's value. +func (s *ModifyIpamPoolInput) SetAutoImport(v bool) *ModifyIpamPoolInput { + s.AutoImport = &v + return s +} + +// SetClearAllocationDefaultNetmaskLength sets the ClearAllocationDefaultNetmaskLength field's value. +func (s *ModifyIpamPoolInput) SetClearAllocationDefaultNetmaskLength(v bool) *ModifyIpamPoolInput { + s.ClearAllocationDefaultNetmaskLength = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ModifyIpamPoolInput) SetDescription(v string) *ModifyIpamPoolInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ModifyIpamPoolInput) SetDryRun(v bool) *ModifyIpamPoolInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *ModifyIpamPoolInput) SetIpamPoolId(v string) *ModifyIpamPoolInput { + s.IpamPoolId = &v + return s +} + +// SetRemoveAllocationResourceTags sets the RemoveAllocationResourceTags field's value. +func (s *ModifyIpamPoolInput) SetRemoveAllocationResourceTags(v []*RequestIpamResourceTag) *ModifyIpamPoolInput { + s.RemoveAllocationResourceTags = v + return s +} + +type ModifyIpamPoolOutput struct { + _ struct{} `type:"structure"` + + // The results of the modification. + IpamPool *IpamPool `locationName:"ipamPool" 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 ModifyIpamPoolOutput) 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 ModifyIpamPoolOutput) GoString() string { + return s.String() +} + +// SetIpamPool sets the IpamPool field's value. +func (s *ModifyIpamPoolOutput) SetIpamPool(v *IpamPool) *ModifyIpamPoolOutput { + s.IpamPool = v + return s +} + +type ModifyIpamResourceCidrInput struct { + _ struct{} `type:"structure"` + + // The ID of the current scope that the resource CIDR is in. + // + // CurrentIpamScopeId is a required field + CurrentIpamScopeId *string `type:"string" required:"true"` + + // The ID of the scope you want to transfer the resource CIDR to. + DestinationIpamScopeId *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // Determines if the resource is monitored by IPAM. If a resource is monitored, + // the resource is discovered by IPAM and you can view details about the resource’s + // CIDR. + // + // Monitored is a required field + Monitored *bool `type:"boolean" required:"true"` + + // The CIDR of the resource you want to modify. + // + // ResourceCidr is a required field + ResourceCidr *string `type:"string" required:"true"` + + // The ID of the resource you want to modify. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The Amazon Web Services Region of the resource you want to modify. + // + // ResourceRegion is a required field + ResourceRegion *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 ModifyIpamResourceCidrInput) 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 ModifyIpamResourceCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyIpamResourceCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyIpamResourceCidrInput"} + if s.CurrentIpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("CurrentIpamScopeId")) + } + if s.Monitored == nil { + invalidParams.Add(request.NewErrParamRequired("Monitored")) + } + if s.ResourceCidr == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceCidr")) + } + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceRegion == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceRegion")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCurrentIpamScopeId sets the CurrentIpamScopeId field's value. +func (s *ModifyIpamResourceCidrInput) SetCurrentIpamScopeId(v string) *ModifyIpamResourceCidrInput { + s.CurrentIpamScopeId = &v + return s +} + +// SetDestinationIpamScopeId sets the DestinationIpamScopeId field's value. +func (s *ModifyIpamResourceCidrInput) SetDestinationIpamScopeId(v string) *ModifyIpamResourceCidrInput { + s.DestinationIpamScopeId = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ModifyIpamResourceCidrInput) SetDryRun(v bool) *ModifyIpamResourceCidrInput { + s.DryRun = &v + return s +} + +// SetMonitored sets the Monitored field's value. +func (s *ModifyIpamResourceCidrInput) SetMonitored(v bool) *ModifyIpamResourceCidrInput { + s.Monitored = &v + return s +} + +// SetResourceCidr sets the ResourceCidr field's value. +func (s *ModifyIpamResourceCidrInput) SetResourceCidr(v string) *ModifyIpamResourceCidrInput { + s.ResourceCidr = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *ModifyIpamResourceCidrInput) SetResourceId(v string) *ModifyIpamResourceCidrInput { + s.ResourceId = &v + return s +} + +// SetResourceRegion sets the ResourceRegion field's value. +func (s *ModifyIpamResourceCidrInput) SetResourceRegion(v string) *ModifyIpamResourceCidrInput { + s.ResourceRegion = &v + return s +} + +type ModifyIpamResourceCidrOutput struct { + _ struct{} `type:"structure"` + + // The CIDR for an IPAM resource. + IpamResourceCidr *IpamResourceCidr `locationName:"ipamResourceCidr" 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 ModifyIpamResourceCidrOutput) 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 ModifyIpamResourceCidrOutput) GoString() string { + return s.String() +} + +// SetIpamResourceCidr sets the IpamResourceCidr field's value. +func (s *ModifyIpamResourceCidrOutput) SetIpamResourceCidr(v *IpamResourceCidr) *ModifyIpamResourceCidrOutput { + s.IpamResourceCidr = v + return s +} + +type ModifyIpamScopeInput struct { + _ struct{} `type:"structure"` + + // The description of the scope you want to modify. + Description *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the scope you want to modify. + // + // IpamScopeId is a required field + IpamScopeId *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 ModifyIpamScopeInput) 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 ModifyIpamScopeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModifyIpamScopeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModifyIpamScopeInput"} + if s.IpamScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *ModifyIpamScopeInput) SetDescription(v string) *ModifyIpamScopeInput { + s.Description = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ModifyIpamScopeInput) SetDryRun(v bool) *ModifyIpamScopeInput { + s.DryRun = &v + return s +} + +// SetIpamScopeId sets the IpamScopeId field's value. +func (s *ModifyIpamScopeInput) SetIpamScopeId(v string) *ModifyIpamScopeInput { + s.IpamScopeId = &v + return s +} + +type ModifyIpamScopeOutput struct { + _ struct{} `type:"structure"` + + // The results of the modification. + IpamScope *IpamScope `locationName:"ipamScope" 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 ModifyIpamScopeOutput) 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 ModifyIpamScopeOutput) GoString() string { + return s.String() +} + +// SetIpamScope sets the IpamScope field's value. +func (s *ModifyIpamScopeOutput) SetIpamScope(v *IpamScope) *ModifyIpamScopeOutput { + s.IpamScope = v + return s +} + type ModifyLaunchTemplateInput struct { _ struct{} `type:"structure"` @@ -120791,6 +129303,99 @@ func (s *MoveAddressToVpcOutput) SetStatus(v string) *MoveAddressToVpcOutput { return s } +type MoveByoipCidrToIpamInput struct { + _ struct{} `type:"structure"` + + // The BYOIP CIDR. + Cidr *string `type:"string"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The IPAM pool ID. + IpamPoolId *string `type:"string"` + + // The Amazon Web Services account ID of the owner of the IPAM pool. + IpamPoolOwner *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 MoveByoipCidrToIpamInput) 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 MoveByoipCidrToIpamInput) GoString() string { + return s.String() +} + +// SetCidr sets the Cidr field's value. +func (s *MoveByoipCidrToIpamInput) SetCidr(v string) *MoveByoipCidrToIpamInput { + s.Cidr = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *MoveByoipCidrToIpamInput) SetDryRun(v bool) *MoveByoipCidrToIpamInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *MoveByoipCidrToIpamInput) SetIpamPoolId(v string) *MoveByoipCidrToIpamInput { + s.IpamPoolId = &v + return s +} + +// SetIpamPoolOwner sets the IpamPoolOwner field's value. +func (s *MoveByoipCidrToIpamInput) SetIpamPoolOwner(v string) *MoveByoipCidrToIpamInput { + s.IpamPoolOwner = &v + return s +} + +type MoveByoipCidrToIpamOutput struct { + _ struct{} `type:"structure"` + + // Information about an address range that is provisioned for use with your + // Amazon Web Services resources through bring your own IP addresses (BYOIP). + ByoipCidr *ByoipCidr `locationName:"byoipCidr" 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 MoveByoipCidrToIpamOutput) 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 MoveByoipCidrToIpamOutput) GoString() string { + return s.String() +} + +// SetByoipCidr sets the ByoipCidr field's value. +func (s *MoveByoipCidrToIpamOutput) SetByoipCidr(v *ByoipCidr) *MoveByoipCidrToIpamOutput { + s.ByoipCidr = v + return s +} + // Describes the status of a moving Elastic IP address. type MovingAddressStatus struct { _ struct{} `type:"structure"` @@ -121481,6 +130086,246 @@ func (s *NetworkInfo) SetNetworkPerformance(v string) *NetworkInfo { return s } +// Describes a Network Access Scope. +type NetworkInsightsAccessScope struct { + _ struct{} `type:"structure"` + + // The creation date. + CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the Network Access Scope. + NetworkInsightsAccessScopeArn *string `locationName:"networkInsightsAccessScopeArn" min:"1" type:"string"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `locationName:"networkInsightsAccessScopeId" type:"string"` + + // The tags. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` + + // The last updated date. + UpdatedDate *time.Time `locationName:"updatedDate" 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 NetworkInsightsAccessScope) 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 NetworkInsightsAccessScope) GoString() string { + return s.String() +} + +// SetCreatedDate sets the CreatedDate field's value. +func (s *NetworkInsightsAccessScope) SetCreatedDate(v time.Time) *NetworkInsightsAccessScope { + s.CreatedDate = &v + return s +} + +// SetNetworkInsightsAccessScopeArn sets the NetworkInsightsAccessScopeArn field's value. +func (s *NetworkInsightsAccessScope) SetNetworkInsightsAccessScopeArn(v string) *NetworkInsightsAccessScope { + s.NetworkInsightsAccessScopeArn = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *NetworkInsightsAccessScope) SetNetworkInsightsAccessScopeId(v string) *NetworkInsightsAccessScope { + s.NetworkInsightsAccessScopeId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *NetworkInsightsAccessScope) SetTags(v []*Tag) *NetworkInsightsAccessScope { + s.Tags = v + return s +} + +// SetUpdatedDate sets the UpdatedDate field's value. +func (s *NetworkInsightsAccessScope) SetUpdatedDate(v time.Time) *NetworkInsightsAccessScope { + s.UpdatedDate = &v + return s +} + +// Describes a Network Access Scope analysis. +type NetworkInsightsAccessScopeAnalysis struct { + _ struct{} `type:"structure"` + + // The number of network interfaces analyzed. + AnalyzedEniCount *int64 `locationName:"analyzedEniCount" type:"integer"` + + // The analysis end date. + EndDate *time.Time `locationName:"endDate" type:"timestamp"` + + // Indicates whether there are findings. + FindingsFound *string `locationName:"findingsFound" type:"string" enum:"FindingsFound"` + + // The Amazon Resource Name (ARN) of the Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysisArn *string `locationName:"networkInsightsAccessScopeAnalysisArn" min:"1" type:"string"` + + // The ID of the Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysisId *string `locationName:"networkInsightsAccessScopeAnalysisId" type:"string"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `locationName:"networkInsightsAccessScopeId" type:"string"` + + // The analysis start date. + StartDate *time.Time `locationName:"startDate" type:"timestamp"` + + // The status. + Status *string `locationName:"status" type:"string" enum:"AnalysisStatus"` + + // The status message. + StatusMessage *string `locationName:"statusMessage" type:"string"` + + // The tags. + Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` + + // The warning message. + WarningMessage *string `locationName:"warningMessage" 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 NetworkInsightsAccessScopeAnalysis) 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 NetworkInsightsAccessScopeAnalysis) GoString() string { + return s.String() +} + +// SetAnalyzedEniCount sets the AnalyzedEniCount field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetAnalyzedEniCount(v int64) *NetworkInsightsAccessScopeAnalysis { + s.AnalyzedEniCount = &v + return s +} + +// SetEndDate sets the EndDate field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetEndDate(v time.Time) *NetworkInsightsAccessScopeAnalysis { + s.EndDate = &v + return s +} + +// SetFindingsFound sets the FindingsFound field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetFindingsFound(v string) *NetworkInsightsAccessScopeAnalysis { + s.FindingsFound = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisArn sets the NetworkInsightsAccessScopeAnalysisArn field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetNetworkInsightsAccessScopeAnalysisArn(v string) *NetworkInsightsAccessScopeAnalysis { + s.NetworkInsightsAccessScopeAnalysisArn = &v + return s +} + +// SetNetworkInsightsAccessScopeAnalysisId sets the NetworkInsightsAccessScopeAnalysisId field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetNetworkInsightsAccessScopeAnalysisId(v string) *NetworkInsightsAccessScopeAnalysis { + s.NetworkInsightsAccessScopeAnalysisId = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetNetworkInsightsAccessScopeId(v string) *NetworkInsightsAccessScopeAnalysis { + s.NetworkInsightsAccessScopeId = &v + return s +} + +// SetStartDate sets the StartDate field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetStartDate(v time.Time) *NetworkInsightsAccessScopeAnalysis { + s.StartDate = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetStatus(v string) *NetworkInsightsAccessScopeAnalysis { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetStatusMessage(v string) *NetworkInsightsAccessScopeAnalysis { + s.StatusMessage = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetTags(v []*Tag) *NetworkInsightsAccessScopeAnalysis { + s.Tags = v + return s +} + +// SetWarningMessage sets the WarningMessage field's value. +func (s *NetworkInsightsAccessScopeAnalysis) SetWarningMessage(v string) *NetworkInsightsAccessScopeAnalysis { + s.WarningMessage = &v + return s +} + +// Describes the Network Access Scope content. +type NetworkInsightsAccessScopeContent struct { + _ struct{} `type:"structure"` + + // The paths to exclude. + ExcludePaths []*AccessScopePath `locationName:"excludePathSet" locationNameList:"item" type:"list"` + + // The paths to match. + MatchPaths []*AccessScopePath `locationName:"matchPathSet" locationNameList:"item" type:"list"` + + // The ID of the Network Access Scope. + NetworkInsightsAccessScopeId *string `locationName:"networkInsightsAccessScopeId" 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 NetworkInsightsAccessScopeContent) 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 NetworkInsightsAccessScopeContent) GoString() string { + return s.String() +} + +// SetExcludePaths sets the ExcludePaths field's value. +func (s *NetworkInsightsAccessScopeContent) SetExcludePaths(v []*AccessScopePath) *NetworkInsightsAccessScopeContent { + s.ExcludePaths = v + return s +} + +// SetMatchPaths sets the MatchPaths field's value. +func (s *NetworkInsightsAccessScopeContent) SetMatchPaths(v []*AccessScopePath) *NetworkInsightsAccessScopeContent { + s.MatchPaths = v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *NetworkInsightsAccessScopeContent) SetNetworkInsightsAccessScopeId(v string) *NetworkInsightsAccessScopeContent { + s.NetworkInsightsAccessScopeId = &v + return s +} + // Describes a network insights analysis. type NetworkInsightsAnalysis struct { _ struct{} `type:"structure"` @@ -121525,6 +130370,9 @@ type NetworkInsightsAnalysis struct { // The tags. Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"` + + // The warning message. + WarningMessage *string `locationName:"warningMessage" type:"string"` } // String returns the string representation. @@ -121623,6 +130471,12 @@ func (s *NetworkInsightsAnalysis) SetTags(v []*Tag) *NetworkInsightsAnalysis { return s } +// SetWarningMessage sets the WarningMessage field's value. +func (s *NetworkInsightsAnalysis) SetWarningMessage(v string) *NetworkInsightsAnalysis { + s.WarningMessage = &v + return s +} + // Describes a path. type NetworkInsightsPath struct { _ struct{} `type:"structure"` @@ -122767,6 +131621,178 @@ func (s *OnDemandOptionsRequest) SetSingleInstanceType(v bool) *OnDemandOptionsR return s } +// Describes a packet header statement. +type PacketHeaderStatement struct { + _ struct{} `type:"structure"` + + // The destination addresses. + DestinationAddresses []*string `locationName:"destinationAddressSet" locationNameList:"item" type:"list"` + + // The destination ports. + DestinationPorts []*string `locationName:"destinationPortSet" locationNameList:"item" type:"list"` + + // The destination prefix lists. + DestinationPrefixLists []*string `locationName:"destinationPrefixListSet" locationNameList:"item" type:"list"` + + // The protocols. + Protocols []*string `locationName:"protocolSet" locationNameList:"item" type:"list"` + + // The source addresses. + SourceAddresses []*string `locationName:"sourceAddressSet" locationNameList:"item" type:"list"` + + // The source ports. + SourcePorts []*string `locationName:"sourcePortSet" locationNameList:"item" type:"list"` + + // The source prefix lists. + SourcePrefixLists []*string `locationName:"sourcePrefixListSet" locationNameList:"item" 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 PacketHeaderStatement) 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 PacketHeaderStatement) GoString() string { + return s.String() +} + +// SetDestinationAddresses sets the DestinationAddresses field's value. +func (s *PacketHeaderStatement) SetDestinationAddresses(v []*string) *PacketHeaderStatement { + s.DestinationAddresses = v + return s +} + +// SetDestinationPorts sets the DestinationPorts field's value. +func (s *PacketHeaderStatement) SetDestinationPorts(v []*string) *PacketHeaderStatement { + s.DestinationPorts = v + return s +} + +// SetDestinationPrefixLists sets the DestinationPrefixLists field's value. +func (s *PacketHeaderStatement) SetDestinationPrefixLists(v []*string) *PacketHeaderStatement { + s.DestinationPrefixLists = v + return s +} + +// SetProtocols sets the Protocols field's value. +func (s *PacketHeaderStatement) SetProtocols(v []*string) *PacketHeaderStatement { + s.Protocols = v + return s +} + +// SetSourceAddresses sets the SourceAddresses field's value. +func (s *PacketHeaderStatement) SetSourceAddresses(v []*string) *PacketHeaderStatement { + s.SourceAddresses = v + return s +} + +// SetSourcePorts sets the SourcePorts field's value. +func (s *PacketHeaderStatement) SetSourcePorts(v []*string) *PacketHeaderStatement { + s.SourcePorts = v + return s +} + +// SetSourcePrefixLists sets the SourcePrefixLists field's value. +func (s *PacketHeaderStatement) SetSourcePrefixLists(v []*string) *PacketHeaderStatement { + s.SourcePrefixLists = v + return s +} + +// Describes a packet header statement. +type PacketHeaderStatementRequest struct { + _ struct{} `type:"structure"` + + // The destination addresses. + DestinationAddresses []*string `locationName:"DestinationAddress" locationNameList:"item" type:"list"` + + // The destination ports. + DestinationPorts []*string `locationName:"DestinationPort" locationNameList:"item" type:"list"` + + // The destination prefix lists. + DestinationPrefixLists []*string `locationName:"DestinationPrefixList" locationNameList:"item" type:"list"` + + // The protocols. + Protocols []*string `locationName:"Protocol" locationNameList:"item" type:"list"` + + // The source addresses. + SourceAddresses []*string `locationName:"SourceAddress" locationNameList:"item" type:"list"` + + // The source ports. + SourcePorts []*string `locationName:"SourcePort" locationNameList:"item" type:"list"` + + // The source prefix lists. + SourcePrefixLists []*string `locationName:"SourcePrefixList" locationNameList:"item" 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 PacketHeaderStatementRequest) 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 PacketHeaderStatementRequest) GoString() string { + return s.String() +} + +// SetDestinationAddresses sets the DestinationAddresses field's value. +func (s *PacketHeaderStatementRequest) SetDestinationAddresses(v []*string) *PacketHeaderStatementRequest { + s.DestinationAddresses = v + return s +} + +// SetDestinationPorts sets the DestinationPorts field's value. +func (s *PacketHeaderStatementRequest) SetDestinationPorts(v []*string) *PacketHeaderStatementRequest { + s.DestinationPorts = v + return s +} + +// SetDestinationPrefixLists sets the DestinationPrefixLists field's value. +func (s *PacketHeaderStatementRequest) SetDestinationPrefixLists(v []*string) *PacketHeaderStatementRequest { + s.DestinationPrefixLists = v + return s +} + +// SetProtocols sets the Protocols field's value. +func (s *PacketHeaderStatementRequest) SetProtocols(v []*string) *PacketHeaderStatementRequest { + s.Protocols = v + return s +} + +// SetSourceAddresses sets the SourceAddresses field's value. +func (s *PacketHeaderStatementRequest) SetSourceAddresses(v []*string) *PacketHeaderStatementRequest { + s.SourceAddresses = v + return s +} + +// SetSourcePorts sets the SourcePorts field's value. +func (s *PacketHeaderStatementRequest) SetSourcePorts(v []*string) *PacketHeaderStatementRequest { + s.SourcePorts = v + return s +} + +// SetSourcePrefixLists sets the SourcePrefixLists field's value. +func (s *PacketHeaderStatementRequest) SetSourcePrefixLists(v []*string) *PacketHeaderStatementRequest { + s.SourcePrefixLists = v + return s +} + // Describes a path component. type PathComponent struct { _ struct{} `type:"structure"` @@ -122774,6 +131800,9 @@ type PathComponent struct { // The network ACL rule. AclRule *AnalysisAclRule `locationName:"aclRule" type:"structure"` + // The resource to which the path component is attached. + AttachedTo *AnalysisComponent `locationName:"attachedTo" type:"structure"` + // The component. Component *AnalysisComponent `locationName:"component" type:"structure"` @@ -122829,6 +131858,12 @@ func (s *PathComponent) SetAclRule(v *AnalysisAclRule) *PathComponent { return s } +// SetAttachedTo sets the AttachedTo field's value. +func (s *PathComponent) SetAttachedTo(v *AnalysisComponent) *PathComponent { + s.AttachedTo = v + return s +} + // SetComponent sets the Component field's value. func (s *PathComponent) SetComponent(v *AnalysisComponent) *PathComponent { s.Component = v @@ -122889,6 +131924,88 @@ func (s *PathComponent) SetVpc(v *AnalysisComponent) *PathComponent { return s } +// Describes a path statement. +type PathStatement struct { + _ struct{} `type:"structure"` + + // The packet header statement. + PacketHeaderStatement *PacketHeaderStatement `locationName:"packetHeaderStatement" type:"structure"` + + // The resource statement. + ResourceStatement *ResourceStatement `locationName:"resourceStatement" 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 PathStatement) 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 PathStatement) GoString() string { + return s.String() +} + +// SetPacketHeaderStatement sets the PacketHeaderStatement field's value. +func (s *PathStatement) SetPacketHeaderStatement(v *PacketHeaderStatement) *PathStatement { + s.PacketHeaderStatement = v + return s +} + +// SetResourceStatement sets the ResourceStatement field's value. +func (s *PathStatement) SetResourceStatement(v *ResourceStatement) *PathStatement { + s.ResourceStatement = v + return s +} + +// Describes a path statement. +type PathStatementRequest struct { + _ struct{} `type:"structure"` + + // The packet header statement. + PacketHeaderStatement *PacketHeaderStatementRequest `type:"structure"` + + // The resource statement. + ResourceStatement *ResourceStatementRequest `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 PathStatementRequest) 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 PathStatementRequest) GoString() string { + return s.String() +} + +// SetPacketHeaderStatement sets the PacketHeaderStatement field's value. +func (s *PathStatementRequest) SetPacketHeaderStatement(v *PacketHeaderStatementRequest) *PathStatementRequest { + s.PacketHeaderStatement = v + return s +} + +// SetResourceStatement sets the ResourceStatement field's value. +func (s *PathStatementRequest) SetResourceStatement(v *ResourceStatementRequest) *PathStatementRequest { + s.ResourceStatement = v + return s +} + // Describes the data that identifies an Amazon FPGA image (AFI) on the PCI // bus. type PciId struct { @@ -124817,6 +133934,242 @@ func (s *ProvisionByoipCidrOutput) SetByoipCidr(v *ByoipCidr) *ProvisionByoipCid return s } +type ProvisionIpamPoolCidrInput struct { + _ struct{} `type:"structure"` + + // The CIDR you want to assign to the IPAM pool. + Cidr *string `type:"string"` + + // A signed document that proves that you are authorized to bring a specified + // IP address range to Amazon using BYOIP. This option applies to public pools + // only. + CidrAuthorizationContext *IpamCidrAuthorizationContext `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM pool to which you want to assign a CIDR. + // + // IpamPoolId is a required field + IpamPoolId *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 ProvisionIpamPoolCidrInput) 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 ProvisionIpamPoolCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProvisionIpamPoolCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProvisionIpamPoolCidrInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *ProvisionIpamPoolCidrInput) SetCidr(v string) *ProvisionIpamPoolCidrInput { + s.Cidr = &v + return s +} + +// SetCidrAuthorizationContext sets the CidrAuthorizationContext field's value. +func (s *ProvisionIpamPoolCidrInput) SetCidrAuthorizationContext(v *IpamCidrAuthorizationContext) *ProvisionIpamPoolCidrInput { + s.CidrAuthorizationContext = v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ProvisionIpamPoolCidrInput) SetDryRun(v bool) *ProvisionIpamPoolCidrInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *ProvisionIpamPoolCidrInput) SetIpamPoolId(v string) *ProvisionIpamPoolCidrInput { + s.IpamPoolId = &v + return s +} + +type ProvisionIpamPoolCidrOutput struct { + _ struct{} `type:"structure"` + + // Information about the provisioned CIDR. + IpamPoolCidr *IpamPoolCidr `locationName:"ipamPoolCidr" 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 ProvisionIpamPoolCidrOutput) 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 ProvisionIpamPoolCidrOutput) GoString() string { + return s.String() +} + +// SetIpamPoolCidr sets the IpamPoolCidr field's value. +func (s *ProvisionIpamPoolCidrOutput) SetIpamPoolCidr(v *IpamPoolCidr) *ProvisionIpamPoolCidrOutput { + s.IpamPoolCidr = v + return s +} + +type ProvisionPublicIpv4PoolCidrInput struct { + _ struct{} `type:"structure"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the IPAM pool you would like to use to allocate this CIDR. + // + // IpamPoolId is a required field + IpamPoolId *string `type:"string" required:"true"` + + // The netmask length of the CIDR you would like to allocate to the public IPv4 + // pool. + // + // NetmaskLength is a required field + NetmaskLength *int64 `type:"integer" required:"true"` + + // The ID of the public IPv4 pool you would like to use for this CIDR. + // + // PoolId is a required field + PoolId *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 ProvisionPublicIpv4PoolCidrInput) 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 ProvisionPublicIpv4PoolCidrInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProvisionPublicIpv4PoolCidrInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProvisionPublicIpv4PoolCidrInput"} + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + if s.NetmaskLength == nil { + invalidParams.Add(request.NewErrParamRequired("NetmaskLength")) + } + if s.PoolId == nil { + invalidParams.Add(request.NewErrParamRequired("PoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDryRun sets the DryRun field's value. +func (s *ProvisionPublicIpv4PoolCidrInput) SetDryRun(v bool) *ProvisionPublicIpv4PoolCidrInput { + s.DryRun = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *ProvisionPublicIpv4PoolCidrInput) SetIpamPoolId(v string) *ProvisionPublicIpv4PoolCidrInput { + s.IpamPoolId = &v + return s +} + +// SetNetmaskLength sets the NetmaskLength field's value. +func (s *ProvisionPublicIpv4PoolCidrInput) SetNetmaskLength(v int64) *ProvisionPublicIpv4PoolCidrInput { + s.NetmaskLength = &v + return s +} + +// SetPoolId sets the PoolId field's value. +func (s *ProvisionPublicIpv4PoolCidrInput) SetPoolId(v string) *ProvisionPublicIpv4PoolCidrInput { + s.PoolId = &v + return s +} + +type ProvisionPublicIpv4PoolCidrOutput struct { + _ struct{} `type:"structure"` + + // Describes an address range of an IPv4 address pool. + PoolAddressRange *PublicIpv4PoolRange `locationName:"poolAddressRange" type:"structure"` + + // The ID of the pool that you want to provision the CIDR to. + PoolId *string `locationName:"poolId" 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 ProvisionPublicIpv4PoolCidrOutput) 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 ProvisionPublicIpv4PoolCidrOutput) GoString() string { + return s.String() +} + +// SetPoolAddressRange sets the PoolAddressRange field's value. +func (s *ProvisionPublicIpv4PoolCidrOutput) SetPoolAddressRange(v *PublicIpv4PoolRange) *ProvisionPublicIpv4PoolCidrOutput { + s.PoolAddressRange = v + return s +} + +// SetPoolId sets the PoolId field's value. +func (s *ProvisionPublicIpv4PoolCidrOutput) SetPoolId(v string) *ProvisionPublicIpv4PoolCidrOutput { + s.PoolId = &v + return s +} + // Reserved. If you need to sustain traffic greater than the documented limits // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), // contact us through the Support Center (https://console.aws.amazon.com/support/home?). @@ -127085,6 +136438,156 @@ func (s *ReleaseHostsOutput) SetUnsuccessful(v []*UnsuccessfulItem) *ReleaseHost return s } +type ReleaseIpamPoolAllocationInput struct { + _ struct{} `type:"structure"` + + // The CIDR of the allocation you want to release. + // + // Cidr is a required field + Cidr *string `type:"string" required:"true"` + + // A check for whether you have the required permissions for the action without + // actually making the request and provides an error response. If you have the + // required permissions, the error response is DryRunOperation. Otherwise, it + // is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the allocation. + IpamPoolAllocationId *string `type:"string"` + + // The ID of the IPAM pool which contains the allocation you want to release. + // + // IpamPoolId is a required field + IpamPoolId *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 ReleaseIpamPoolAllocationInput) 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 ReleaseIpamPoolAllocationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ReleaseIpamPoolAllocationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ReleaseIpamPoolAllocationInput"} + if s.Cidr == nil { + invalidParams.Add(request.NewErrParamRequired("Cidr")) + } + if s.IpamPoolId == nil { + invalidParams.Add(request.NewErrParamRequired("IpamPoolId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCidr sets the Cidr field's value. +func (s *ReleaseIpamPoolAllocationInput) SetCidr(v string) *ReleaseIpamPoolAllocationInput { + s.Cidr = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *ReleaseIpamPoolAllocationInput) SetDryRun(v bool) *ReleaseIpamPoolAllocationInput { + s.DryRun = &v + return s +} + +// SetIpamPoolAllocationId sets the IpamPoolAllocationId field's value. +func (s *ReleaseIpamPoolAllocationInput) SetIpamPoolAllocationId(v string) *ReleaseIpamPoolAllocationInput { + s.IpamPoolAllocationId = &v + return s +} + +// SetIpamPoolId sets the IpamPoolId field's value. +func (s *ReleaseIpamPoolAllocationInput) SetIpamPoolId(v string) *ReleaseIpamPoolAllocationInput { + s.IpamPoolId = &v + return s +} + +type ReleaseIpamPoolAllocationOutput struct { + _ struct{} `type:"structure"` + + // Indicates if the release was successful. + Success *bool `locationName:"success" type:"boolean"` +} + +// 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 ReleaseIpamPoolAllocationOutput) 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 ReleaseIpamPoolAllocationOutput) GoString() string { + return s.String() +} + +// SetSuccess sets the Success field's value. +func (s *ReleaseIpamPoolAllocationOutput) SetSuccess(v bool) *ReleaseIpamPoolAllocationOutput { + s.Success = &v + return s +} + +// Remove an operating Region from an IPAM. Operating Regions are Amazon Web +// Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM +// only discovers and monitors resources in the Amazon Web Services Regions +// you select as operating Regions. +// +// For more information about operating Regions, see Create an IPAM (/vpc/latest/ipam/create-ipam.html) +// in the Amazon VPC IPAM User Guide +type RemoveIpamOperatingRegion struct { + _ struct{} `type:"structure"` + + // The name of the operating Region you want to remove. + RegionName *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 RemoveIpamOperatingRegion) 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 RemoveIpamOperatingRegion) GoString() string { + return s.String() +} + +// SetRegionName sets the RegionName field's value. +func (s *RemoveIpamOperatingRegion) SetRegionName(v string) *RemoveIpamOperatingRegion { + s.RegionName = &v + return s +} + // An entry for a prefix list. type RemovePrefixListEntry struct { _ struct{} `type:"structure"` @@ -128212,6 +137715,48 @@ func (s ReportInstanceStatusOutput) GoString() string { return s.String() } +// A tag on an IPAM resource. +type RequestIpamResourceTag struct { + _ struct{} `type:"structure"` + + // The key of a tag assigned to the resource. Use this filter to find all resources + // assigned a tag with a specific key, regardless of the tag value. + Key *string `type:"string"` + + // The value for the tag. + Value *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 RequestIpamResourceTag) 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 RequestIpamResourceTag) GoString() string { + return s.String() +} + +// SetKey sets the Key field's value. +func (s *RequestIpamResourceTag) SetKey(v string) *RequestIpamResourceTag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *RequestIpamResourceTag) SetValue(v string) *RequestIpamResourceTag { + s.Value = &v + return s +} + // The information to include in the launch template. type RequestLaunchTemplateData struct { _ struct{} `type:"structure"` @@ -130821,6 +140366,88 @@ func (s ResetSnapshotAttributeOutput) GoString() string { return s.String() } +// Describes a resource statement. +type ResourceStatement struct { + _ struct{} `type:"structure"` + + // The resource types. + ResourceTypes []*string `locationName:"resourceTypeSet" locationNameList:"item" type:"list"` + + // The resources. + Resources []*string `locationName:"resourceSet" locationNameList:"item" 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 ResourceStatement) 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 ResourceStatement) GoString() string { + return s.String() +} + +// SetResourceTypes sets the ResourceTypes field's value. +func (s *ResourceStatement) SetResourceTypes(v []*string) *ResourceStatement { + s.ResourceTypes = v + return s +} + +// SetResources sets the Resources field's value. +func (s *ResourceStatement) SetResources(v []*string) *ResourceStatement { + s.Resources = v + return s +} + +// Describes a resource statement. +type ResourceStatementRequest struct { + _ struct{} `type:"structure"` + + // The resource types. + ResourceTypes []*string `locationName:"ResourceType" locationNameList:"item" type:"list"` + + // The resources. + Resources []*string `locationName:"Resource" locationNameList:"item" 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 ResourceStatementRequest) 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 ResourceStatementRequest) GoString() string { + return s.String() +} + +// SetResourceTypes sets the ResourceTypes field's value. +func (s *ResourceStatementRequest) SetResourceTypes(v []*string) *ResourceStatementRequest { + s.ResourceTypes = v + return s +} + +// SetResources sets the Resources field's value. +func (s *ResourceStatementRequest) SetResources(v []*string) *ResourceStatementRequest { + s.Resources = v + return s +} + // Describes the error that's returned when you cannot delete a launch template // version. type ResponseError struct { @@ -138855,6 +148482,114 @@ func (s *StartInstancesOutput) SetStartingInstances(v []*InstanceStateChange) *S return s } +type StartNetworkInsightsAccessScopeAnalysisInput struct { + _ struct{} `type:"structure"` + + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + ClientToken *string `type:"string" idempotencyToken:"true"` + + // Checks whether you have the required permissions for the action, without + // actually making the request, and provides an error response. If you have + // the required permissions, the error response is DryRunOperation. Otherwise, + // it is UnauthorizedOperation. + DryRun *bool `type:"boolean"` + + // The ID of the Network Access Scope. + // + // NetworkInsightsAccessScopeId is a required field + NetworkInsightsAccessScopeId *string `type:"string" required:"true"` + + // The tags to apply. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" 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 StartNetworkInsightsAccessScopeAnalysisInput) 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 StartNetworkInsightsAccessScopeAnalysisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartNetworkInsightsAccessScopeAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartNetworkInsightsAccessScopeAnalysisInput"} + if s.NetworkInsightsAccessScopeId == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkInsightsAccessScopeId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartNetworkInsightsAccessScopeAnalysisInput) SetClientToken(v string) *StartNetworkInsightsAccessScopeAnalysisInput { + s.ClientToken = &v + return s +} + +// SetDryRun sets the DryRun field's value. +func (s *StartNetworkInsightsAccessScopeAnalysisInput) SetDryRun(v bool) *StartNetworkInsightsAccessScopeAnalysisInput { + s.DryRun = &v + return s +} + +// SetNetworkInsightsAccessScopeId sets the NetworkInsightsAccessScopeId field's value. +func (s *StartNetworkInsightsAccessScopeAnalysisInput) SetNetworkInsightsAccessScopeId(v string) *StartNetworkInsightsAccessScopeAnalysisInput { + s.NetworkInsightsAccessScopeId = &v + return s +} + +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *StartNetworkInsightsAccessScopeAnalysisInput) SetTagSpecifications(v []*TagSpecification) *StartNetworkInsightsAccessScopeAnalysisInput { + s.TagSpecifications = v + return s +} + +type StartNetworkInsightsAccessScopeAnalysisOutput struct { + _ struct{} `type:"structure"` + + // The Network Access Scope analysis. + NetworkInsightsAccessScopeAnalysis *NetworkInsightsAccessScopeAnalysis `locationName:"networkInsightsAccessScopeAnalysis" 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 StartNetworkInsightsAccessScopeAnalysisOutput) 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 StartNetworkInsightsAccessScopeAnalysisOutput) GoString() string { + return s.String() +} + +// SetNetworkInsightsAccessScopeAnalysis sets the NetworkInsightsAccessScopeAnalysis field's value. +func (s *StartNetworkInsightsAccessScopeAnalysisOutput) SetNetworkInsightsAccessScopeAnalysis(v *NetworkInsightsAccessScopeAnalysis) *StartNetworkInsightsAccessScopeAnalysisOutput { + s.NetworkInsightsAccessScopeAnalysis = v + return s +} + type StartNetworkInsightsAnalysisInput struct { _ struct{} `type:"structure"` @@ -140820,6 +150555,70 @@ func (s *TerminateInstancesOutput) SetTerminatingInstances(v []*InstanceStateCha return s } +// Describes a through resource statement. +type ThroughResourcesStatement struct { + _ struct{} `type:"structure"` + + // The resource statement. + ResourceStatement *ResourceStatement `locationName:"resourceStatement" 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 ThroughResourcesStatement) 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 ThroughResourcesStatement) GoString() string { + return s.String() +} + +// SetResourceStatement sets the ResourceStatement field's value. +func (s *ThroughResourcesStatement) SetResourceStatement(v *ResourceStatement) *ThroughResourcesStatement { + s.ResourceStatement = v + return s +} + +// Describes a through resource statement. +type ThroughResourcesStatementRequest struct { + _ struct{} `type:"structure"` + + // The resource statement. + ResourceStatement *ResourceStatementRequest `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 ThroughResourcesStatementRequest) 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 ThroughResourcesStatementRequest) GoString() string { + return s.String() +} + +// SetResourceStatement sets the ResourceStatement field's value. +func (s *ThroughResourcesStatementRequest) SetResourceStatement(v *ResourceStatementRequest) *ThroughResourcesStatementRequest { + s.ResourceStatement = v + return s +} + // The minimum and maximum amount of total local storage, in GB. type TotalLocalStorageGB struct { _ struct{} `type:"structure"` @@ -147997,6 +157796,22 @@ func AddressAttributeName_Values() []string { } } +const ( + // AddressFamilyIpv4 is a AddressFamily enum value + AddressFamilyIpv4 = "ipv4" + + // AddressFamilyIpv6 is a AddressFamily enum value + AddressFamilyIpv6 = "ipv6" +) + +// AddressFamily_Values returns all elements of the AddressFamily enum +func AddressFamily_Values() []string { + return []string{ + AddressFamilyIpv4, + AddressFamilyIpv6, + } +} + const ( // AffinityDefault is a Affinity enum value AffinityDefault = "default" @@ -149537,6 +159352,26 @@ func FastSnapshotRestoreStateCode_Values() []string { } } +const ( + // FindingsFoundTrue is a FindingsFound enum value + FindingsFoundTrue = "true" + + // FindingsFoundFalse is a FindingsFound enum value + FindingsFoundFalse = "false" + + // FindingsFoundUnknown is a FindingsFound enum value + FindingsFoundUnknown = "unknown" +) + +// FindingsFound_Values returns all elements of the FindingsFound enum +func FindingsFound_Values() []string { + return []string{ + FindingsFoundTrue, + FindingsFoundFalse, + FindingsFoundUnknown, + } +} + const ( // FleetActivityStatusError is a FleetActivityStatus enum value FleetActivityStatusError = "error" @@ -152249,6 +162084,362 @@ func InterfaceProtocolType_Values() []string { } } +const ( + // IpamAddressHistoryResourceTypeEip is a IpamAddressHistoryResourceType enum value + IpamAddressHistoryResourceTypeEip = "eip" + + // IpamAddressHistoryResourceTypeVpc is a IpamAddressHistoryResourceType enum value + IpamAddressHistoryResourceTypeVpc = "vpc" + + // IpamAddressHistoryResourceTypeSubnet is a IpamAddressHistoryResourceType enum value + IpamAddressHistoryResourceTypeSubnet = "subnet" + + // IpamAddressHistoryResourceTypeNetworkInterface is a IpamAddressHistoryResourceType enum value + IpamAddressHistoryResourceTypeNetworkInterface = "network-interface" + + // IpamAddressHistoryResourceTypeInstance is a IpamAddressHistoryResourceType enum value + IpamAddressHistoryResourceTypeInstance = "instance" +) + +// IpamAddressHistoryResourceType_Values returns all elements of the IpamAddressHistoryResourceType enum +func IpamAddressHistoryResourceType_Values() []string { + return []string{ + IpamAddressHistoryResourceTypeEip, + IpamAddressHistoryResourceTypeVpc, + IpamAddressHistoryResourceTypeSubnet, + IpamAddressHistoryResourceTypeNetworkInterface, + IpamAddressHistoryResourceTypeInstance, + } +} + +const ( + // IpamComplianceStatusCompliant is a IpamComplianceStatus enum value + IpamComplianceStatusCompliant = "compliant" + + // IpamComplianceStatusNoncompliant is a IpamComplianceStatus enum value + IpamComplianceStatusNoncompliant = "noncompliant" + + // IpamComplianceStatusUnmanaged is a IpamComplianceStatus enum value + IpamComplianceStatusUnmanaged = "unmanaged" + + // IpamComplianceStatusIgnored is a IpamComplianceStatus enum value + IpamComplianceStatusIgnored = "ignored" +) + +// IpamComplianceStatus_Values returns all elements of the IpamComplianceStatus enum +func IpamComplianceStatus_Values() []string { + return []string{ + IpamComplianceStatusCompliant, + IpamComplianceStatusNoncompliant, + IpamComplianceStatusUnmanaged, + IpamComplianceStatusIgnored, + } +} + +const ( + // IpamManagementStateManaged is a IpamManagementState enum value + IpamManagementStateManaged = "managed" + + // IpamManagementStateUnmanaged is a IpamManagementState enum value + IpamManagementStateUnmanaged = "unmanaged" + + // IpamManagementStateIgnored is a IpamManagementState enum value + IpamManagementStateIgnored = "ignored" +) + +// IpamManagementState_Values returns all elements of the IpamManagementState enum +func IpamManagementState_Values() []string { + return []string{ + IpamManagementStateManaged, + IpamManagementStateUnmanaged, + IpamManagementStateIgnored, + } +} + +const ( + // IpamOverlapStatusOverlapping is a IpamOverlapStatus enum value + IpamOverlapStatusOverlapping = "overlapping" + + // IpamOverlapStatusNonoverlapping is a IpamOverlapStatus enum value + IpamOverlapStatusNonoverlapping = "nonoverlapping" + + // IpamOverlapStatusIgnored is a IpamOverlapStatus enum value + IpamOverlapStatusIgnored = "ignored" +) + +// IpamOverlapStatus_Values returns all elements of the IpamOverlapStatus enum +func IpamOverlapStatus_Values() []string { + return []string{ + IpamOverlapStatusOverlapping, + IpamOverlapStatusNonoverlapping, + IpamOverlapStatusIgnored, + } +} + +const ( + // IpamPoolAllocationResourceTypeIpamPool is a IpamPoolAllocationResourceType enum value + IpamPoolAllocationResourceTypeIpamPool = "ipam-pool" + + // IpamPoolAllocationResourceTypeVpc is a IpamPoolAllocationResourceType enum value + IpamPoolAllocationResourceTypeVpc = "vpc" + + // IpamPoolAllocationResourceTypeEc2PublicIpv4Pool is a IpamPoolAllocationResourceType enum value + IpamPoolAllocationResourceTypeEc2PublicIpv4Pool = "ec2-public-ipv4-pool" + + // IpamPoolAllocationResourceTypeCustom is a IpamPoolAllocationResourceType enum value + IpamPoolAllocationResourceTypeCustom = "custom" +) + +// IpamPoolAllocationResourceType_Values returns all elements of the IpamPoolAllocationResourceType enum +func IpamPoolAllocationResourceType_Values() []string { + return []string{ + IpamPoolAllocationResourceTypeIpamPool, + IpamPoolAllocationResourceTypeVpc, + IpamPoolAllocationResourceTypeEc2PublicIpv4Pool, + IpamPoolAllocationResourceTypeCustom, + } +} + +const ( + // IpamPoolAwsServiceEc2 is a IpamPoolAwsService enum value + IpamPoolAwsServiceEc2 = "ec2" +) + +// IpamPoolAwsService_Values returns all elements of the IpamPoolAwsService enum +func IpamPoolAwsService_Values() []string { + return []string{ + IpamPoolAwsServiceEc2, + } +} + +const ( + // IpamPoolCidrFailureCodeCidrNotAvailable is a IpamPoolCidrFailureCode enum value + IpamPoolCidrFailureCodeCidrNotAvailable = "cidr-not-available" +) + +// IpamPoolCidrFailureCode_Values returns all elements of the IpamPoolCidrFailureCode enum +func IpamPoolCidrFailureCode_Values() []string { + return []string{ + IpamPoolCidrFailureCodeCidrNotAvailable, + } +} + +const ( + // IpamPoolCidrStatePendingProvision is a IpamPoolCidrState enum value + IpamPoolCidrStatePendingProvision = "pending-provision" + + // IpamPoolCidrStateProvisioned is a IpamPoolCidrState enum value + IpamPoolCidrStateProvisioned = "provisioned" + + // IpamPoolCidrStateFailedProvision is a IpamPoolCidrState enum value + IpamPoolCidrStateFailedProvision = "failed-provision" + + // IpamPoolCidrStatePendingDeprovision is a IpamPoolCidrState enum value + IpamPoolCidrStatePendingDeprovision = "pending-deprovision" + + // IpamPoolCidrStateDeprovisioned is a IpamPoolCidrState enum value + IpamPoolCidrStateDeprovisioned = "deprovisioned" + + // IpamPoolCidrStateFailedDeprovision is a IpamPoolCidrState enum value + IpamPoolCidrStateFailedDeprovision = "failed-deprovision" + + // IpamPoolCidrStatePendingImport is a IpamPoolCidrState enum value + IpamPoolCidrStatePendingImport = "pending-import" + + // IpamPoolCidrStateFailedImport is a IpamPoolCidrState enum value + IpamPoolCidrStateFailedImport = "failed-import" +) + +// IpamPoolCidrState_Values returns all elements of the IpamPoolCidrState enum +func IpamPoolCidrState_Values() []string { + return []string{ + IpamPoolCidrStatePendingProvision, + IpamPoolCidrStateProvisioned, + IpamPoolCidrStateFailedProvision, + IpamPoolCidrStatePendingDeprovision, + IpamPoolCidrStateDeprovisioned, + IpamPoolCidrStateFailedDeprovision, + IpamPoolCidrStatePendingImport, + IpamPoolCidrStateFailedImport, + } +} + +const ( + // IpamPoolStateCreateInProgress is a IpamPoolState enum value + IpamPoolStateCreateInProgress = "create-in-progress" + + // IpamPoolStateCreateComplete is a IpamPoolState enum value + IpamPoolStateCreateComplete = "create-complete" + + // IpamPoolStateCreateFailed is a IpamPoolState enum value + IpamPoolStateCreateFailed = "create-failed" + + // IpamPoolStateModifyInProgress is a IpamPoolState enum value + IpamPoolStateModifyInProgress = "modify-in-progress" + + // IpamPoolStateModifyComplete is a IpamPoolState enum value + IpamPoolStateModifyComplete = "modify-complete" + + // IpamPoolStateModifyFailed is a IpamPoolState enum value + IpamPoolStateModifyFailed = "modify-failed" + + // IpamPoolStateDeleteInProgress is a IpamPoolState enum value + IpamPoolStateDeleteInProgress = "delete-in-progress" + + // IpamPoolStateDeleteComplete is a IpamPoolState enum value + IpamPoolStateDeleteComplete = "delete-complete" + + // IpamPoolStateDeleteFailed is a IpamPoolState enum value + IpamPoolStateDeleteFailed = "delete-failed" +) + +// IpamPoolState_Values returns all elements of the IpamPoolState enum +func IpamPoolState_Values() []string { + return []string{ + IpamPoolStateCreateInProgress, + IpamPoolStateCreateComplete, + IpamPoolStateCreateFailed, + IpamPoolStateModifyInProgress, + IpamPoolStateModifyComplete, + IpamPoolStateModifyFailed, + IpamPoolStateDeleteInProgress, + IpamPoolStateDeleteComplete, + IpamPoolStateDeleteFailed, + } +} + +const ( + // IpamResourceTypeVpc is a IpamResourceType enum value + IpamResourceTypeVpc = "vpc" + + // IpamResourceTypeSubnet is a IpamResourceType enum value + IpamResourceTypeSubnet = "subnet" + + // IpamResourceTypeEip is a IpamResourceType enum value + IpamResourceTypeEip = "eip" + + // IpamResourceTypePublicIpv4Pool is a IpamResourceType enum value + IpamResourceTypePublicIpv4Pool = "public-ipv4-pool" + + // IpamResourceTypeIpv6Pool is a IpamResourceType enum value + IpamResourceTypeIpv6Pool = "ipv6-pool" +) + +// IpamResourceType_Values returns all elements of the IpamResourceType enum +func IpamResourceType_Values() []string { + return []string{ + IpamResourceTypeVpc, + IpamResourceTypeSubnet, + IpamResourceTypeEip, + IpamResourceTypePublicIpv4Pool, + IpamResourceTypeIpv6Pool, + } +} + +const ( + // IpamScopeStateCreateInProgress is a IpamScopeState enum value + IpamScopeStateCreateInProgress = "create-in-progress" + + // IpamScopeStateCreateComplete is a IpamScopeState enum value + IpamScopeStateCreateComplete = "create-complete" + + // IpamScopeStateCreateFailed is a IpamScopeState enum value + IpamScopeStateCreateFailed = "create-failed" + + // IpamScopeStateModifyInProgress is a IpamScopeState enum value + IpamScopeStateModifyInProgress = "modify-in-progress" + + // IpamScopeStateModifyComplete is a IpamScopeState enum value + IpamScopeStateModifyComplete = "modify-complete" + + // IpamScopeStateModifyFailed is a IpamScopeState enum value + IpamScopeStateModifyFailed = "modify-failed" + + // IpamScopeStateDeleteInProgress is a IpamScopeState enum value + IpamScopeStateDeleteInProgress = "delete-in-progress" + + // IpamScopeStateDeleteComplete is a IpamScopeState enum value + IpamScopeStateDeleteComplete = "delete-complete" + + // IpamScopeStateDeleteFailed is a IpamScopeState enum value + IpamScopeStateDeleteFailed = "delete-failed" +) + +// IpamScopeState_Values returns all elements of the IpamScopeState enum +func IpamScopeState_Values() []string { + return []string{ + IpamScopeStateCreateInProgress, + IpamScopeStateCreateComplete, + IpamScopeStateCreateFailed, + IpamScopeStateModifyInProgress, + IpamScopeStateModifyComplete, + IpamScopeStateModifyFailed, + IpamScopeStateDeleteInProgress, + IpamScopeStateDeleteComplete, + IpamScopeStateDeleteFailed, + } +} + +const ( + // IpamScopeTypePublic is a IpamScopeType enum value + IpamScopeTypePublic = "public" + + // IpamScopeTypePrivate is a IpamScopeType enum value + IpamScopeTypePrivate = "private" +) + +// IpamScopeType_Values returns all elements of the IpamScopeType enum +func IpamScopeType_Values() []string { + return []string{ + IpamScopeTypePublic, + IpamScopeTypePrivate, + } +} + +const ( + // IpamStateCreateInProgress is a IpamState enum value + IpamStateCreateInProgress = "create-in-progress" + + // IpamStateCreateComplete is a IpamState enum value + IpamStateCreateComplete = "create-complete" + + // IpamStateCreateFailed is a IpamState enum value + IpamStateCreateFailed = "create-failed" + + // IpamStateModifyInProgress is a IpamState enum value + IpamStateModifyInProgress = "modify-in-progress" + + // IpamStateModifyComplete is a IpamState enum value + IpamStateModifyComplete = "modify-complete" + + // IpamStateModifyFailed is a IpamState enum value + IpamStateModifyFailed = "modify-failed" + + // IpamStateDeleteInProgress is a IpamState enum value + IpamStateDeleteInProgress = "delete-in-progress" + + // IpamStateDeleteComplete is a IpamState enum value + IpamStateDeleteComplete = "delete-complete" + + // IpamStateDeleteFailed is a IpamState enum value + IpamStateDeleteFailed = "delete-failed" +) + +// IpamState_Values returns all elements of the IpamState enum +func IpamState_Values() []string { + return []string{ + IpamStateCreateInProgress, + IpamStateCreateComplete, + IpamStateCreateFailed, + IpamStateModifyInProgress, + IpamStateModifyComplete, + IpamStateModifyFailed, + IpamStateDeleteInProgress, + IpamStateDeleteComplete, + IpamStateDeleteFailed, + } +} + const ( // Ipv6SupportValueEnable is a Ipv6SupportValue enum value Ipv6SupportValueEnable = "enable" @@ -153418,6 +163609,15 @@ const ( // ResourceTypeInternetGateway is a ResourceType enum value ResourceTypeInternetGateway = "internet-gateway" + // ResourceTypeIpam is a ResourceType enum value + ResourceTypeIpam = "ipam" + + // ResourceTypeIpamPool is a ResourceType enum value + ResourceTypeIpamPool = "ipam-pool" + + // ResourceTypeIpamScope is a ResourceType enum value + ResourceTypeIpamScope = "ipam-scope" + // ResourceTypeIpv4poolEc2 is a ResourceType enum value ResourceTypeIpv4poolEc2 = "ipv4pool-ec2" @@ -153463,6 +163663,12 @@ const ( // ResourceTypeNetworkInsightsPath is a ResourceType enum value ResourceTypeNetworkInsightsPath = "network-insights-path" + // ResourceTypeNetworkInsightsAccessScope is a ResourceType enum value + ResourceTypeNetworkInsightsAccessScope = "network-insights-access-scope" + + // ResourceTypeNetworkInsightsAccessScopeAnalysis is a ResourceType enum value + ResourceTypeNetworkInsightsAccessScopeAnalysis = "network-insights-access-scope-analysis" + // ResourceTypePlacementGroup is a ResourceType enum value ResourceTypePlacementGroup = "placement-group" @@ -153568,6 +163774,9 @@ func ResourceType_Values() []string { ResourceTypeInstance, ResourceTypeInstanceEventWindow, ResourceTypeInternetGateway, + ResourceTypeIpam, + ResourceTypeIpamPool, + ResourceTypeIpamScope, ResourceTypeIpv4poolEc2, ResourceTypeIpv6poolEc2, ResourceTypeKeyPair, @@ -153583,6 +163792,8 @@ func ResourceType_Values() []string { ResourceTypeNetworkInterface, ResourceTypeNetworkInsightsAnalysis, ResourceTypeNetworkInsightsPath, + ResourceTypeNetworkInsightsAccessScope, + ResourceTypeNetworkInsightsAccessScopeAnalysis, ResourceTypePlacementGroup, ResourceTypePrefixList, ResourceTypeReplaceRootVolumeTask, diff --git a/service/ec2/ec2iface/interface.go b/service/ec2/ec2iface/interface.go index 8cd73f735e3..e0f10d8e421 100644 --- a/service/ec2/ec2iface/interface.go +++ b/service/ec2/ec2iface/interface.go @@ -96,6 +96,10 @@ type EC2API interface { AllocateHostsWithContext(aws.Context, *ec2.AllocateHostsInput, ...request.Option) (*ec2.AllocateHostsOutput, error) AllocateHostsRequest(*ec2.AllocateHostsInput) (*request.Request, *ec2.AllocateHostsOutput) + AllocateIpamPoolCidr(*ec2.AllocateIpamPoolCidrInput) (*ec2.AllocateIpamPoolCidrOutput, error) + AllocateIpamPoolCidrWithContext(aws.Context, *ec2.AllocateIpamPoolCidrInput, ...request.Option) (*ec2.AllocateIpamPoolCidrOutput, error) + AllocateIpamPoolCidrRequest(*ec2.AllocateIpamPoolCidrInput) (*request.Request, *ec2.AllocateIpamPoolCidrOutput) + ApplySecurityGroupsToClientVpnTargetNetwork(*ec2.ApplySecurityGroupsToClientVpnTargetNetworkInput) (*ec2.ApplySecurityGroupsToClientVpnTargetNetworkOutput, error) ApplySecurityGroupsToClientVpnTargetNetworkWithContext(aws.Context, *ec2.ApplySecurityGroupsToClientVpnTargetNetworkInput, ...request.Option) (*ec2.ApplySecurityGroupsToClientVpnTargetNetworkOutput, error) ApplySecurityGroupsToClientVpnTargetNetworkRequest(*ec2.ApplySecurityGroupsToClientVpnTargetNetworkInput) (*request.Request, *ec2.ApplySecurityGroupsToClientVpnTargetNetworkOutput) @@ -312,6 +316,18 @@ type EC2API interface { CreateInternetGatewayWithContext(aws.Context, *ec2.CreateInternetGatewayInput, ...request.Option) (*ec2.CreateInternetGatewayOutput, error) CreateInternetGatewayRequest(*ec2.CreateInternetGatewayInput) (*request.Request, *ec2.CreateInternetGatewayOutput) + CreateIpam(*ec2.CreateIpamInput) (*ec2.CreateIpamOutput, error) + CreateIpamWithContext(aws.Context, *ec2.CreateIpamInput, ...request.Option) (*ec2.CreateIpamOutput, error) + CreateIpamRequest(*ec2.CreateIpamInput) (*request.Request, *ec2.CreateIpamOutput) + + CreateIpamPool(*ec2.CreateIpamPoolInput) (*ec2.CreateIpamPoolOutput, error) + CreateIpamPoolWithContext(aws.Context, *ec2.CreateIpamPoolInput, ...request.Option) (*ec2.CreateIpamPoolOutput, error) + CreateIpamPoolRequest(*ec2.CreateIpamPoolInput) (*request.Request, *ec2.CreateIpamPoolOutput) + + CreateIpamScope(*ec2.CreateIpamScopeInput) (*ec2.CreateIpamScopeOutput, error) + CreateIpamScopeWithContext(aws.Context, *ec2.CreateIpamScopeInput, ...request.Option) (*ec2.CreateIpamScopeOutput, error) + CreateIpamScopeRequest(*ec2.CreateIpamScopeInput) (*request.Request, *ec2.CreateIpamScopeOutput) + CreateKeyPair(*ec2.CreateKeyPairInput) (*ec2.CreateKeyPairOutput, error) CreateKeyPairWithContext(aws.Context, *ec2.CreateKeyPairInput, ...request.Option) (*ec2.CreateKeyPairOutput, error) CreateKeyPairRequest(*ec2.CreateKeyPairInput) (*request.Request, *ec2.CreateKeyPairOutput) @@ -348,6 +364,10 @@ type EC2API interface { CreateNetworkAclEntryWithContext(aws.Context, *ec2.CreateNetworkAclEntryInput, ...request.Option) (*ec2.CreateNetworkAclEntryOutput, error) CreateNetworkAclEntryRequest(*ec2.CreateNetworkAclEntryInput) (*request.Request, *ec2.CreateNetworkAclEntryOutput) + CreateNetworkInsightsAccessScope(*ec2.CreateNetworkInsightsAccessScopeInput) (*ec2.CreateNetworkInsightsAccessScopeOutput, error) + CreateNetworkInsightsAccessScopeWithContext(aws.Context, *ec2.CreateNetworkInsightsAccessScopeInput, ...request.Option) (*ec2.CreateNetworkInsightsAccessScopeOutput, error) + CreateNetworkInsightsAccessScopeRequest(*ec2.CreateNetworkInsightsAccessScopeInput) (*request.Request, *ec2.CreateNetworkInsightsAccessScopeOutput) + CreateNetworkInsightsPath(*ec2.CreateNetworkInsightsPathInput) (*ec2.CreateNetworkInsightsPathOutput, error) CreateNetworkInsightsPathWithContext(aws.Context, *ec2.CreateNetworkInsightsPathInput, ...request.Option) (*ec2.CreateNetworkInsightsPathOutput, error) CreateNetworkInsightsPathRequest(*ec2.CreateNetworkInsightsPathInput) (*request.Request, *ec2.CreateNetworkInsightsPathOutput) @@ -364,6 +384,10 @@ type EC2API interface { CreatePlacementGroupWithContext(aws.Context, *ec2.CreatePlacementGroupInput, ...request.Option) (*ec2.CreatePlacementGroupOutput, error) CreatePlacementGroupRequest(*ec2.CreatePlacementGroupInput) (*request.Request, *ec2.CreatePlacementGroupOutput) + CreatePublicIpv4Pool(*ec2.CreatePublicIpv4PoolInput) (*ec2.CreatePublicIpv4PoolOutput, error) + CreatePublicIpv4PoolWithContext(aws.Context, *ec2.CreatePublicIpv4PoolInput, ...request.Option) (*ec2.CreatePublicIpv4PoolOutput, error) + CreatePublicIpv4PoolRequest(*ec2.CreatePublicIpv4PoolInput) (*request.Request, *ec2.CreatePublicIpv4PoolOutput) + CreateReplaceRootVolumeTask(*ec2.CreateReplaceRootVolumeTaskInput) (*ec2.CreateReplaceRootVolumeTaskOutput, error) CreateReplaceRootVolumeTaskWithContext(aws.Context, *ec2.CreateReplaceRootVolumeTaskInput, ...request.Option) (*ec2.CreateReplaceRootVolumeTaskOutput, error) CreateReplaceRootVolumeTaskRequest(*ec2.CreateReplaceRootVolumeTaskInput) (*request.Request, *ec2.CreateReplaceRootVolumeTaskOutput) @@ -548,6 +572,18 @@ type EC2API interface { DeleteInternetGatewayWithContext(aws.Context, *ec2.DeleteInternetGatewayInput, ...request.Option) (*ec2.DeleteInternetGatewayOutput, error) DeleteInternetGatewayRequest(*ec2.DeleteInternetGatewayInput) (*request.Request, *ec2.DeleteInternetGatewayOutput) + DeleteIpam(*ec2.DeleteIpamInput) (*ec2.DeleteIpamOutput, error) + DeleteIpamWithContext(aws.Context, *ec2.DeleteIpamInput, ...request.Option) (*ec2.DeleteIpamOutput, error) + DeleteIpamRequest(*ec2.DeleteIpamInput) (*request.Request, *ec2.DeleteIpamOutput) + + DeleteIpamPool(*ec2.DeleteIpamPoolInput) (*ec2.DeleteIpamPoolOutput, error) + DeleteIpamPoolWithContext(aws.Context, *ec2.DeleteIpamPoolInput, ...request.Option) (*ec2.DeleteIpamPoolOutput, error) + DeleteIpamPoolRequest(*ec2.DeleteIpamPoolInput) (*request.Request, *ec2.DeleteIpamPoolOutput) + + DeleteIpamScope(*ec2.DeleteIpamScopeInput) (*ec2.DeleteIpamScopeOutput, error) + DeleteIpamScopeWithContext(aws.Context, *ec2.DeleteIpamScopeInput, ...request.Option) (*ec2.DeleteIpamScopeOutput, error) + DeleteIpamScopeRequest(*ec2.DeleteIpamScopeInput) (*request.Request, *ec2.DeleteIpamScopeOutput) + DeleteKeyPair(*ec2.DeleteKeyPairInput) (*ec2.DeleteKeyPairOutput, error) DeleteKeyPairWithContext(aws.Context, *ec2.DeleteKeyPairInput, ...request.Option) (*ec2.DeleteKeyPairOutput, error) DeleteKeyPairRequest(*ec2.DeleteKeyPairInput) (*request.Request, *ec2.DeleteKeyPairOutput) @@ -584,6 +620,14 @@ type EC2API interface { DeleteNetworkAclEntryWithContext(aws.Context, *ec2.DeleteNetworkAclEntryInput, ...request.Option) (*ec2.DeleteNetworkAclEntryOutput, error) DeleteNetworkAclEntryRequest(*ec2.DeleteNetworkAclEntryInput) (*request.Request, *ec2.DeleteNetworkAclEntryOutput) + DeleteNetworkInsightsAccessScope(*ec2.DeleteNetworkInsightsAccessScopeInput) (*ec2.DeleteNetworkInsightsAccessScopeOutput, error) + DeleteNetworkInsightsAccessScopeWithContext(aws.Context, *ec2.DeleteNetworkInsightsAccessScopeInput, ...request.Option) (*ec2.DeleteNetworkInsightsAccessScopeOutput, error) + DeleteNetworkInsightsAccessScopeRequest(*ec2.DeleteNetworkInsightsAccessScopeInput) (*request.Request, *ec2.DeleteNetworkInsightsAccessScopeOutput) + + DeleteNetworkInsightsAccessScopeAnalysis(*ec2.DeleteNetworkInsightsAccessScopeAnalysisInput) (*ec2.DeleteNetworkInsightsAccessScopeAnalysisOutput, error) + DeleteNetworkInsightsAccessScopeAnalysisWithContext(aws.Context, *ec2.DeleteNetworkInsightsAccessScopeAnalysisInput, ...request.Option) (*ec2.DeleteNetworkInsightsAccessScopeAnalysisOutput, error) + DeleteNetworkInsightsAccessScopeAnalysisRequest(*ec2.DeleteNetworkInsightsAccessScopeAnalysisInput) (*request.Request, *ec2.DeleteNetworkInsightsAccessScopeAnalysisOutput) + DeleteNetworkInsightsAnalysis(*ec2.DeleteNetworkInsightsAnalysisInput) (*ec2.DeleteNetworkInsightsAnalysisOutput, error) DeleteNetworkInsightsAnalysisWithContext(aws.Context, *ec2.DeleteNetworkInsightsAnalysisInput, ...request.Option) (*ec2.DeleteNetworkInsightsAnalysisOutput, error) DeleteNetworkInsightsAnalysisRequest(*ec2.DeleteNetworkInsightsAnalysisInput) (*request.Request, *ec2.DeleteNetworkInsightsAnalysisOutput) @@ -604,6 +648,10 @@ type EC2API interface { DeletePlacementGroupWithContext(aws.Context, *ec2.DeletePlacementGroupInput, ...request.Option) (*ec2.DeletePlacementGroupOutput, error) DeletePlacementGroupRequest(*ec2.DeletePlacementGroupInput) (*request.Request, *ec2.DeletePlacementGroupOutput) + DeletePublicIpv4Pool(*ec2.DeletePublicIpv4PoolInput) (*ec2.DeletePublicIpv4PoolOutput, error) + DeletePublicIpv4PoolWithContext(aws.Context, *ec2.DeletePublicIpv4PoolInput, ...request.Option) (*ec2.DeletePublicIpv4PoolOutput, error) + DeletePublicIpv4PoolRequest(*ec2.DeletePublicIpv4PoolInput) (*request.Request, *ec2.DeletePublicIpv4PoolOutput) + DeleteQueuedReservedInstances(*ec2.DeleteQueuedReservedInstancesInput) (*ec2.DeleteQueuedReservedInstancesOutput, error) DeleteQueuedReservedInstancesWithContext(aws.Context, *ec2.DeleteQueuedReservedInstancesInput, ...request.Option) (*ec2.DeleteQueuedReservedInstancesOutput, error) DeleteQueuedReservedInstancesRequest(*ec2.DeleteQueuedReservedInstancesInput) (*request.Request, *ec2.DeleteQueuedReservedInstancesOutput) @@ -732,6 +780,14 @@ type EC2API interface { DeprovisionByoipCidrWithContext(aws.Context, *ec2.DeprovisionByoipCidrInput, ...request.Option) (*ec2.DeprovisionByoipCidrOutput, error) DeprovisionByoipCidrRequest(*ec2.DeprovisionByoipCidrInput) (*request.Request, *ec2.DeprovisionByoipCidrOutput) + DeprovisionIpamPoolCidr(*ec2.DeprovisionIpamPoolCidrInput) (*ec2.DeprovisionIpamPoolCidrOutput, error) + DeprovisionIpamPoolCidrWithContext(aws.Context, *ec2.DeprovisionIpamPoolCidrInput, ...request.Option) (*ec2.DeprovisionIpamPoolCidrOutput, error) + DeprovisionIpamPoolCidrRequest(*ec2.DeprovisionIpamPoolCidrInput) (*request.Request, *ec2.DeprovisionIpamPoolCidrOutput) + + DeprovisionPublicIpv4PoolCidr(*ec2.DeprovisionPublicIpv4PoolCidrInput) (*ec2.DeprovisionPublicIpv4PoolCidrOutput, error) + DeprovisionPublicIpv4PoolCidrWithContext(aws.Context, *ec2.DeprovisionPublicIpv4PoolCidrInput, ...request.Option) (*ec2.DeprovisionPublicIpv4PoolCidrOutput, error) + DeprovisionPublicIpv4PoolCidrRequest(*ec2.DeprovisionPublicIpv4PoolCidrInput) (*request.Request, *ec2.DeprovisionPublicIpv4PoolCidrOutput) + DeregisterImage(*ec2.DeregisterImageInput) (*ec2.DeregisterImageOutput, error) DeregisterImageWithContext(aws.Context, *ec2.DeregisterImageInput, ...request.Option) (*ec2.DeregisterImageOutput, error) DeregisterImageRequest(*ec2.DeregisterImageInput) (*request.Request, *ec2.DeregisterImageOutput) @@ -1044,6 +1100,27 @@ type EC2API interface { DescribeInternetGatewaysPages(*ec2.DescribeInternetGatewaysInput, func(*ec2.DescribeInternetGatewaysOutput, bool) bool) error DescribeInternetGatewaysPagesWithContext(aws.Context, *ec2.DescribeInternetGatewaysInput, func(*ec2.DescribeInternetGatewaysOutput, bool) bool, ...request.Option) error + DescribeIpamPools(*ec2.DescribeIpamPoolsInput) (*ec2.DescribeIpamPoolsOutput, error) + DescribeIpamPoolsWithContext(aws.Context, *ec2.DescribeIpamPoolsInput, ...request.Option) (*ec2.DescribeIpamPoolsOutput, error) + DescribeIpamPoolsRequest(*ec2.DescribeIpamPoolsInput) (*request.Request, *ec2.DescribeIpamPoolsOutput) + + DescribeIpamPoolsPages(*ec2.DescribeIpamPoolsInput, func(*ec2.DescribeIpamPoolsOutput, bool) bool) error + DescribeIpamPoolsPagesWithContext(aws.Context, *ec2.DescribeIpamPoolsInput, func(*ec2.DescribeIpamPoolsOutput, bool) bool, ...request.Option) error + + DescribeIpamScopes(*ec2.DescribeIpamScopesInput) (*ec2.DescribeIpamScopesOutput, error) + DescribeIpamScopesWithContext(aws.Context, *ec2.DescribeIpamScopesInput, ...request.Option) (*ec2.DescribeIpamScopesOutput, error) + DescribeIpamScopesRequest(*ec2.DescribeIpamScopesInput) (*request.Request, *ec2.DescribeIpamScopesOutput) + + DescribeIpamScopesPages(*ec2.DescribeIpamScopesInput, func(*ec2.DescribeIpamScopesOutput, bool) bool) error + DescribeIpamScopesPagesWithContext(aws.Context, *ec2.DescribeIpamScopesInput, func(*ec2.DescribeIpamScopesOutput, bool) bool, ...request.Option) error + + DescribeIpams(*ec2.DescribeIpamsInput) (*ec2.DescribeIpamsOutput, error) + DescribeIpamsWithContext(aws.Context, *ec2.DescribeIpamsInput, ...request.Option) (*ec2.DescribeIpamsOutput, error) + DescribeIpamsRequest(*ec2.DescribeIpamsInput) (*request.Request, *ec2.DescribeIpamsOutput) + + DescribeIpamsPages(*ec2.DescribeIpamsInput, func(*ec2.DescribeIpamsOutput, bool) bool) error + DescribeIpamsPagesWithContext(aws.Context, *ec2.DescribeIpamsInput, func(*ec2.DescribeIpamsOutput, bool) bool, ...request.Option) error + DescribeIpv6Pools(*ec2.DescribeIpv6PoolsInput) (*ec2.DescribeIpv6PoolsOutput, error) DescribeIpv6PoolsWithContext(aws.Context, *ec2.DescribeIpv6PoolsInput, ...request.Option) (*ec2.DescribeIpv6PoolsOutput, error) DescribeIpv6PoolsRequest(*ec2.DescribeIpv6PoolsInput) (*request.Request, *ec2.DescribeIpv6PoolsOutput) @@ -1139,6 +1216,20 @@ type EC2API interface { DescribeNetworkAclsPages(*ec2.DescribeNetworkAclsInput, func(*ec2.DescribeNetworkAclsOutput, bool) bool) error DescribeNetworkAclsPagesWithContext(aws.Context, *ec2.DescribeNetworkAclsInput, func(*ec2.DescribeNetworkAclsOutput, bool) bool, ...request.Option) error + DescribeNetworkInsightsAccessScopeAnalyses(*ec2.DescribeNetworkInsightsAccessScopeAnalysesInput) (*ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput, error) + DescribeNetworkInsightsAccessScopeAnalysesWithContext(aws.Context, *ec2.DescribeNetworkInsightsAccessScopeAnalysesInput, ...request.Option) (*ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput, error) + DescribeNetworkInsightsAccessScopeAnalysesRequest(*ec2.DescribeNetworkInsightsAccessScopeAnalysesInput) (*request.Request, *ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput) + + DescribeNetworkInsightsAccessScopeAnalysesPages(*ec2.DescribeNetworkInsightsAccessScopeAnalysesInput, func(*ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput, bool) bool) error + DescribeNetworkInsightsAccessScopeAnalysesPagesWithContext(aws.Context, *ec2.DescribeNetworkInsightsAccessScopeAnalysesInput, func(*ec2.DescribeNetworkInsightsAccessScopeAnalysesOutput, bool) bool, ...request.Option) error + + DescribeNetworkInsightsAccessScopes(*ec2.DescribeNetworkInsightsAccessScopesInput) (*ec2.DescribeNetworkInsightsAccessScopesOutput, error) + DescribeNetworkInsightsAccessScopesWithContext(aws.Context, *ec2.DescribeNetworkInsightsAccessScopesInput, ...request.Option) (*ec2.DescribeNetworkInsightsAccessScopesOutput, error) + DescribeNetworkInsightsAccessScopesRequest(*ec2.DescribeNetworkInsightsAccessScopesInput) (*request.Request, *ec2.DescribeNetworkInsightsAccessScopesOutput) + + DescribeNetworkInsightsAccessScopesPages(*ec2.DescribeNetworkInsightsAccessScopesInput, func(*ec2.DescribeNetworkInsightsAccessScopesOutput, bool) bool) error + DescribeNetworkInsightsAccessScopesPagesWithContext(aws.Context, *ec2.DescribeNetworkInsightsAccessScopesInput, func(*ec2.DescribeNetworkInsightsAccessScopesOutput, bool) bool, ...request.Option) error + DescribeNetworkInsightsAnalyses(*ec2.DescribeNetworkInsightsAnalysesInput) (*ec2.DescribeNetworkInsightsAnalysesOutput, error) DescribeNetworkInsightsAnalysesWithContext(aws.Context, *ec2.DescribeNetworkInsightsAnalysesInput, ...request.Option) (*ec2.DescribeNetworkInsightsAnalysesOutput, error) DescribeNetworkInsightsAnalysesRequest(*ec2.DescribeNetworkInsightsAnalysesInput) (*request.Request, *ec2.DescribeNetworkInsightsAnalysesOutput) @@ -1564,6 +1655,10 @@ type EC2API interface { DisableImageDeprecationWithContext(aws.Context, *ec2.DisableImageDeprecationInput, ...request.Option) (*ec2.DisableImageDeprecationOutput, error) DisableImageDeprecationRequest(*ec2.DisableImageDeprecationInput) (*request.Request, *ec2.DisableImageDeprecationOutput) + DisableIpamOrganizationAdminAccount(*ec2.DisableIpamOrganizationAdminAccountInput) (*ec2.DisableIpamOrganizationAdminAccountOutput, error) + DisableIpamOrganizationAdminAccountWithContext(aws.Context, *ec2.DisableIpamOrganizationAdminAccountInput, ...request.Option) (*ec2.DisableIpamOrganizationAdminAccountOutput, error) + DisableIpamOrganizationAdminAccountRequest(*ec2.DisableIpamOrganizationAdminAccountInput) (*request.Request, *ec2.DisableIpamOrganizationAdminAccountOutput) + DisableSerialConsoleAccess(*ec2.DisableSerialConsoleAccessInput) (*ec2.DisableSerialConsoleAccessOutput, error) DisableSerialConsoleAccessWithContext(aws.Context, *ec2.DisableSerialConsoleAccessInput, ...request.Option) (*ec2.DisableSerialConsoleAccessOutput, error) DisableSerialConsoleAccessRequest(*ec2.DisableSerialConsoleAccessInput) (*request.Request, *ec2.DisableSerialConsoleAccessOutput) @@ -1640,6 +1735,10 @@ type EC2API interface { EnableImageDeprecationWithContext(aws.Context, *ec2.EnableImageDeprecationInput, ...request.Option) (*ec2.EnableImageDeprecationOutput, error) EnableImageDeprecationRequest(*ec2.EnableImageDeprecationInput) (*request.Request, *ec2.EnableImageDeprecationOutput) + EnableIpamOrganizationAdminAccount(*ec2.EnableIpamOrganizationAdminAccountInput) (*ec2.EnableIpamOrganizationAdminAccountOutput, error) + EnableIpamOrganizationAdminAccountWithContext(aws.Context, *ec2.EnableIpamOrganizationAdminAccountInput, ...request.Option) (*ec2.EnableIpamOrganizationAdminAccountOutput, error) + EnableIpamOrganizationAdminAccountRequest(*ec2.EnableIpamOrganizationAdminAccountInput) (*request.Request, *ec2.EnableIpamOrganizationAdminAccountOutput) + EnableSerialConsoleAccess(*ec2.EnableSerialConsoleAccessInput) (*ec2.EnableSerialConsoleAccessOutput, error) EnableSerialConsoleAccessWithContext(aws.Context, *ec2.EnableSerialConsoleAccessInput, ...request.Option) (*ec2.EnableSerialConsoleAccessOutput, error) EnableSerialConsoleAccessRequest(*ec2.EnableSerialConsoleAccessInput) (*request.Request, *ec2.EnableSerialConsoleAccessOutput) @@ -1741,6 +1840,34 @@ type EC2API interface { GetInstanceTypesFromInstanceRequirementsPages(*ec2.GetInstanceTypesFromInstanceRequirementsInput, func(*ec2.GetInstanceTypesFromInstanceRequirementsOutput, bool) bool) error GetInstanceTypesFromInstanceRequirementsPagesWithContext(aws.Context, *ec2.GetInstanceTypesFromInstanceRequirementsInput, func(*ec2.GetInstanceTypesFromInstanceRequirementsOutput, bool) bool, ...request.Option) error + GetIpamAddressHistory(*ec2.GetIpamAddressHistoryInput) (*ec2.GetIpamAddressHistoryOutput, error) + GetIpamAddressHistoryWithContext(aws.Context, *ec2.GetIpamAddressHistoryInput, ...request.Option) (*ec2.GetIpamAddressHistoryOutput, error) + GetIpamAddressHistoryRequest(*ec2.GetIpamAddressHistoryInput) (*request.Request, *ec2.GetIpamAddressHistoryOutput) + + GetIpamAddressHistoryPages(*ec2.GetIpamAddressHistoryInput, func(*ec2.GetIpamAddressHistoryOutput, bool) bool) error + GetIpamAddressHistoryPagesWithContext(aws.Context, *ec2.GetIpamAddressHistoryInput, func(*ec2.GetIpamAddressHistoryOutput, bool) bool, ...request.Option) error + + GetIpamPoolAllocations(*ec2.GetIpamPoolAllocationsInput) (*ec2.GetIpamPoolAllocationsOutput, error) + GetIpamPoolAllocationsWithContext(aws.Context, *ec2.GetIpamPoolAllocationsInput, ...request.Option) (*ec2.GetIpamPoolAllocationsOutput, error) + GetIpamPoolAllocationsRequest(*ec2.GetIpamPoolAllocationsInput) (*request.Request, *ec2.GetIpamPoolAllocationsOutput) + + GetIpamPoolAllocationsPages(*ec2.GetIpamPoolAllocationsInput, func(*ec2.GetIpamPoolAllocationsOutput, bool) bool) error + GetIpamPoolAllocationsPagesWithContext(aws.Context, *ec2.GetIpamPoolAllocationsInput, func(*ec2.GetIpamPoolAllocationsOutput, bool) bool, ...request.Option) error + + GetIpamPoolCidrs(*ec2.GetIpamPoolCidrsInput) (*ec2.GetIpamPoolCidrsOutput, error) + GetIpamPoolCidrsWithContext(aws.Context, *ec2.GetIpamPoolCidrsInput, ...request.Option) (*ec2.GetIpamPoolCidrsOutput, error) + GetIpamPoolCidrsRequest(*ec2.GetIpamPoolCidrsInput) (*request.Request, *ec2.GetIpamPoolCidrsOutput) + + GetIpamPoolCidrsPages(*ec2.GetIpamPoolCidrsInput, func(*ec2.GetIpamPoolCidrsOutput, bool) bool) error + GetIpamPoolCidrsPagesWithContext(aws.Context, *ec2.GetIpamPoolCidrsInput, func(*ec2.GetIpamPoolCidrsOutput, bool) bool, ...request.Option) error + + GetIpamResourceCidrs(*ec2.GetIpamResourceCidrsInput) (*ec2.GetIpamResourceCidrsOutput, error) + GetIpamResourceCidrsWithContext(aws.Context, *ec2.GetIpamResourceCidrsInput, ...request.Option) (*ec2.GetIpamResourceCidrsOutput, error) + GetIpamResourceCidrsRequest(*ec2.GetIpamResourceCidrsInput) (*request.Request, *ec2.GetIpamResourceCidrsOutput) + + GetIpamResourceCidrsPages(*ec2.GetIpamResourceCidrsInput, func(*ec2.GetIpamResourceCidrsOutput, bool) bool) error + GetIpamResourceCidrsPagesWithContext(aws.Context, *ec2.GetIpamResourceCidrsInput, func(*ec2.GetIpamResourceCidrsOutput, bool) bool, ...request.Option) error + GetLaunchTemplateData(*ec2.GetLaunchTemplateDataInput) (*ec2.GetLaunchTemplateDataOutput, error) GetLaunchTemplateDataWithContext(aws.Context, *ec2.GetLaunchTemplateDataInput, ...request.Option) (*ec2.GetLaunchTemplateDataOutput, error) GetLaunchTemplateDataRequest(*ec2.GetLaunchTemplateDataInput) (*request.Request, *ec2.GetLaunchTemplateDataOutput) @@ -1759,6 +1886,14 @@ type EC2API interface { GetManagedPrefixListEntriesPages(*ec2.GetManagedPrefixListEntriesInput, func(*ec2.GetManagedPrefixListEntriesOutput, bool) bool) error GetManagedPrefixListEntriesPagesWithContext(aws.Context, *ec2.GetManagedPrefixListEntriesInput, func(*ec2.GetManagedPrefixListEntriesOutput, bool) bool, ...request.Option) error + GetNetworkInsightsAccessScopeAnalysisFindings(*ec2.GetNetworkInsightsAccessScopeAnalysisFindingsInput) (*ec2.GetNetworkInsightsAccessScopeAnalysisFindingsOutput, error) + GetNetworkInsightsAccessScopeAnalysisFindingsWithContext(aws.Context, *ec2.GetNetworkInsightsAccessScopeAnalysisFindingsInput, ...request.Option) (*ec2.GetNetworkInsightsAccessScopeAnalysisFindingsOutput, error) + GetNetworkInsightsAccessScopeAnalysisFindingsRequest(*ec2.GetNetworkInsightsAccessScopeAnalysisFindingsInput) (*request.Request, *ec2.GetNetworkInsightsAccessScopeAnalysisFindingsOutput) + + GetNetworkInsightsAccessScopeContent(*ec2.GetNetworkInsightsAccessScopeContentInput) (*ec2.GetNetworkInsightsAccessScopeContentOutput, error) + GetNetworkInsightsAccessScopeContentWithContext(aws.Context, *ec2.GetNetworkInsightsAccessScopeContentInput, ...request.Option) (*ec2.GetNetworkInsightsAccessScopeContentOutput, error) + GetNetworkInsightsAccessScopeContentRequest(*ec2.GetNetworkInsightsAccessScopeContentInput) (*request.Request, *ec2.GetNetworkInsightsAccessScopeContentOutput) + GetPasswordData(*ec2.GetPasswordDataInput) (*ec2.GetPasswordDataOutput, error) GetPasswordDataWithContext(aws.Context, *ec2.GetPasswordDataInput, ...request.Option) (*ec2.GetPasswordDataOutput, error) GetPasswordDataRequest(*ec2.GetPasswordDataInput) (*request.Request, *ec2.GetPasswordDataOutput) @@ -1939,6 +2074,22 @@ type EC2API interface { ModifyInstancePlacementWithContext(aws.Context, *ec2.ModifyInstancePlacementInput, ...request.Option) (*ec2.ModifyInstancePlacementOutput, error) ModifyInstancePlacementRequest(*ec2.ModifyInstancePlacementInput) (*request.Request, *ec2.ModifyInstancePlacementOutput) + ModifyIpam(*ec2.ModifyIpamInput) (*ec2.ModifyIpamOutput, error) + ModifyIpamWithContext(aws.Context, *ec2.ModifyIpamInput, ...request.Option) (*ec2.ModifyIpamOutput, error) + ModifyIpamRequest(*ec2.ModifyIpamInput) (*request.Request, *ec2.ModifyIpamOutput) + + ModifyIpamPool(*ec2.ModifyIpamPoolInput) (*ec2.ModifyIpamPoolOutput, error) + ModifyIpamPoolWithContext(aws.Context, *ec2.ModifyIpamPoolInput, ...request.Option) (*ec2.ModifyIpamPoolOutput, error) + ModifyIpamPoolRequest(*ec2.ModifyIpamPoolInput) (*request.Request, *ec2.ModifyIpamPoolOutput) + + ModifyIpamResourceCidr(*ec2.ModifyIpamResourceCidrInput) (*ec2.ModifyIpamResourceCidrOutput, error) + ModifyIpamResourceCidrWithContext(aws.Context, *ec2.ModifyIpamResourceCidrInput, ...request.Option) (*ec2.ModifyIpamResourceCidrOutput, error) + ModifyIpamResourceCidrRequest(*ec2.ModifyIpamResourceCidrInput) (*request.Request, *ec2.ModifyIpamResourceCidrOutput) + + ModifyIpamScope(*ec2.ModifyIpamScopeInput) (*ec2.ModifyIpamScopeOutput, error) + ModifyIpamScopeWithContext(aws.Context, *ec2.ModifyIpamScopeInput, ...request.Option) (*ec2.ModifyIpamScopeOutput, error) + ModifyIpamScopeRequest(*ec2.ModifyIpamScopeInput) (*request.Request, *ec2.ModifyIpamScopeOutput) + ModifyLaunchTemplate(*ec2.ModifyLaunchTemplateInput) (*ec2.ModifyLaunchTemplateOutput, error) ModifyLaunchTemplateWithContext(aws.Context, *ec2.ModifyLaunchTemplateInput, ...request.Option) (*ec2.ModifyLaunchTemplateOutput, error) ModifyLaunchTemplateRequest(*ec2.ModifyLaunchTemplateInput) (*request.Request, *ec2.ModifyLaunchTemplateOutput) @@ -2063,10 +2214,22 @@ type EC2API interface { MoveAddressToVpcWithContext(aws.Context, *ec2.MoveAddressToVpcInput, ...request.Option) (*ec2.MoveAddressToVpcOutput, error) MoveAddressToVpcRequest(*ec2.MoveAddressToVpcInput) (*request.Request, *ec2.MoveAddressToVpcOutput) + MoveByoipCidrToIpam(*ec2.MoveByoipCidrToIpamInput) (*ec2.MoveByoipCidrToIpamOutput, error) + MoveByoipCidrToIpamWithContext(aws.Context, *ec2.MoveByoipCidrToIpamInput, ...request.Option) (*ec2.MoveByoipCidrToIpamOutput, error) + MoveByoipCidrToIpamRequest(*ec2.MoveByoipCidrToIpamInput) (*request.Request, *ec2.MoveByoipCidrToIpamOutput) + ProvisionByoipCidr(*ec2.ProvisionByoipCidrInput) (*ec2.ProvisionByoipCidrOutput, error) ProvisionByoipCidrWithContext(aws.Context, *ec2.ProvisionByoipCidrInput, ...request.Option) (*ec2.ProvisionByoipCidrOutput, error) ProvisionByoipCidrRequest(*ec2.ProvisionByoipCidrInput) (*request.Request, *ec2.ProvisionByoipCidrOutput) + ProvisionIpamPoolCidr(*ec2.ProvisionIpamPoolCidrInput) (*ec2.ProvisionIpamPoolCidrOutput, error) + ProvisionIpamPoolCidrWithContext(aws.Context, *ec2.ProvisionIpamPoolCidrInput, ...request.Option) (*ec2.ProvisionIpamPoolCidrOutput, error) + ProvisionIpamPoolCidrRequest(*ec2.ProvisionIpamPoolCidrInput) (*request.Request, *ec2.ProvisionIpamPoolCidrOutput) + + ProvisionPublicIpv4PoolCidr(*ec2.ProvisionPublicIpv4PoolCidrInput) (*ec2.ProvisionPublicIpv4PoolCidrOutput, error) + ProvisionPublicIpv4PoolCidrWithContext(aws.Context, *ec2.ProvisionPublicIpv4PoolCidrInput, ...request.Option) (*ec2.ProvisionPublicIpv4PoolCidrOutput, error) + ProvisionPublicIpv4PoolCidrRequest(*ec2.ProvisionPublicIpv4PoolCidrInput) (*request.Request, *ec2.ProvisionPublicIpv4PoolCidrOutput) + PurchaseHostReservation(*ec2.PurchaseHostReservationInput) (*ec2.PurchaseHostReservationOutput, error) PurchaseHostReservationWithContext(aws.Context, *ec2.PurchaseHostReservationInput, ...request.Option) (*ec2.PurchaseHostReservationOutput, error) PurchaseHostReservationRequest(*ec2.PurchaseHostReservationInput) (*request.Request, *ec2.PurchaseHostReservationOutput) @@ -2127,6 +2290,10 @@ type EC2API interface { ReleaseHostsWithContext(aws.Context, *ec2.ReleaseHostsInput, ...request.Option) (*ec2.ReleaseHostsOutput, error) ReleaseHostsRequest(*ec2.ReleaseHostsInput) (*request.Request, *ec2.ReleaseHostsOutput) + ReleaseIpamPoolAllocation(*ec2.ReleaseIpamPoolAllocationInput) (*ec2.ReleaseIpamPoolAllocationOutput, error) + ReleaseIpamPoolAllocationWithContext(aws.Context, *ec2.ReleaseIpamPoolAllocationInput, ...request.Option) (*ec2.ReleaseIpamPoolAllocationOutput, error) + ReleaseIpamPoolAllocationRequest(*ec2.ReleaseIpamPoolAllocationInput) (*request.Request, *ec2.ReleaseIpamPoolAllocationOutput) + ReplaceIamInstanceProfileAssociation(*ec2.ReplaceIamInstanceProfileAssociationInput) (*ec2.ReplaceIamInstanceProfileAssociationOutput, error) ReplaceIamInstanceProfileAssociationWithContext(aws.Context, *ec2.ReplaceIamInstanceProfileAssociationInput, ...request.Option) (*ec2.ReplaceIamInstanceProfileAssociationOutput, error) ReplaceIamInstanceProfileAssociationRequest(*ec2.ReplaceIamInstanceProfileAssociationInput) (*request.Request, *ec2.ReplaceIamInstanceProfileAssociationOutput) @@ -2253,6 +2420,10 @@ type EC2API interface { StartInstancesWithContext(aws.Context, *ec2.StartInstancesInput, ...request.Option) (*ec2.StartInstancesOutput, error) StartInstancesRequest(*ec2.StartInstancesInput) (*request.Request, *ec2.StartInstancesOutput) + StartNetworkInsightsAccessScopeAnalysis(*ec2.StartNetworkInsightsAccessScopeAnalysisInput) (*ec2.StartNetworkInsightsAccessScopeAnalysisOutput, error) + StartNetworkInsightsAccessScopeAnalysisWithContext(aws.Context, *ec2.StartNetworkInsightsAccessScopeAnalysisInput, ...request.Option) (*ec2.StartNetworkInsightsAccessScopeAnalysisOutput, error) + StartNetworkInsightsAccessScopeAnalysisRequest(*ec2.StartNetworkInsightsAccessScopeAnalysisInput) (*request.Request, *ec2.StartNetworkInsightsAccessScopeAnalysisOutput) + StartNetworkInsightsAnalysis(*ec2.StartNetworkInsightsAnalysisInput) (*ec2.StartNetworkInsightsAnalysisOutput, error) StartNetworkInsightsAnalysisWithContext(aws.Context, *ec2.StartNetworkInsightsAnalysisInput, ...request.Option) (*ec2.StartNetworkInsightsAnalysisOutput, error) StartNetworkInsightsAnalysisRequest(*ec2.StartNetworkInsightsAnalysisInput) (*request.Request, *ec2.StartNetworkInsightsAnalysisOutput) diff --git a/service/kendra/api.go b/service/kendra/api.go index 783536016dc..995ce912883 100644 --- a/service/kendra/api.go +++ b/service/kendra/api.go @@ -13,6 +13,189 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" ) +const opAssociateEntitiesToExperience = "AssociateEntitiesToExperience" + +// AssociateEntitiesToExperienceRequest generates a "aws/request.Request" representing the +// client's request for the AssociateEntitiesToExperience 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 AssociateEntitiesToExperience for more information on using the AssociateEntitiesToExperience +// 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 AssociateEntitiesToExperienceRequest method. +// req, resp := client.AssociateEntitiesToExperienceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience +func (c *Kendra) AssociateEntitiesToExperienceRequest(input *AssociateEntitiesToExperienceInput) (req *request.Request, output *AssociateEntitiesToExperienceOutput) { + op := &request.Operation{ + Name: opAssociateEntitiesToExperience, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AssociateEntitiesToExperienceInput{} + } + + output = &AssociateEntitiesToExperienceOutput{} + req = c.newRequest(op, input, output) + return +} + +// AssociateEntitiesToExperience API operation for AWSKendraFrontendService. +// +// Grants users or groups in your Amazon Web Services SSO identity source access +// to your Amazon Kendra experience. You can create an Amazon Kendra experience +// such as a search application. For more information on creating a search application +// experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation AssociateEntitiesToExperience for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceNotFoundException +// +// * ResourceAlreadyExistException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience +func (c *Kendra) AssociateEntitiesToExperience(input *AssociateEntitiesToExperienceInput) (*AssociateEntitiesToExperienceOutput, error) { + req, out := c.AssociateEntitiesToExperienceRequest(input) + return out, req.Send() +} + +// AssociateEntitiesToExperienceWithContext is the same as AssociateEntitiesToExperience with the addition of +// the ability to pass a context and additional request options. +// +// See AssociateEntitiesToExperience 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 *Kendra) AssociateEntitiesToExperienceWithContext(ctx aws.Context, input *AssociateEntitiesToExperienceInput, opts ...request.Option) (*AssociateEntitiesToExperienceOutput, error) { + req, out := c.AssociateEntitiesToExperienceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opAssociatePersonasToEntities = "AssociatePersonasToEntities" + +// AssociatePersonasToEntitiesRequest generates a "aws/request.Request" representing the +// client's request for the AssociatePersonasToEntities 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 AssociatePersonasToEntities for more information on using the AssociatePersonasToEntities +// 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 AssociatePersonasToEntitiesRequest method. +// req, resp := client.AssociatePersonasToEntitiesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities +func (c *Kendra) AssociatePersonasToEntitiesRequest(input *AssociatePersonasToEntitiesInput) (req *request.Request, output *AssociatePersonasToEntitiesOutput) { + op := &request.Operation{ + Name: opAssociatePersonasToEntities, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AssociatePersonasToEntitiesInput{} + } + + output = &AssociatePersonasToEntitiesOutput{} + req = c.newRequest(op, input, output) + return +} + +// AssociatePersonasToEntities API operation for AWSKendraFrontendService. +// +// Defines the specific permissions of users or groups in your Amazon Web Services +// SSO identity source with access to your Amazon Kendra experience. You can +// create an Amazon Kendra experience such as a search application. For more +// information on creating a search application experience, see Building a search +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation AssociatePersonasToEntities for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceNotFoundException +// +// * ResourceAlreadyExistException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities +func (c *Kendra) AssociatePersonasToEntities(input *AssociatePersonasToEntitiesInput) (*AssociatePersonasToEntitiesOutput, error) { + req, out := c.AssociatePersonasToEntitiesRequest(input) + return out, req.Send() +} + +// AssociatePersonasToEntitiesWithContext is the same as AssociatePersonasToEntities with the addition of +// the ability to pass a context and additional request options. +// +// See AssociatePersonasToEntities 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 *Kendra) AssociatePersonasToEntitiesWithContext(ctx aws.Context, input *AssociatePersonasToEntitiesInput, opts ...request.Option) (*AssociatePersonasToEntitiesOutput, error) { + req, out := c.AssociatePersonasToEntitiesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opBatchDeleteDocument = "BatchDeleteDocument" // BatchDeleteDocumentRequest generates a "aws/request.Request" representing the @@ -359,6 +542,9 @@ func (c *Kendra) ClearQuerySuggestionsRequest(input *ClearQuerySuggestionsInput) // If you do not see any new suggestions, then please allow Amazon Kendra to // collect enough queries to learn new suggestions. // +// ClearQuerySuggestions is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. +// // 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. @@ -453,6 +639,10 @@ func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *req // CreateDataSource is a synchronous operation. The operation returns 200 if // the data source was successfully created. Otherwise, an exception is raised. // +// Amazon S3 and custom (https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html) +// data sources are the only supported data sources in the Amazon Web Services +// GovCloud (US-West) region. +// // 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. @@ -499,6 +689,98 @@ func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataS return out, req.Send() } +const opCreateExperience = "CreateExperience" + +// CreateExperienceRequest generates a "aws/request.Request" representing the +// client's request for the CreateExperience 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 CreateExperience for more information on using the CreateExperience +// 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 CreateExperienceRequest method. +// req, resp := client.CreateExperienceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience +func (c *Kendra) CreateExperienceRequest(input *CreateExperienceInput) (req *request.Request, output *CreateExperienceOutput) { + op := &request.Operation{ + Name: opCreateExperience, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateExperienceInput{} + } + + output = &CreateExperienceOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateExperience API operation for AWSKendraFrontendService. +// +// Creates an Amazon Kendra experience such as a search application. For more +// information on creating a search application experience, see Building a search +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation CreateExperience for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ServiceQuotaExceededException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience +func (c *Kendra) CreateExperience(input *CreateExperienceInput) (*CreateExperienceOutput, error) { + req, out := c.CreateExperienceRequest(input) + return out, req.Send() +} + +// CreateExperienceWithContext is the same as CreateExperience with the addition of +// the ability to pass a context and additional request options. +// +// See CreateExperience 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 *Kendra) CreateExperienceWithContext(ctx aws.Context, input *CreateExperienceInput, opts ...request.Option) (*CreateExperienceOutput, error) { + req, out := c.CreateExperienceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateFaq = "CreateFaq" // CreateFaqRequest generates a "aws/request.Request" representing the @@ -741,6 +1023,9 @@ func (c *Kendra) CreateQuerySuggestionsBlockListRequest(input *CreateQuerySugges // For information on the current quota limits for block lists, see Quotas for // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). // +// CreateQuerySuggestionsBlockList is currently not supported in the Amazon +// Web Services GovCloud (US-West) region. +// // 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. @@ -968,61 +1253,65 @@ func (c *Kendra) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataS return out, req.Send() } -const opDeleteFaq = "DeleteFaq" +const opDeleteExperience = "DeleteExperience" -// DeleteFaqRequest generates a "aws/request.Request" representing the -// client's request for the DeleteFaq operation. The "output" return +// DeleteExperienceRequest generates a "aws/request.Request" representing the +// client's request for the DeleteExperience 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 DeleteFaq for more information on using the DeleteFaq +// See DeleteExperience for more information on using the DeleteExperience // 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 DeleteFaqRequest method. -// req, resp := client.DeleteFaqRequest(params) +// // Example sending a request using the DeleteExperienceRequest method. +// req, resp := client.DeleteExperienceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq -func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience +func (c *Kendra) DeleteExperienceRequest(input *DeleteExperienceInput) (req *request.Request, output *DeleteExperienceOutput) { op := &request.Operation{ - Name: opDeleteFaq, + Name: opDeleteExperience, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DeleteFaqInput{} + input = &DeleteExperienceInput{} } - output = &DeleteFaqOutput{} + output = &DeleteExperienceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteFaq API operation for AWSKendraFrontendService. +// DeleteExperience API operation for AWSKendraFrontendService. // -// Removes an FAQ from an index. +// Deletes your Amazon Kendra experience such as a search application. For more +// information on creating a search application experience, see Building a search +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation DeleteFaq for usage and error information. +// API operation DeleteExperience for usage and error information. // // Returned Error Types: +// * AccessDeniedException +// // * ValidationException // // * ConflictException @@ -1031,78 +1320,165 @@ func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, // // * ThrottlingException // -// * AccessDeniedException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq -func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error) { - req, out := c.DeleteFaqRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience +func (c *Kendra) DeleteExperience(input *DeleteExperienceInput) (*DeleteExperienceOutput, error) { + req, out := c.DeleteExperienceRequest(input) return out, req.Send() } -// DeleteFaqWithContext is the same as DeleteFaq with the addition of +// DeleteExperienceWithContext is the same as DeleteExperience with the addition of // the ability to pass a context and additional request options. // -// See DeleteFaq for details on how to use this API operation. +// See DeleteExperience 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 *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error) { - req, out := c.DeleteFaqRequest(input) +func (c *Kendra) DeleteExperienceWithContext(ctx aws.Context, input *DeleteExperienceInput, opts ...request.Option) (*DeleteExperienceOutput, error) { + req, out := c.DeleteExperienceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeleteIndex = "DeleteIndex" +const opDeleteFaq = "DeleteFaq" -// DeleteIndexRequest generates a "aws/request.Request" representing the -// client's request for the DeleteIndex operation. The "output" return +// DeleteFaqRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFaq 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 DeleteIndex for more information on using the DeleteIndex +// See DeleteFaq for more information on using the DeleteFaq // 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 DeleteIndexRequest method. -// req, resp := client.DeleteIndexRequest(params) +// // Example sending a request using the DeleteFaqRequest method. +// req, resp := client.DeleteFaqRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex -func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq +func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput) { op := &request.Operation{ - Name: opDeleteIndex, + Name: opDeleteFaq, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DeleteIndexInput{} + input = &DeleteFaqInput{} } - output = &DeleteIndexOutput{} + output = &DeleteFaqOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteIndex API operation for AWSKendraFrontendService. +// DeleteFaq API operation for AWSKendraFrontendService. // -// Deletes an existing Amazon Kendra index. An exception is not thrown if the +// Removes an FAQ from an index. +// +// 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 AWSKendraFrontendService's +// API operation DeleteFaq for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq +func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error) { + req, out := c.DeleteFaqRequest(input) + return out, req.Send() +} + +// DeleteFaqWithContext is the same as DeleteFaq with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteFaq 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 *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error) { + req, out := c.DeleteFaqRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteIndex = "DeleteIndex" + +// DeleteIndexRequest generates a "aws/request.Request" representing the +// client's request for the DeleteIndex 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 DeleteIndex for more information on using the DeleteIndex +// 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 DeleteIndexRequest method. +// req, resp := client.DeleteIndexRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex +func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput) { + op := &request.Operation{ + Name: opDeleteIndex, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteIndexInput{} + } + + output = &DeleteIndexOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteIndex API operation for AWSKendraFrontendService. +// +// Deletes an existing Amazon Kendra index. An exception is not thrown if the // index is already being deleted. While the index is being deleted, the Status // field returned by a call to the DescribeIndex operation is set to DELETING. // @@ -1206,6 +1582,9 @@ func (c *Kendra) DeletePrincipalMappingRequest(input *DeletePrincipalMappingInpu // group when calling PutPrincipalMapping. You can update your internal list // of users or sub groups and input this list when calling PutPrincipalMapping. // +// DeletePrincipalMapping is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. +// // 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. @@ -1299,6 +1678,9 @@ func (c *Kendra) DeleteQuerySuggestionsBlockListRequest(input *DeleteQuerySugges // to refresh the entire suggestions list to add back the queries that were // previously blocked. // +// DeleteQuerySuggestionsBlockList is currently not supported in the Amazon +// Web Services GovCloud (US-West) region. +// // 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. @@ -1516,6 +1898,94 @@ func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeD return out, req.Send() } +const opDescribeExperience = "DescribeExperience" + +// DescribeExperienceRequest generates a "aws/request.Request" representing the +// client's request for the DescribeExperience 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 DescribeExperience for more information on using the DescribeExperience +// 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 DescribeExperienceRequest method. +// req, resp := client.DescribeExperienceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience +func (c *Kendra) DescribeExperienceRequest(input *DescribeExperienceInput) (req *request.Request, output *DescribeExperienceOutput) { + op := &request.Operation{ + Name: opDescribeExperience, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeExperienceInput{} + } + + output = &DescribeExperienceOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeExperience API operation for AWSKendraFrontendService. +// +// Gets information about your Amazon Kendra experience such as a search application. +// For more information on creating a search application experience, see Building +// a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation DescribeExperience for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience +func (c *Kendra) DescribeExperience(input *DescribeExperienceInput) (*DescribeExperienceOutput, error) { + req, out := c.DescribeExperienceRequest(input) + return out, req.Send() +} + +// DescribeExperienceWithContext is the same as DescribeExperience with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeExperience 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 *Kendra) DescribeExperienceWithContext(ctx aws.Context, input *DescribeExperienceInput, opts ...request.Option) (*DescribeExperienceOutput, error) { + req, out := c.DescribeExperienceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeFaq = "DescribeFaq" // DescribeFaqRequest generates a "aws/request.Request" representing the @@ -1739,6 +2209,9 @@ func (c *Kendra) DescribePrincipalMappingRequest(input *DescribePrincipalMapping // after other actions, and useful error messages if an action could not be // processed. // +// DescribePrincipalMapping is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. +// // 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. @@ -1827,6 +2300,9 @@ func (c *Kendra) DescribeQuerySuggestionsBlockListRequest(input *DescribeQuerySu // // This is used to check the current settings that are applied to a block list. // +// DescribeQuerySuggestionsBlockList is currently not supported in the Amazon +// Web Services GovCloud (US-West) region. +// // 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. @@ -1915,6 +2391,9 @@ func (c *Kendra) DescribeQuerySuggestionsConfigRequest(input *DescribeQuerySugge // // This is used to check the current settings applied to query suggestions. // +// DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. +// // 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. @@ -2041,58 +2520,62 @@ func (c *Kendra) DescribeThesaurusWithContext(ctx aws.Context, input *DescribeTh return out, req.Send() } -const opGetQuerySuggestions = "GetQuerySuggestions" +const opDisassociateEntitiesFromExperience = "DisassociateEntitiesFromExperience" -// GetQuerySuggestionsRequest generates a "aws/request.Request" representing the -// client's request for the GetQuerySuggestions operation. The "output" return +// DisassociateEntitiesFromExperienceRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateEntitiesFromExperience 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 GetQuerySuggestions for more information on using the GetQuerySuggestions +// See DisassociateEntitiesFromExperience for more information on using the DisassociateEntitiesFromExperience // 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 GetQuerySuggestionsRequest method. -// req, resp := client.GetQuerySuggestionsRequest(params) +// // Example sending a request using the DisassociateEntitiesFromExperienceRequest method. +// req, resp := client.DisassociateEntitiesFromExperienceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions -func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience +func (c *Kendra) DisassociateEntitiesFromExperienceRequest(input *DisassociateEntitiesFromExperienceInput) (req *request.Request, output *DisassociateEntitiesFromExperienceOutput) { op := &request.Operation{ - Name: opGetQuerySuggestions, + Name: opDisassociateEntitiesFromExperience, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &GetQuerySuggestionsInput{} + input = &DisassociateEntitiesFromExperienceInput{} } - output = &GetQuerySuggestionsOutput{} + output = &DisassociateEntitiesFromExperienceOutput{} req = c.newRequest(op, input, output) return } -// GetQuerySuggestions API operation for AWSKendraFrontendService. +// DisassociateEntitiesFromExperience API operation for AWSKendraFrontendService. // -// Fetches the queries that are suggested to your users. +// Prevents users or groups in your Amazon Web Services SSO identity source +// from accessing your Amazon Kendra experience. You can create an Amazon Kendra +// experience such as a search application. For more information on creating +// a search application experience, see Building a search experience with no +// code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation GetQuerySuggestions for usage and error information. +// API operation DisassociateEntitiesFromExperience for usage and error information. // // Returned Error Types: // * ValidationException @@ -2103,92 +2586,86 @@ func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (re // // * AccessDeniedException // -// * ServiceQuotaExceededException -// -// * ConflictException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions -func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error) { - req, out := c.GetQuerySuggestionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience +func (c *Kendra) DisassociateEntitiesFromExperience(input *DisassociateEntitiesFromExperienceInput) (*DisassociateEntitiesFromExperienceOutput, error) { + req, out := c.DisassociateEntitiesFromExperienceRequest(input) return out, req.Send() } -// GetQuerySuggestionsWithContext is the same as GetQuerySuggestions with the addition of +// DisassociateEntitiesFromExperienceWithContext is the same as DisassociateEntitiesFromExperience with the addition of // the ability to pass a context and additional request options. // -// See GetQuerySuggestions for details on how to use this API operation. +// See DisassociateEntitiesFromExperience 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 *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, error) { - req, out := c.GetQuerySuggestionsRequest(input) +func (c *Kendra) DisassociateEntitiesFromExperienceWithContext(ctx aws.Context, input *DisassociateEntitiesFromExperienceInput, opts ...request.Option) (*DisassociateEntitiesFromExperienceOutput, error) { + req, out := c.DisassociateEntitiesFromExperienceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListDataSourceSyncJobs = "ListDataSourceSyncJobs" +const opDisassociatePersonasFromEntities = "DisassociatePersonasFromEntities" -// ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListDataSourceSyncJobs operation. The "output" return +// DisassociatePersonasFromEntitiesRequest generates a "aws/request.Request" representing the +// client's request for the DisassociatePersonasFromEntities 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 ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs +// See DisassociatePersonasFromEntities for more information on using the DisassociatePersonasFromEntities // 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 ListDataSourceSyncJobsRequest method. -// req, resp := client.ListDataSourceSyncJobsRequest(params) +// // Example sending a request using the DisassociatePersonasFromEntitiesRequest method. +// req, resp := client.DisassociatePersonasFromEntitiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs -func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities +func (c *Kendra) DisassociatePersonasFromEntitiesRequest(input *DisassociatePersonasFromEntitiesInput) (req *request.Request, output *DisassociatePersonasFromEntitiesOutput) { op := &request.Operation{ - Name: opListDataSourceSyncJobs, + Name: opDisassociatePersonasFromEntities, HTTPMethod: "POST", HTTPPath: "/", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "MaxResults", - TruncationToken: "", - }, } if input == nil { - input = &ListDataSourceSyncJobsInput{} + input = &DisassociatePersonasFromEntitiesInput{} } - output = &ListDataSourceSyncJobsOutput{} + output = &DisassociatePersonasFromEntitiesOutput{} req = c.newRequest(op, input, output) return } -// ListDataSourceSyncJobs API operation for AWSKendraFrontendService. +// DisassociatePersonasFromEntities API operation for AWSKendraFrontendService. // -// Gets statistics about synchronizing Amazon Kendra with a data source. +// Removes the specific permissions of users or groups in your Amazon Web Services +// SSO identity source with access to your Amazon Kendra experience. You can +// create an Amazon Kendra experience such as a search application. For more +// information on creating a search application experience, see Building a search +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation ListDataSourceSyncJobs for usage and error information. +// API operation DisassociatePersonasFromEntities for usage and error information. // // Returned Error Types: // * ValidationException @@ -2199,435 +2676,387 @@ func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInpu // // * AccessDeniedException // -// * ConflictException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs -func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error) { - req, out := c.ListDataSourceSyncJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities +func (c *Kendra) DisassociatePersonasFromEntities(input *DisassociatePersonasFromEntitiesInput) (*DisassociatePersonasFromEntitiesOutput, error) { + req, out := c.DisassociatePersonasFromEntitiesRequest(input) return out, req.Send() } -// ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of +// DisassociatePersonasFromEntitiesWithContext is the same as DisassociatePersonasFromEntities with the addition of // the ability to pass a context and additional request options. // -// See ListDataSourceSyncJobs for details on how to use this API operation. +// See DisassociatePersonasFromEntities 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 *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error) { - req, out := c.ListDataSourceSyncJobsRequest(input) +func (c *Kendra) DisassociatePersonasFromEntitiesWithContext(ctx aws.Context, input *DisassociatePersonasFromEntitiesInput, opts ...request.Option) (*DisassociatePersonasFromEntitiesOutput, error) { + req, out := c.DisassociatePersonasFromEntitiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. +const opGetQuerySuggestions = "GetQuerySuggestions" + +// GetQuerySuggestionsRequest generates a "aws/request.Request" representing the +// client's request for the GetQuerySuggestions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// See ListDataSourceSyncJobs method for more information on how to use this operation. +// 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. // -// Note: This operation can generate multiple requests to a service. +// See GetQuerySuggestions for more information on using the GetQuerySuggestions +// API call, and error handling. // -// // Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation. -// pageNum := 0 -// err := client.ListDataSourceSyncJobsPages(params, -// func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) +// 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. // -func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error { - return c.ListDataSourceSyncJobsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages 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 *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListDataSourceSyncJobsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListDataSourceSyncJobsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListDataSourceSyncJobsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListDataSources = "ListDataSources" - -// ListDataSourcesRequest generates a "aws/request.Request" representing the -// client's request for the ListDataSources 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 ListDataSources for more information on using the ListDataSources -// 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 ListDataSourcesRequest method. -// req, resp := client.ListDataSourcesRequest(params) +// // Example sending a request using the GetQuerySuggestionsRequest method. +// req, resp := client.GetQuerySuggestionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources -func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions +func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput) { op := &request.Operation{ - Name: opListDataSources, + Name: opGetQuerySuggestions, HTTPMethod: "POST", HTTPPath: "/", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "MaxResults", - TruncationToken: "", - }, } if input == nil { - input = &ListDataSourcesInput{} + input = &GetQuerySuggestionsInput{} } - output = &ListDataSourcesOutput{} + output = &GetQuerySuggestionsOutput{} req = c.newRequest(op, input, output) return } -// ListDataSources API operation for AWSKendraFrontendService. +// GetQuerySuggestions API operation for AWSKendraFrontendService. // -// Lists the data sources that you have created. +// Fetches the queries that are suggested to your users. +// +// GetQuerySuggestions is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. // // 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 AWSKendraFrontendService's -// API operation ListDataSources for usage and error information. +// API operation GetQuerySuggestions for usage and error information. // // Returned Error Types: // * ValidationException // // * ResourceNotFoundException // +// * ThrottlingException +// // * AccessDeniedException // -// * ThrottlingException +// * ServiceQuotaExceededException +// +// * ConflictException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources -func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error) { - req, out := c.ListDataSourcesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions +func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error) { + req, out := c.GetQuerySuggestionsRequest(input) return out, req.Send() } -// ListDataSourcesWithContext is the same as ListDataSources with the addition of +// GetQuerySuggestionsWithContext is the same as GetQuerySuggestions with the addition of // the ability to pass a context and additional request options. // -// See ListDataSources for details on how to use this API operation. +// See GetQuerySuggestions 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 *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error) { - req, out := c.ListDataSourcesRequest(input) +func (c *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, error) { + req, out := c.GetQuerySuggestionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDataSourcesPages iterates over the pages of a ListDataSources operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListDataSources 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 ListDataSources operation. -// pageNum := 0 -// err := client.ListDataSourcesPages(params, -// func(page *kendra.ListDataSourcesOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error { - return c.ListDataSourcesPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListDataSourcesPagesWithContext same as ListDataSourcesPages 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 *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListDataSourcesInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListDataSourcesRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListDataSourcesOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListFaqs = "ListFaqs" +const opGetSnapshots = "GetSnapshots" -// ListFaqsRequest generates a "aws/request.Request" representing the -// client's request for the ListFaqs operation. The "output" return +// GetSnapshotsRequest generates a "aws/request.Request" representing the +// client's request for the GetSnapshots 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 ListFaqs for more information on using the ListFaqs +// See GetSnapshots for more information on using the GetSnapshots // 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 ListFaqsRequest method. -// req, resp := client.ListFaqsRequest(params) +// // Example sending a request using the GetSnapshotsRequest method. +// req, resp := client.GetSnapshotsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs -func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots +func (c *Kendra) GetSnapshotsRequest(input *GetSnapshotsInput) (req *request.Request, output *GetSnapshotsOutput) { op := &request.Operation{ - Name: opListFaqs, + Name: opGetSnapshots, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ListFaqsInput{} + input = &GetSnapshotsInput{} } - output = &ListFaqsOutput{} + output = &GetSnapshotsOutput{} req = c.newRequest(op, input, output) return } -// ListFaqs API operation for AWSKendraFrontendService. +// GetSnapshots API operation for AWSKendraFrontendService. // -// Gets a list of FAQ lists associated with an index. +// Retrieves search metrics data. The data provides a snapshot of how your users +// interact with your search application and how effective the application is. // // 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 AWSKendraFrontendService's -// API operation ListFaqs for usage and error information. +// API operation GetSnapshots for usage and error information. // // Returned Error Types: -// * ValidationException +// * InvalidRequestException +// The input to the request is not valid. // // * ResourceNotFoundException // -// * ThrottlingException -// // * AccessDeniedException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs -func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error) { - req, out := c.ListFaqsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots +func (c *Kendra) GetSnapshots(input *GetSnapshotsInput) (*GetSnapshotsOutput, error) { + req, out := c.GetSnapshotsRequest(input) return out, req.Send() } -// ListFaqsWithContext is the same as ListFaqs with the addition of +// GetSnapshotsWithContext is the same as GetSnapshots with the addition of // the ability to pass a context and additional request options. // -// See ListFaqs for details on how to use this API operation. +// See GetSnapshots 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 *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error) { - req, out := c.ListFaqsRequest(input) +func (c *Kendra) GetSnapshotsWithContext(ctx aws.Context, input *GetSnapshotsInput, opts ...request.Option) (*GetSnapshotsOutput, error) { + req, out := c.GetSnapshotsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListGroupsOlderThanOrderingId = "ListGroupsOlderThanOrderingId" +const opListDataSourceSyncJobs = "ListDataSourceSyncJobs" -// ListGroupsOlderThanOrderingIdRequest generates a "aws/request.Request" representing the -// client's request for the ListGroupsOlderThanOrderingId operation. The "output" return +// ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListDataSourceSyncJobs 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 ListGroupsOlderThanOrderingId for more information on using the ListGroupsOlderThanOrderingId +// See ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs // 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 ListGroupsOlderThanOrderingIdRequest method. -// req, resp := client.ListGroupsOlderThanOrderingIdRequest(params) +// // Example sending a request using the ListDataSourceSyncJobsRequest method. +// req, resp := client.ListDataSourceSyncJobsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId -func (c *Kendra) ListGroupsOlderThanOrderingIdRequest(input *ListGroupsOlderThanOrderingIdInput) (req *request.Request, output *ListGroupsOlderThanOrderingIdOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs +func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput) { op := &request.Operation{ - Name: opListGroupsOlderThanOrderingId, + Name: opListDataSourceSyncJobs, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &ListGroupsOlderThanOrderingIdInput{} + input = &ListDataSourceSyncJobsInput{} } - output = &ListGroupsOlderThanOrderingIdOutput{} + output = &ListDataSourceSyncJobsOutput{} req = c.newRequest(op, input, output) return } -// ListGroupsOlderThanOrderingId API operation for AWSKendraFrontendService. +// ListDataSourceSyncJobs API operation for AWSKendraFrontendService. // -// Provides a list of groups that are mapped to users before a given ordering -// or timestamp identifier. +// Gets statistics about synchronizing Amazon Kendra with a data source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation ListGroupsOlderThanOrderingId for usage and error information. +// API operation ListDataSourceSyncJobs for usage and error information. // // Returned Error Types: // * ValidationException // // * ResourceNotFoundException // -// * AccessDeniedException -// // * ThrottlingException // +// * AccessDeniedException +// // * ConflictException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId -func (c *Kendra) ListGroupsOlderThanOrderingId(input *ListGroupsOlderThanOrderingIdInput) (*ListGroupsOlderThanOrderingIdOutput, error) { - req, out := c.ListGroupsOlderThanOrderingIdRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs +func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error) { + req, out := c.ListDataSourceSyncJobsRequest(input) return out, req.Send() } -// ListGroupsOlderThanOrderingIdWithContext is the same as ListGroupsOlderThanOrderingId with the addition of +// ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of // the ability to pass a context and additional request options. // -// See ListGroupsOlderThanOrderingId for details on how to use this API operation. +// See ListDataSourceSyncJobs 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 *Kendra) ListGroupsOlderThanOrderingIdWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, opts ...request.Option) (*ListGroupsOlderThanOrderingIdOutput, error) { - req, out := c.ListGroupsOlderThanOrderingIdRequest(input) +func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error) { + req, out := c.ListDataSourceSyncJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListIndices = "ListIndices" - -// ListIndicesRequest generates a "aws/request.Request" representing the -// client's request for the ListIndices 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 ListIndices for more information on using the ListIndices -// API call, and error handling. +// ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. // -// 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. +// See ListDataSourceSyncJobs method for more information on how to use this operation. // +// Note: This operation can generate multiple requests to a service. // -// // Example sending a request using the ListIndicesRequest method. -// req, resp := client.ListIndicesRequest(params) +// // Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation. +// pageNum := 0 +// err := client.ListDataSourceSyncJobsPages(params, +// func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) // -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } +func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error { + return c.ListDataSourceSyncJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages except +// it takes a Context and allows setting request options on the pages. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices -func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput) { - op := &request.Operation{ - Name: opListIndices, - HTTPMethod: "POST", - HTTPPath: "/", - Paginator: &request.Paginator{ +// 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 *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDataSourceSyncJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDataSourceSyncJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDataSourceSyncJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDataSources = "ListDataSources" + +// ListDataSourcesRequest generates a "aws/request.Request" representing the +// client's request for the ListDataSources 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 ListDataSources for more information on using the ListDataSources +// 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 ListDataSourcesRequest method. +// req, resp := client.ListDataSourcesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources +func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput) { + op := &request.Operation{ + Name: opListDataSources, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, LimitToken: "MaxResults", @@ -2636,93 +3065,95 @@ func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Reque } if input == nil { - input = &ListIndicesInput{} + input = &ListDataSourcesInput{} } - output = &ListIndicesOutput{} + output = &ListDataSourcesOutput{} req = c.newRequest(op, input, output) return } -// ListIndices API operation for AWSKendraFrontendService. +// ListDataSources API operation for AWSKendraFrontendService. // -// Lists the Amazon Kendra indexes that you have created. +// Lists the data sources that you have created. // // 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 AWSKendraFrontendService's -// API operation ListIndices for usage and error information. +// API operation ListDataSources for usage and error information. // // Returned Error Types: // * ValidationException // -// * ThrottlingException +// * ResourceNotFoundException // // * AccessDeniedException // +// * ThrottlingException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices -func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error) { - req, out := c.ListIndicesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources +func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error) { + req, out := c.ListDataSourcesRequest(input) return out, req.Send() } -// ListIndicesWithContext is the same as ListIndices with the addition of +// ListDataSourcesWithContext is the same as ListDataSources with the addition of // the ability to pass a context and additional request options. // -// See ListIndices for details on how to use this API operation. +// See ListDataSources 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 *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error) { - req, out := c.ListIndicesRequest(input) +func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error) { + req, out := c.ListDataSourcesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListIndicesPages iterates over the pages of a ListIndices operation, +// ListDataSourcesPages iterates over the pages of a ListDataSources operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListIndices method for more information on how to use this operation. +// See ListDataSources 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 ListIndices operation. +// // Example iterating over at most 3 pages of a ListDataSources operation. // pageNum := 0 -// err := client.ListIndicesPages(params, -// func(page *kendra.ListIndicesOutput, lastPage bool) bool { +// err := client.ListDataSourcesPages(params, +// func(page *kendra.ListDataSourcesOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error { - return c.ListIndicesPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error { + return c.ListDataSourcesPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListIndicesPagesWithContext same as ListIndicesPages except +// ListDataSourcesPagesWithContext same as ListDataSourcesPages 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 *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error { +func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListIndicesInput + var inCpy *ListDataSourcesInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListIndicesRequest(inCpy) + req, _ := c.ListDataSourcesRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -2730,7 +3161,7 @@ func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndices } for p.Next() { - if !fn(p.Page().(*ListIndicesOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListDataSourcesOutput), !p.HasNextPage()) { break } } @@ -2738,629 +3169,824 @@ func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndices return p.Err() } -const opListQuerySuggestionsBlockLists = "ListQuerySuggestionsBlockLists" +const opListEntityPersonas = "ListEntityPersonas" -// ListQuerySuggestionsBlockListsRequest generates a "aws/request.Request" representing the -// client's request for the ListQuerySuggestionsBlockLists operation. The "output" return +// ListEntityPersonasRequest generates a "aws/request.Request" representing the +// client's request for the ListEntityPersonas 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 ListQuerySuggestionsBlockLists for more information on using the ListQuerySuggestionsBlockLists +// See ListEntityPersonas for more information on using the ListEntityPersonas // 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 ListQuerySuggestionsBlockListsRequest method. -// req, resp := client.ListQuerySuggestionsBlockListsRequest(params) +// // Example sending a request using the ListEntityPersonasRequest method. +// req, resp := client.ListEntityPersonasRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists -func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas +func (c *Kendra) ListEntityPersonasRequest(input *ListEntityPersonasInput) (req *request.Request, output *ListEntityPersonasOutput) { op := &request.Operation{ - Name: opListQuerySuggestionsBlockLists, + Name: opListEntityPersonas, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &ListQuerySuggestionsBlockListsInput{} + input = &ListEntityPersonasInput{} } - output = &ListQuerySuggestionsBlockListsOutput{} + output = &ListEntityPersonasOutput{} req = c.newRequest(op, input, output) return } -// ListQuerySuggestionsBlockLists API operation for AWSKendraFrontendService. -// -// Lists the block lists used for query suggestions for an index. +// ListEntityPersonas API operation for AWSKendraFrontendService. // -// For information on the current quota limits for block lists, see Quotas for -// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). +// Lists specific permissions of users and groups with access to your Amazon +// Kendra experience. // // 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 AWSKendraFrontendService's -// API operation ListQuerySuggestionsBlockLists for usage and error information. +// API operation ListEntityPersonas for usage and error information. // // Returned Error Types: // * ValidationException // // * ResourceNotFoundException // -// * ThrottlingException -// // * AccessDeniedException // +// * ThrottlingException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists -func (c *Kendra) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error) { - req, out := c.ListQuerySuggestionsBlockListsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas +func (c *Kendra) ListEntityPersonas(input *ListEntityPersonasInput) (*ListEntityPersonasOutput, error) { + req, out := c.ListEntityPersonasRequest(input) return out, req.Send() } -// ListQuerySuggestionsBlockListsWithContext is the same as ListQuerySuggestionsBlockLists with the addition of +// ListEntityPersonasWithContext is the same as ListEntityPersonas with the addition of // the ability to pass a context and additional request options. // -// See ListQuerySuggestionsBlockLists for details on how to use this API operation. +// See ListEntityPersonas 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 *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, error) { - req, out := c.ListQuerySuggestionsBlockListsRequest(input) +func (c *Kendra) ListEntityPersonasWithContext(ctx aws.Context, input *ListEntityPersonasInput, opts ...request.Option) (*ListEntityPersonasOutput, error) { + req, out := c.ListEntityPersonasRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListTagsForResource = "ListTagsForResource" +// ListEntityPersonasPages iterates over the pages of a ListEntityPersonas operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListEntityPersonas 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 ListEntityPersonas operation. +// pageNum := 0 +// err := client.ListEntityPersonasPages(params, +// func(page *kendra.ListEntityPersonasOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Kendra) ListEntityPersonasPages(input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool) error { + return c.ListEntityPersonasPagesWithContext(aws.BackgroundContext(), input, fn) +} -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// ListEntityPersonasPagesWithContext same as ListEntityPersonasPages 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 *Kendra) ListEntityPersonasPagesWithContext(ctx aws.Context, input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListEntityPersonasInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListEntityPersonasRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListEntityPersonasOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListExperienceEntities = "ListExperienceEntities" + +// ListExperienceEntitiesRequest generates a "aws/request.Request" representing the +// client's request for the ListExperienceEntities operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See ListExperienceEntities for more information on using the ListExperienceEntities // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the ListExperienceEntitiesRequest method. +// req, resp := client.ListExperienceEntitiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource -func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities +func (c *Kendra) ListExperienceEntitiesRequest(input *ListExperienceEntitiesInput) (req *request.Request, output *ListExperienceEntitiesOutput) { op := &request.Operation{ - Name: opListTagsForResource, + Name: opListExperienceEntities, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "", + TruncationToken: "", + }, } if input == nil { - input = &ListTagsForResourceInput{} + input = &ListExperienceEntitiesInput{} } - output = &ListTagsForResourceOutput{} + output = &ListExperienceEntitiesOutput{} req = c.newRequest(op, input, output) return } -// ListTagsForResource API operation for AWSKendraFrontendService. +// ListExperienceEntities API operation for AWSKendraFrontendService. // -// Gets a list of tags associated with a specified resource. Indexes, FAQs, -// and data sources can have tags associated with them. +// Lists users or groups in your Amazon Web Services SSO identity source that +// are granted access to your Amazon Kendra experience. You can create an Amazon +// Kendra experience such as a search application. For more information on creating +// a search application experience, see Building a search experience with no +// code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation ListTagsForResource for usage and error information. +// API operation ListExperienceEntities for usage and error information. // // Returned Error Types: // * ValidationException // -// * ResourceUnavailableException -// -// * ThrottlingException +// * ResourceNotFoundException // // * AccessDeniedException // +// * ThrottlingException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource -func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities +func (c *Kendra) ListExperienceEntities(input *ListExperienceEntitiesInput) (*ListExperienceEntitiesOutput, error) { + req, out := c.ListExperienceEntitiesRequest(input) return out, req.Send() } -// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// ListExperienceEntitiesWithContext is the same as ListExperienceEntities with the addition of // the ability to pass a context and additional request options. // -// See ListTagsForResource for details on how to use this API operation. +// See ListExperienceEntities 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 *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +func (c *Kendra) ListExperienceEntitiesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, opts ...request.Option) (*ListExperienceEntitiesOutput, error) { + req, out := c.ListExperienceEntitiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListThesauri = "ListThesauri" - -// ListThesauriRequest generates a "aws/request.Request" representing the -// client's request for the ListThesauri 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 ListThesauri for more information on using the ListThesauri -// 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. +// ListExperienceEntitiesPages iterates over the pages of a ListExperienceEntities operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. // +// See ListExperienceEntities method for more information on how to use this operation. // -// // Example sending a request using the ListThesauriRequest method. -// req, resp := client.ListThesauriRequest(params) +// Note: This operation can generate multiple requests to a service. // -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } +// // Example iterating over at most 3 pages of a ListExperienceEntities operation. +// pageNum := 0 +// err := client.ListExperienceEntitiesPages(params, +// func(page *kendra.ListExperienceEntitiesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri -func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput) { - op := &request.Operation{ - Name: opListThesauri, - HTTPMethod: "POST", - HTTPPath: "/", - } +func (c *Kendra) ListExperienceEntitiesPages(input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool) error { + return c.ListExperienceEntitiesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListExperienceEntitiesPagesWithContext same as ListExperienceEntitiesPages 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 *Kendra) ListExperienceEntitiesPagesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListExperienceEntitiesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListExperienceEntitiesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListExperienceEntitiesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListExperiences = "ListExperiences" + +// ListExperiencesRequest generates a "aws/request.Request" representing the +// client's request for the ListExperiences 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 ListExperiences for more information on using the ListExperiences +// 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 ListExperiencesRequest method. +// req, resp := client.ListExperiencesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences +func (c *Kendra) ListExperiencesRequest(input *ListExperiencesInput) (req *request.Request, output *ListExperiencesOutput) { + op := &request.Operation{ + Name: opListExperiences, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } if input == nil { - input = &ListThesauriInput{} + input = &ListExperiencesInput{} } - output = &ListThesauriOutput{} + output = &ListExperiencesOutput{} req = c.newRequest(op, input, output) return } -// ListThesauri API operation for AWSKendraFrontendService. +// ListExperiences API operation for AWSKendraFrontendService. // -// Lists the Amazon Kendra thesauri associated with an index. +// Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra +// experience such as a search application. For more information on creating +// a search application experience, see Building a search experience with no +// code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWSKendraFrontendService's -// API operation ListThesauri for usage and error information. +// API operation ListExperiences for usage and error information. // // Returned Error Types: // * ValidationException // // * ResourceNotFoundException // -// * ThrottlingException -// // * AccessDeniedException // +// * ThrottlingException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri -func (c *Kendra) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error) { - req, out := c.ListThesauriRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences +func (c *Kendra) ListExperiences(input *ListExperiencesInput) (*ListExperiencesOutput, error) { + req, out := c.ListExperiencesRequest(input) return out, req.Send() } -// ListThesauriWithContext is the same as ListThesauri with the addition of +// ListExperiencesWithContext is the same as ListExperiences with the addition of // the ability to pass a context and additional request options. // -// See ListThesauri for details on how to use this API operation. +// See ListExperiences 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 *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error) { - req, out := c.ListThesauriRequest(input) +func (c *Kendra) ListExperiencesWithContext(ctx aws.Context, input *ListExperiencesInput, opts ...request.Option) (*ListExperiencesOutput, error) { + req, out := c.ListExperiencesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opPutPrincipalMapping = "PutPrincipalMapping" +// ListExperiencesPages iterates over the pages of a ListExperiences operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListExperiences 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 ListExperiences operation. +// pageNum := 0 +// err := client.ListExperiencesPages(params, +// func(page *kendra.ListExperiencesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Kendra) ListExperiencesPages(input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool) error { + return c.ListExperiencesPagesWithContext(aws.BackgroundContext(), input, fn) +} -// PutPrincipalMappingRequest generates a "aws/request.Request" representing the -// client's request for the PutPrincipalMapping operation. The "output" return +// ListExperiencesPagesWithContext same as ListExperiencesPages 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 *Kendra) ListExperiencesPagesWithContext(ctx aws.Context, input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListExperiencesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListExperiencesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListExperiencesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListFaqs = "ListFaqs" + +// ListFaqsRequest generates a "aws/request.Request" representing the +// client's request for the ListFaqs 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 PutPrincipalMapping for more information on using the PutPrincipalMapping +// See ListFaqs for more information on using the ListFaqs // 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 PutPrincipalMappingRequest method. -// req, resp := client.PutPrincipalMappingRequest(params) +// // Example sending a request using the ListFaqsRequest method. +// req, resp := client.ListFaqsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping -func (c *Kendra) PutPrincipalMappingRequest(input *PutPrincipalMappingInput) (req *request.Request, output *PutPrincipalMappingOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs +func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput) { op := &request.Operation{ - Name: opPutPrincipalMapping, + Name: opListFaqs, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &PutPrincipalMappingInput{} + input = &ListFaqsInput{} } - output = &PutPrincipalMappingOutput{} + output = &ListFaqsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// PutPrincipalMapping API operation for AWSKendraFrontendService. -// -// Maps users to their groups so that you only need to provide the user ID when -// you issue the query. -// -// You can also map sub groups to groups. For example, the group "Company Intellectual -// Property Teams" includes sub groups "Research" and "Engineering". These sub -// groups include their own list of users or people who work in these teams. -// Only users who work in research and engineering, and therefore belong in -// the intellectual property group, can see top-secret company documents in -// their search results. -// -// You map users to their groups when you want to filter search results for -// different users based on their group’s access to documents. For more information -// on filtering search results for different users, see Filtering on user context -// (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). +// ListFaqs API operation for AWSKendraFrontendService. // -// If more than five PUT actions for a group are currently processing, a validation -// exception is thrown. +// Gets a list of FAQ lists associated with an index. // // 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 AWSKendraFrontendService's -// API operation PutPrincipalMapping for usage and error information. +// API operation ListFaqs for usage and error information. // // Returned Error Types: // * ValidationException // -// * ConflictException -// // * ResourceNotFoundException // // * ThrottlingException // // * AccessDeniedException // -// * ServiceQuotaExceededException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping -func (c *Kendra) PutPrincipalMapping(input *PutPrincipalMappingInput) (*PutPrincipalMappingOutput, error) { - req, out := c.PutPrincipalMappingRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs +func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error) { + req, out := c.ListFaqsRequest(input) return out, req.Send() } -// PutPrincipalMappingWithContext is the same as PutPrincipalMapping with the addition of +// ListFaqsWithContext is the same as ListFaqs with the addition of // the ability to pass a context and additional request options. // -// See PutPrincipalMapping for details on how to use this API operation. +// See ListFaqs 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 *Kendra) PutPrincipalMappingWithContext(ctx aws.Context, input *PutPrincipalMappingInput, opts ...request.Option) (*PutPrincipalMappingOutput, error) { - req, out := c.PutPrincipalMappingRequest(input) +func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error) { + req, out := c.ListFaqsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opQuery = "Query" +const opListGroupsOlderThanOrderingId = "ListGroupsOlderThanOrderingId" -// QueryRequest generates a "aws/request.Request" representing the -// client's request for the Query operation. The "output" return +// ListGroupsOlderThanOrderingIdRequest generates a "aws/request.Request" representing the +// client's request for the ListGroupsOlderThanOrderingId 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 Query for more information on using the Query +// See ListGroupsOlderThanOrderingId for more information on using the ListGroupsOlderThanOrderingId // 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 QueryRequest method. -// req, resp := client.QueryRequest(params) +// // Example sending a request using the ListGroupsOlderThanOrderingIdRequest method. +// req, resp := client.ListGroupsOlderThanOrderingIdRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query -func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId +func (c *Kendra) ListGroupsOlderThanOrderingIdRequest(input *ListGroupsOlderThanOrderingIdInput) (req *request.Request, output *ListGroupsOlderThanOrderingIdOutput) { op := &request.Operation{ - Name: opQuery, + Name: opListGroupsOlderThanOrderingId, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &QueryInput{} + input = &ListGroupsOlderThanOrderingIdInput{} } - output = &QueryOutput{} + output = &ListGroupsOlderThanOrderingIdOutput{} req = c.newRequest(op, input, output) return } -// Query API operation for AWSKendraFrontendService. -// -// Searches an active index. Use this API to search your documents using query. -// The Query operation enables to do faceted search and to filter results based -// on document attributes. -// -// It also enables you to provide user context that Amazon Kendra uses to enforce -// document access control in the search results. -// -// Amazon Kendra searches your index for text content and question and answer -// (FAQ) content. By default the response contains three types of results. -// -// * Relevant passages -// -// * Matching FAQs -// -// * Relevant documents +// ListGroupsOlderThanOrderingId API operation for AWSKendraFrontendService. // -// You can specify that the query return only one type of result using the QueryResultTypeConfig -// parameter. +// Provides a list of groups that are mapped to users before a given ordering +// or timestamp identifier. // -// Each query returns the 100 most relevant results. +// ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. // // 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 AWSKendraFrontendService's -// API operation Query for usage and error information. +// API operation ListGroupsOlderThanOrderingId for usage and error information. // // Returned Error Types: // * ValidationException // -// * ConflictException -// // * ResourceNotFoundException // -// * ThrottlingException -// // * AccessDeniedException // -// * ServiceQuotaExceededException +// * ThrottlingException +// +// * ConflictException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query -func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error) { - req, out := c.QueryRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId +func (c *Kendra) ListGroupsOlderThanOrderingId(input *ListGroupsOlderThanOrderingIdInput) (*ListGroupsOlderThanOrderingIdOutput, error) { + req, out := c.ListGroupsOlderThanOrderingIdRequest(input) return out, req.Send() } -// QueryWithContext is the same as Query with the addition of +// ListGroupsOlderThanOrderingIdWithContext is the same as ListGroupsOlderThanOrderingId with the addition of // the ability to pass a context and additional request options. // -// See Query for details on how to use this API operation. +// See ListGroupsOlderThanOrderingId 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 *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error) { - req, out := c.QueryRequest(input) +func (c *Kendra) ListGroupsOlderThanOrderingIdWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, opts ...request.Option) (*ListGroupsOlderThanOrderingIdOutput, error) { + req, out := c.ListGroupsOlderThanOrderingIdRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartDataSourceSyncJob = "StartDataSourceSyncJob" +const opListIndices = "ListIndices" -// StartDataSourceSyncJobRequest generates a "aws/request.Request" representing the -// client's request for the StartDataSourceSyncJob operation. The "output" return +// ListIndicesRequest generates a "aws/request.Request" representing the +// client's request for the ListIndices 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 StartDataSourceSyncJob for more information on using the StartDataSourceSyncJob +// See ListIndices for more information on using the ListIndices // 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 StartDataSourceSyncJobRequest method. -// req, resp := client.StartDataSourceSyncJobRequest(params) +// // Example sending a request using the ListIndicesRequest method. +// req, resp := client.ListIndicesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob -func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices +func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput) { op := &request.Operation{ - Name: opStartDataSourceSyncJob, + Name: opListIndices, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &StartDataSourceSyncJobInput{} + input = &ListIndicesInput{} } - output = &StartDataSourceSyncJobOutput{} + output = &ListIndicesOutput{} req = c.newRequest(op, input, output) return } -// StartDataSourceSyncJob API operation for AWSKendraFrontendService. +// ListIndices API operation for AWSKendraFrontendService. // -// Starts a synchronization job for a data source. If a synchronization job -// is already in progress, Amazon Kendra returns a ResourceInUseException exception. +// Lists the Amazon Kendra indexes that you have created. // // 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 AWSKendraFrontendService's -// API operation StartDataSourceSyncJob for usage and error information. +// API operation ListIndices for usage and error information. // // Returned Error Types: // * ValidationException // -// * ResourceNotFoundException -// -// * ResourceInUseException -// // * ThrottlingException // // * AccessDeniedException // -// * ConflictException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob -func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error) { - req, out := c.StartDataSourceSyncJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices +func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error) { + req, out := c.ListIndicesRequest(input) return out, req.Send() } -// StartDataSourceSyncJobWithContext is the same as StartDataSourceSyncJob with the addition of +// ListIndicesWithContext is the same as ListIndices with the addition of // the ability to pass a context and additional request options. // -// See StartDataSourceSyncJob for details on how to use this API operation. +// See ListIndices 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 *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error) { - req, out := c.StartDataSourceSyncJobRequest(input) +func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error) { + req, out := c.ListIndicesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopDataSourceSyncJob = "StopDataSourceSyncJob" +// ListIndicesPages iterates over the pages of a ListIndices operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListIndices 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 ListIndices operation. +// pageNum := 0 +// err := client.ListIndicesPages(params, +// func(page *kendra.ListIndicesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error { + return c.ListIndicesPagesWithContext(aws.BackgroundContext(), input, fn) +} -// StopDataSourceSyncJobRequest generates a "aws/request.Request" representing the -// client's request for the StopDataSourceSyncJob operation. The "output" return +// ListIndicesPagesWithContext same as ListIndicesPages 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 *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListIndicesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListIndicesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListIndicesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListQuerySuggestionsBlockLists = "ListQuerySuggestionsBlockLists" + +// ListQuerySuggestionsBlockListsRequest generates a "aws/request.Request" representing the +// client's request for the ListQuerySuggestionsBlockLists 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 StopDataSourceSyncJob for more information on using the StopDataSourceSyncJob +// See ListQuerySuggestionsBlockLists for more information on using the ListQuerySuggestionsBlockLists // 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 StopDataSourceSyncJobRequest method. -// req, resp := client.StopDataSourceSyncJobRequest(params) +// // Example sending a request using the ListQuerySuggestionsBlockListsRequest method. +// req, resp := client.ListQuerySuggestionsBlockListsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob -func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists +func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput) { op := &request.Operation{ - Name: opStopDataSourceSyncJob, + Name: opListQuerySuggestionsBlockLists, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopDataSourceSyncJobInput{} + input = &ListQuerySuggestionsBlockListsInput{} } - output = &StopDataSourceSyncJobOutput{} + output = &ListQuerySuggestionsBlockListsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// StopDataSourceSyncJob API operation for AWSKendraFrontendService. +// ListQuerySuggestionsBlockLists API operation for AWSKendraFrontendService. // -// Stops a running synchronization job. You can't stop a scheduled synchronization -// job. +// Lists the block lists used for query suggestions for an index. +// +// For information on the current quota limits for block lists, see Quotas for +// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). +// +// ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. // // 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 AWSKendraFrontendService's -// API operation StopDataSourceSyncJob for usage and error information. +// API operation ListQuerySuggestionsBlockLists for usage and error information. // // Returned Error Types: // * ValidationException @@ -3373,177 +3999,172 @@ func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob -func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error) { - req, out := c.StopDataSourceSyncJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists +func (c *Kendra) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error) { + req, out := c.ListQuerySuggestionsBlockListsRequest(input) return out, req.Send() } -// StopDataSourceSyncJobWithContext is the same as StopDataSourceSyncJob with the addition of +// ListQuerySuggestionsBlockListsWithContext is the same as ListQuerySuggestionsBlockLists with the addition of // the ability to pass a context and additional request options. // -// See StopDataSourceSyncJob for details on how to use this API operation. +// See ListQuerySuggestionsBlockLists 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 *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error) { - req, out := c.StopDataSourceSyncJobRequest(input) +func (c *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, error) { + req, out := c.ListQuerySuggestionsBlockListsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opSubmitFeedback = "SubmitFeedback" +const opListTagsForResource = "ListTagsForResource" -// SubmitFeedbackRequest generates a "aws/request.Request" representing the -// client's request for the SubmitFeedback operation. The "output" return +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See SubmitFeedback for more information on using the SubmitFeedback +// See ListTagsForResource for more information on using the ListTagsForResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the SubmitFeedbackRequest method. -// req, resp := client.SubmitFeedbackRequest(params) +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback -func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource +func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { op := &request.Operation{ - Name: opSubmitFeedback, + Name: opListTagsForResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &SubmitFeedbackInput{} + input = &ListTagsForResourceInput{} } - output = &SubmitFeedbackOutput{} + output = &ListTagsForResourceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// SubmitFeedback API operation for AWSKendraFrontendService. +// ListTagsForResource API operation for AWSKendraFrontendService. // -// Enables you to provide feedback to Amazon Kendra to improve the performance -// of your index. +// Gets a list of tags associated with a specified resource. Indexes, FAQs, +// and data sources can have tags associated with them. // // 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 AWSKendraFrontendService's -// API operation SubmitFeedback for usage and error information. +// API operation ListTagsForResource for usage and error information. // // Returned Error Types: // * ValidationException // // * ResourceUnavailableException // -// * ResourceNotFoundException -// // * ThrottlingException // // * AccessDeniedException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback -func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error) { - req, out := c.SubmitFeedbackRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource +func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) return out, req.Send() } -// SubmitFeedbackWithContext is the same as SubmitFeedback with the addition of +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of // the ability to pass a context and additional request options. // -// See SubmitFeedback for details on how to use this API operation. +// See ListTagsForResource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error) { - req, out := c.SubmitFeedbackRequest(input) +func (c *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTagResource = "TagResource" +const opListThesauri = "ListThesauri" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// ListThesauriRequest generates a "aws/request.Request" representing the +// client's request for the ListThesauri 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 ListThesauri for more information on using the ListThesauri // 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 ListThesauriRequest method. +// req, resp := client.ListThesauriRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource -func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri +func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opListThesauri, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &TagResourceInput{} + input = &ListThesauriInput{} } - output = &TagResourceOutput{} + output = &ListThesauriOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for AWSKendraFrontendService. +// ListThesauri API operation for AWSKendraFrontendService. // -// Adds the specified tag to the specified index, FAQ, or data source resource. -// If the tag already exists, the existing value is replaced with the new value. +// Lists the Amazon Kendra thesauri associated with an index. // // 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 AWSKendraFrontendService's -// API operation TagResource for usage and error information. +// API operation ListThesauri for usage and error information. // // Returned Error Types: // * ValidationException // -// * ResourceUnavailableException +// * ResourceNotFoundException // // * ThrottlingException // @@ -3551,168 +4172,209 @@ func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Reque // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource -func (c *Kendra) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri +func (c *Kendra) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error) { + req, out := c.ListThesauriRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// ListThesauriWithContext is the same as ListThesauri 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 ListThesauri 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 *Kendra) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error) { + req, out := c.ListThesauriRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +const opPutPrincipalMapping = "PutPrincipalMapping" -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// PutPrincipalMappingRequest generates a "aws/request.Request" representing the +// client's request for the PutPrincipalMapping 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 PutPrincipalMapping for more information on using the PutPrincipalMapping // 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 PutPrincipalMappingRequest method. +// req, resp := client.PutPrincipalMappingRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource -func (c *Kendra) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping +func (c *Kendra) PutPrincipalMappingRequest(input *PutPrincipalMappingInput) (req *request.Request, output *PutPrincipalMappingOutput) { op := &request.Operation{ - Name: opUntagResource, + Name: opPutPrincipalMapping, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UntagResourceInput{} + input = &PutPrincipalMappingInput{} } - output = &UntagResourceOutput{} + output = &PutPrincipalMappingOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for AWSKendraFrontendService. +// PutPrincipalMapping API operation for AWSKendraFrontendService. // -// Removes a tag from an index, FAQ, or a data source. +// Maps users to their groups so that you only need to provide the user ID when +// you issue the query. +// +// You can also map sub groups to groups. For example, the group "Company Intellectual +// Property Teams" includes sub groups "Research" and "Engineering". These sub +// groups include their own list of users or people who work in these teams. +// Only users who work in research and engineering, and therefore belong in +// the intellectual property group, can see top-secret company documents in +// their search results. +// +// You map users to their groups when you want to filter search results for +// different users based on their group’s access to documents. For more information +// on filtering search results for different users, see Filtering on user context +// (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). +// +// If more than five PUT actions for a group are currently processing, a validation +// exception is thrown. +// +// PutPrincipalMapping is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. // // 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 AWSKendraFrontendService's -// API operation UntagResource for usage and error information. +// API operation PutPrincipalMapping for usage and error information. // // Returned Error Types: // * ValidationException // -// * ResourceUnavailableException +// * ConflictException +// +// * ResourceNotFoundException // // * ThrottlingException // // * AccessDeniedException // +// * ServiceQuotaExceededException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource -func (c *Kendra) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping +func (c *Kendra) PutPrincipalMapping(input *PutPrincipalMappingInput) (*PutPrincipalMappingOutput, error) { + req, out := c.PutPrincipalMappingRequest(input) return out, req.Send() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// PutPrincipalMappingWithContext is the same as PutPrincipalMapping 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 PutPrincipalMapping 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 *Kendra) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *Kendra) PutPrincipalMappingWithContext(ctx aws.Context, input *PutPrincipalMappingInput, opts ...request.Option) (*PutPrincipalMappingOutput, error) { + req, out := c.PutPrincipalMappingRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateDataSource = "UpdateDataSource" +const opQuery = "Query" -// UpdateDataSourceRequest generates a "aws/request.Request" representing the -// client's request for the UpdateDataSource operation. The "output" return +// QueryRequest generates a "aws/request.Request" representing the +// client's request for the Query 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 UpdateDataSource for more information on using the UpdateDataSource +// See Query for more information on using the Query // 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 UpdateDataSourceRequest method. -// req, resp := client.UpdateDataSourceRequest(params) +// // Example sending a request using the QueryRequest method. +// req, resp := client.QueryRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource -func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query +func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput) { op := &request.Operation{ - Name: opUpdateDataSource, + Name: opQuery, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateDataSourceInput{} + input = &QueryInput{} } - output = &UpdateDataSourceOutput{} + output = &QueryOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateDataSource API operation for AWSKendraFrontendService. +// Query API operation for AWSKendraFrontendService. // -// Updates an existing Amazon Kendra data source. +// Searches an active index. Use this API to search your documents using query. +// The Query operation enables to do faceted search and to filter results based +// on document attributes. +// +// It also enables you to provide user context that Amazon Kendra uses to enforce +// document access control in the search results. +// +// Amazon Kendra searches your index for text content and question and answer +// (FAQ) content. By default the response contains three types of results. +// +// * Relevant passages +// +// * Matching FAQs +// +// * Relevant documents +// +// You can specify that the query return only one type of result using the QueryResultTypeConfig +// parameter. +// +// Each query returns the 100 most relevant results. // // 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 AWSKendraFrontendService's -// API operation UpdateDataSource for usage and error information. +// API operation Query for usage and error information. // // Returned Error Types: // * ValidationException @@ -3725,184 +4387,177 @@ func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *req // // * AccessDeniedException // +// * ServiceQuotaExceededException +// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource -func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error) { - req, out := c.UpdateDataSourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query +func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error) { + req, out := c.QueryRequest(input) return out, req.Send() } -// UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of +// QueryWithContext is the same as Query with the addition of // the ability to pass a context and additional request options. // -// See UpdateDataSource for details on how to use this API operation. +// See Query 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 *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error) { - req, out := c.UpdateDataSourceRequest(input) +func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error) { + req, out := c.QueryRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateIndex = "UpdateIndex" +const opStartDataSourceSyncJob = "StartDataSourceSyncJob" -// UpdateIndexRequest generates a "aws/request.Request" representing the -// client's request for the UpdateIndex operation. The "output" return +// StartDataSourceSyncJobRequest generates a "aws/request.Request" representing the +// client's request for the StartDataSourceSyncJob 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 UpdateIndex for more information on using the UpdateIndex +// See StartDataSourceSyncJob for more information on using the StartDataSourceSyncJob // 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 UpdateIndexRequest method. -// req, resp := client.UpdateIndexRequest(params) +// // Example sending a request using the StartDataSourceSyncJobRequest method. +// req, resp := client.StartDataSourceSyncJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex -func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob +func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput) { op := &request.Operation{ - Name: opUpdateIndex, + Name: opStartDataSourceSyncJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateIndexInput{} + input = &StartDataSourceSyncJobInput{} } - output = &UpdateIndexOutput{} + output = &StartDataSourceSyncJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateIndex API operation for AWSKendraFrontendService. +// StartDataSourceSyncJob API operation for AWSKendraFrontendService. // -// Updates an existing Amazon Kendra index. +// Starts a synchronization job for a data source. If a synchronization job +// is already in progress, Amazon Kendra returns a ResourceInUseException exception. // // 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 AWSKendraFrontendService's -// API operation UpdateIndex for usage and error information. +// API operation StartDataSourceSyncJob for usage and error information. // // Returned Error Types: // * ValidationException // -// * ConflictException -// // * ResourceNotFoundException // +// * ResourceInUseException +// // * ThrottlingException // // * AccessDeniedException // -// * ServiceQuotaExceededException +// * ConflictException // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex -func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error) { - req, out := c.UpdateIndexRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob +func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error) { + req, out := c.StartDataSourceSyncJobRequest(input) return out, req.Send() } -// UpdateIndexWithContext is the same as UpdateIndex with the addition of +// StartDataSourceSyncJobWithContext is the same as StartDataSourceSyncJob with the addition of // the ability to pass a context and additional request options. // -// See UpdateIndex for details on how to use this API operation. +// See StartDataSourceSyncJob 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 *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error) { - req, out := c.UpdateIndexRequest(input) +func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error) { + req, out := c.StartDataSourceSyncJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateQuerySuggestionsBlockList = "UpdateQuerySuggestionsBlockList" +const opStopDataSourceSyncJob = "StopDataSourceSyncJob" -// UpdateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the -// client's request for the UpdateQuerySuggestionsBlockList operation. The "output" return +// StopDataSourceSyncJobRequest generates a "aws/request.Request" representing the +// client's request for the StopDataSourceSyncJob 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 UpdateQuerySuggestionsBlockList for more information on using the UpdateQuerySuggestionsBlockList +// See StopDataSourceSyncJob for more information on using the StopDataSourceSyncJob // 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 UpdateQuerySuggestionsBlockListRequest method. -// req, resp := client.UpdateQuerySuggestionsBlockListRequest(params) +// // Example sending a request using the StopDataSourceSyncJobRequest method. +// req, resp := client.StopDataSourceSyncJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList -func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySuggestionsBlockListInput) (req *request.Request, output *UpdateQuerySuggestionsBlockListOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob +func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput) { op := &request.Operation{ - Name: opUpdateQuerySuggestionsBlockList, + Name: opStopDataSourceSyncJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateQuerySuggestionsBlockListInput{} + input = &StopDataSourceSyncJobInput{} } - output = &UpdateQuerySuggestionsBlockListOutput{} + output = &StopDataSourceSyncJobOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateQuerySuggestionsBlockList API operation for AWSKendraFrontendService. -// -// Updates a block list used for query suggestions for an index. -// -// Updates to a block list might not take effect right away. Amazon Kendra needs -// to refresh the entire suggestions list to apply any updates to the block -// list. Other changes not related to the block list apply immediately. -// -// If a block list is updating, then you need to wait for the first update to -// finish before submitting another update. +// StopDataSourceSyncJob API operation for AWSKendraFrontendService. // -// Amazon Kendra supports partial updates, so you only need to provide the fields -// you want to update. +// Stops a running synchronization job. You can't stop a scheduled synchronization +// 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 AWSKendraFrontendService's -// API operation UpdateQuerySuggestionsBlockList for usage and error information. +// API operation StopDataSourceSyncJob for usage and error information. // // Returned Error Types: // * ValidationException @@ -3913,102 +4568,92 @@ func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySugges // // * AccessDeniedException // -// * ConflictException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList -func (c *Kendra) UpdateQuerySuggestionsBlockList(input *UpdateQuerySuggestionsBlockListInput) (*UpdateQuerySuggestionsBlockListOutput, error) { - req, out := c.UpdateQuerySuggestionsBlockListRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob +func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error) { + req, out := c.StopDataSourceSyncJobRequest(input) return out, req.Send() } -// UpdateQuerySuggestionsBlockListWithContext is the same as UpdateQuerySuggestionsBlockList with the addition of +// StopDataSourceSyncJobWithContext is the same as StopDataSourceSyncJob with the addition of // the ability to pass a context and additional request options. // -// See UpdateQuerySuggestionsBlockList for details on how to use this API operation. +// See StopDataSourceSyncJob 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 *Kendra) UpdateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *UpdateQuerySuggestionsBlockListInput, opts ...request.Option) (*UpdateQuerySuggestionsBlockListOutput, error) { - req, out := c.UpdateQuerySuggestionsBlockListRequest(input) +func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error) { + req, out := c.StopDataSourceSyncJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateQuerySuggestionsConfig = "UpdateQuerySuggestionsConfig" +const opSubmitFeedback = "SubmitFeedback" -// UpdateQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the -// client's request for the UpdateQuerySuggestionsConfig operation. The "output" return +// SubmitFeedbackRequest generates a "aws/request.Request" representing the +// client's request for the SubmitFeedback 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 UpdateQuerySuggestionsConfig for more information on using the UpdateQuerySuggestionsConfig +// See SubmitFeedback for more information on using the SubmitFeedback // 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 UpdateQuerySuggestionsConfigRequest method. -// req, resp := client.UpdateQuerySuggestionsConfigRequest(params) +// // Example sending a request using the SubmitFeedbackRequest method. +// req, resp := client.SubmitFeedbackRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig -func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestionsConfigInput) (req *request.Request, output *UpdateQuerySuggestionsConfigOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback +func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput) { op := &request.Operation{ - Name: opUpdateQuerySuggestionsConfig, + Name: opSubmitFeedback, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateQuerySuggestionsConfigInput{} + input = &SubmitFeedbackInput{} } - output = &UpdateQuerySuggestionsConfigOutput{} + output = &SubmitFeedbackOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateQuerySuggestionsConfig API operation for AWSKendraFrontendService. -// -// Updates the settings of query suggestions for an index. -// -// Amazon Kendra supports partial updates, so you only need to provide the fields -// you want to update. -// -// If an update is currently processing (i.e. 'happening'), you need to wait -// for the update to finish before making another update. +// SubmitFeedback API operation for AWSKendraFrontendService. // -// Updates to query suggestions settings might not take effect right away. The -// time for your updated settings to take effect depends on the updates made -// and the number of search queries in your index. +// Enables you to provide feedback to Amazon Kendra to improve the performance +// of your index. // -// You can still enable/disable query suggestions at any time. +// SubmitFeedback is currently not supported in the Amazon Web Services GovCloud +// (US-West) region. // // 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 AWSKendraFrontendService's -// API operation UpdateQuerySuggestionsConfig for usage and error information. +// API operation SubmitFeedback for usage and error information. // // Returned Error Types: // * ValidationException // -// * ConflictException +// * ResourceUnavailableException // // * ResourceNotFoundException // @@ -4018,237 +4663,3757 @@ func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestio // // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig -func (c *Kendra) UpdateQuerySuggestionsConfig(input *UpdateQuerySuggestionsConfigInput) (*UpdateQuerySuggestionsConfigOutput, error) { - req, out := c.UpdateQuerySuggestionsConfigRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback +func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error) { + req, out := c.SubmitFeedbackRequest(input) return out, req.Send() } -// UpdateQuerySuggestionsConfigWithContext is the same as UpdateQuerySuggestionsConfig with the addition of +// SubmitFeedbackWithContext is the same as SubmitFeedback with the addition of // the ability to pass a context and additional request options. // -// See UpdateQuerySuggestionsConfig for details on how to use this API operation. +// See SubmitFeedback 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 *Kendra) UpdateQuerySuggestionsConfigWithContext(ctx aws.Context, input *UpdateQuerySuggestionsConfigInput, opts ...request.Option) (*UpdateQuerySuggestionsConfigOutput, error) { - req, out := c.UpdateQuerySuggestionsConfigRequest(input) +func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error) { + req, out := c.SubmitFeedbackRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateThesaurus = "UpdateThesaurus" +const opTagResource = "TagResource" -// UpdateThesaurusRequest generates a "aws/request.Request" representing the -// client's request for the UpdateThesaurus operation. The "output" return +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateThesaurus for more information on using the UpdateThesaurus +// 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 UpdateThesaurusRequest method. -// req, resp := client.UpdateThesaurusRequest(params) +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus -func (c *Kendra) UpdateThesaurusRequest(input *UpdateThesaurusInput) (req *request.Request, output *UpdateThesaurusOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource +func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { op := &request.Operation{ - Name: opUpdateThesaurus, + Name: opTagResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateThesaurusInput{} + input = &TagResourceInput{} } - output = &UpdateThesaurusOutput{} + output = &TagResourceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateThesaurus API operation for AWSKendraFrontendService. +// TagResource API operation for AWSKendraFrontendService. // -// Updates a thesaurus file associated with an index. +// Adds the specified tag to the specified index, FAQ, or data source resource. +// If the tag already exists, the existing value is replaced with the new value. // // 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 AWSKendraFrontendService's -// API operation UpdateThesaurus for usage and error information. +// API operation TagResource for usage and error information. // // Returned Error Types: // * ValidationException // -// * ResourceNotFoundException +// * ResourceUnavailableException // // * ThrottlingException // // * AccessDeniedException // -// * ConflictException -// // * InternalServerException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus -func (c *Kendra) UpdateThesaurus(input *UpdateThesaurusInput) (*UpdateThesaurusOutput, error) { - req, out := c.UpdateThesaurusRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource +func (c *Kendra) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) return out, req.Send() } -// UpdateThesaurusWithContext is the same as UpdateThesaurus with the addition of +// TagResourceWithContext is the same as TagResource with the addition of // the ability to pass a context and additional request options. // -// See UpdateThesaurus 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 *Kendra) UpdateThesaurusWithContext(ctx aws.Context, input *UpdateThesaurusInput, opts ...request.Option) (*UpdateThesaurusOutput, error) { - req, out := c.UpdateThesaurusRequest(input) +func (c *Kendra) 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() } -// Access Control List files for the documents in a data source. For the format -// of the file, see Access control for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html). -type AccessControlListConfiguration struct { - _ struct{} `type:"structure"` - - // Path to the Amazon Web Services S3 bucket that contains the ACL files. - KeyPath *string `min:"1" type:"string"` -} +const opUntagResource = "UntagResource" -// String returns the string representation. +// 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. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AccessControlListConfiguration) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. +// 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. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AccessControlListConfiguration) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *AccessControlListConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AccessControlListConfiguration"} - if s.KeyPath != nil && len(*s.KeyPath) < 1 { - invalidParams.Add(request.NewErrParamMinLen("KeyPath", 1)) +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the 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/kendra-2019-02-03/UntagResource +func (c *Kendra) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", } - if invalidParams.Len() > 0 { - return invalidParams + if input == nil { + input = &UntagResourceInput{} } - return nil -} - -// SetKeyPath sets the KeyPath field's value. -func (s *AccessControlListConfiguration) SetKeyPath(v string) *AccessControlListConfiguration { - s.KeyPath = &v - return s -} - -type AccessDeniedException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - Message_ *string `locationName:"Message" min:"1" type:"string"` + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return } -// String returns the string representation. +// UntagResource API operation for AWSKendraFrontendService. // -// API parameter values that are decorated as "sensitive" in the API 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. +// Removes a tag from an index, FAQ, or a data source. // -// API parameter values that are decorated as "sensitive" in the API 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() +// 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 AWSKendraFrontendService's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceUnavailableException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource +func (c *Kendra) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ - RespMetadata: v, - } +// 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 *Kendra) 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() } -// Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" -} +const opUpdateDataSource = "UpdateDataSource" -// Message returns the exception's message. -func (s *AccessDeniedException) Message() string { - if s.Message_ != nil { - return *s.Message_ +// UpdateDataSourceRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDataSource 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 UpdateDataSource for more information on using the UpdateDataSource +// 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 UpdateDataSourceRequest method. +// req, resp := client.UpdateDataSourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource +func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput) { + op := &request.Operation{ + Name: opUpdateDataSource, + HTTPMethod: "POST", + HTTPPath: "/", } - 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()) -} + if input == nil { + input = &UpdateDataSourceInput{} + } -// Status code returns the HTTP status code for the request's response error. -func (s *AccessDeniedException) StatusCode() int { - return s.RespMetadata.StatusCode + output = &UpdateDataSourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return } -// RequestID returns the service's response RequestID for request. -func (s *AccessDeniedException) RequestID() string { - return s.RespMetadata.RequestID +// UpdateDataSource API operation for AWSKendraFrontendService. +// +// Updates an existing Amazon Kendra data source. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation UpdateDataSource for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource +func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error) { + req, out := c.UpdateDataSourceRequest(input) + return out, req.Send() +} + +// UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDataSource 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 *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error) { + req, out := c.UpdateDataSourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateExperience = "UpdateExperience" + +// UpdateExperienceRequest generates a "aws/request.Request" representing the +// client's request for the UpdateExperience 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 UpdateExperience for more information on using the UpdateExperience +// 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 UpdateExperienceRequest method. +// req, resp := client.UpdateExperienceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience +func (c *Kendra) UpdateExperienceRequest(input *UpdateExperienceInput) (req *request.Request, output *UpdateExperienceOutput) { + op := &request.Operation{ + Name: opUpdateExperience, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateExperienceInput{} + } + + output = &UpdateExperienceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateExperience API operation for AWSKendraFrontendService. +// +// Updates your Amazon Kendra experience such as a search application. For more +// information on creating a search application experience, see Building a search +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWSKendraFrontendService's +// API operation UpdateExperience for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience +func (c *Kendra) UpdateExperience(input *UpdateExperienceInput) (*UpdateExperienceOutput, error) { + req, out := c.UpdateExperienceRequest(input) + return out, req.Send() +} + +// UpdateExperienceWithContext is the same as UpdateExperience with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateExperience 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 *Kendra) UpdateExperienceWithContext(ctx aws.Context, input *UpdateExperienceInput, opts ...request.Option) (*UpdateExperienceOutput, error) { + req, out := c.UpdateExperienceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateIndex = "UpdateIndex" + +// UpdateIndexRequest generates a "aws/request.Request" representing the +// client's request for the UpdateIndex 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 UpdateIndex for more information on using the UpdateIndex +// 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 UpdateIndexRequest method. +// req, resp := client.UpdateIndexRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex +func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput) { + op := &request.Operation{ + Name: opUpdateIndex, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateIndexInput{} + } + + output = &UpdateIndexOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateIndex API operation for AWSKendraFrontendService. +// +// Updates an existing Amazon Kendra index. +// +// 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 AWSKendraFrontendService's +// API operation UpdateIndex for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * ServiceQuotaExceededException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex +func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error) { + req, out := c.UpdateIndexRequest(input) + return out, req.Send() +} + +// UpdateIndexWithContext is the same as UpdateIndex with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateIndex 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 *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error) { + req, out := c.UpdateIndexRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateQuerySuggestionsBlockList = "UpdateQuerySuggestionsBlockList" + +// UpdateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the +// client's request for the UpdateQuerySuggestionsBlockList 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 UpdateQuerySuggestionsBlockList for more information on using the UpdateQuerySuggestionsBlockList +// 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 UpdateQuerySuggestionsBlockListRequest method. +// req, resp := client.UpdateQuerySuggestionsBlockListRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList +func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySuggestionsBlockListInput) (req *request.Request, output *UpdateQuerySuggestionsBlockListOutput) { + op := &request.Operation{ + Name: opUpdateQuerySuggestionsBlockList, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateQuerySuggestionsBlockListInput{} + } + + output = &UpdateQuerySuggestionsBlockListOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateQuerySuggestionsBlockList API operation for AWSKendraFrontendService. +// +// Updates a block list used for query suggestions for an index. +// +// Updates to a block list might not take effect right away. Amazon Kendra needs +// to refresh the entire suggestions list to apply any updates to the block +// list. Other changes not related to the block list apply immediately. +// +// If a block list is updating, then you need to wait for the first update to +// finish before submitting another update. +// +// Amazon Kendra supports partial updates, so you only need to provide the fields +// you want to update. +// +// UpdateQuerySuggestionsBlockList is currently not supported in the Amazon +// Web Services GovCloud (US-West) region. +// +// 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 AWSKendraFrontendService's +// API operation UpdateQuerySuggestionsBlockList for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * ConflictException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList +func (c *Kendra) UpdateQuerySuggestionsBlockList(input *UpdateQuerySuggestionsBlockListInput) (*UpdateQuerySuggestionsBlockListOutput, error) { + req, out := c.UpdateQuerySuggestionsBlockListRequest(input) + return out, req.Send() +} + +// UpdateQuerySuggestionsBlockListWithContext is the same as UpdateQuerySuggestionsBlockList with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateQuerySuggestionsBlockList 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 *Kendra) UpdateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *UpdateQuerySuggestionsBlockListInput, opts ...request.Option) (*UpdateQuerySuggestionsBlockListOutput, error) { + req, out := c.UpdateQuerySuggestionsBlockListRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateQuerySuggestionsConfig = "UpdateQuerySuggestionsConfig" + +// UpdateQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the +// client's request for the UpdateQuerySuggestionsConfig 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 UpdateQuerySuggestionsConfig for more information on using the UpdateQuerySuggestionsConfig +// 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 UpdateQuerySuggestionsConfigRequest method. +// req, resp := client.UpdateQuerySuggestionsConfigRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig +func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestionsConfigInput) (req *request.Request, output *UpdateQuerySuggestionsConfigOutput) { + op := &request.Operation{ + Name: opUpdateQuerySuggestionsConfig, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateQuerySuggestionsConfigInput{} + } + + output = &UpdateQuerySuggestionsConfigOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateQuerySuggestionsConfig API operation for AWSKendraFrontendService. +// +// Updates the settings of query suggestions for an index. +// +// Amazon Kendra supports partial updates, so you only need to provide the fields +// you want to update. +// +// If an update is currently processing (i.e. 'happening'), you need to wait +// for the update to finish before making another update. +// +// Updates to query suggestions settings might not take effect right away. The +// time for your updated settings to take effect depends on the updates made +// and the number of search queries in your index. +// +// You can still enable/disable query suggestions at any time. +// +// UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. +// +// 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 AWSKendraFrontendService's +// API operation UpdateQuerySuggestionsConfig for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ConflictException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig +func (c *Kendra) UpdateQuerySuggestionsConfig(input *UpdateQuerySuggestionsConfigInput) (*UpdateQuerySuggestionsConfigOutput, error) { + req, out := c.UpdateQuerySuggestionsConfigRequest(input) + return out, req.Send() +} + +// UpdateQuerySuggestionsConfigWithContext is the same as UpdateQuerySuggestionsConfig with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateQuerySuggestionsConfig 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 *Kendra) UpdateQuerySuggestionsConfigWithContext(ctx aws.Context, input *UpdateQuerySuggestionsConfigInput, opts ...request.Option) (*UpdateQuerySuggestionsConfigOutput, error) { + req, out := c.UpdateQuerySuggestionsConfigRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateThesaurus = "UpdateThesaurus" + +// UpdateThesaurusRequest generates a "aws/request.Request" representing the +// client's request for the UpdateThesaurus 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 UpdateThesaurus for more information on using the UpdateThesaurus +// 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 UpdateThesaurusRequest method. +// req, resp := client.UpdateThesaurusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus +func (c *Kendra) UpdateThesaurusRequest(input *UpdateThesaurusInput) (req *request.Request, output *UpdateThesaurusOutput) { + op := &request.Operation{ + Name: opUpdateThesaurus, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateThesaurusInput{} + } + + output = &UpdateThesaurusOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateThesaurus API operation for AWSKendraFrontendService. +// +// Updates a thesaurus file associated with an index. +// +// 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 AWSKendraFrontendService's +// API operation UpdateThesaurus for usage and error information. +// +// Returned Error Types: +// * ValidationException +// +// * ResourceNotFoundException +// +// * ThrottlingException +// +// * AccessDeniedException +// +// * ConflictException +// +// * InternalServerException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus +func (c *Kendra) UpdateThesaurus(input *UpdateThesaurusInput) (*UpdateThesaurusOutput, error) { + req, out := c.UpdateThesaurusRequest(input) + return out, req.Send() +} + +// UpdateThesaurusWithContext is the same as UpdateThesaurus with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateThesaurus 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 *Kendra) UpdateThesaurusWithContext(ctx aws.Context, input *UpdateThesaurusInput, opts ...request.Option) (*UpdateThesaurusOutput, error) { + req, out := c.UpdateThesaurusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// Access Control List files for the documents in a data source. For the format +// of the file, see Access control for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html). +type AccessControlListConfiguration struct { + _ struct{} `type:"structure"` + + // Path to the Amazon Web Services S3 bucket that contains the ACL files. + KeyPath *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 AccessControlListConfiguration) 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 AccessControlListConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AccessControlListConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AccessControlListConfiguration"} + if s.KeyPath != nil && len(*s.KeyPath) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeyPath", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKeyPath sets the KeyPath field's value. +func (s *AccessControlListConfiguration) SetKeyPath(v string) *AccessControlListConfiguration { + s.KeyPath = &v + return s +} + +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" 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 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 +} + +// Provides information about the column that should be used for filtering the +// query response by groups. +type AclConfiguration struct { + _ struct{} `type:"structure"` + + // A list of groups, separated by semi-colons, that filters a query response + // based on user context. The document is only returned to users that are in + // one of the groups specified in the UserContext field of the Query operation. + // + // AllowedGroupsColumnName is a required field + AllowedGroupsColumnName *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 AclConfiguration) 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 AclConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AclConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AclConfiguration"} + if s.AllowedGroupsColumnName == nil { + invalidParams.Add(request.NewErrParamRequired("AllowedGroupsColumnName")) + } + if s.AllowedGroupsColumnName != nil && len(*s.AllowedGroupsColumnName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AllowedGroupsColumnName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value. +func (s *AclConfiguration) SetAllowedGroupsColumnName(v string) *AclConfiguration { + s.AllowedGroupsColumnName = &v + return s +} + +// An attribute returned from an index query. +type AdditionalResultAttribute struct { + _ struct{} `type:"structure"` + + // The key that identifies the attribute. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // An object that contains the attribute value. + // + // Value is a required field + Value *AdditionalResultAttributeValue `type:"structure" required:"true"` + + // The data type of the Value property. + // + // ValueType is a required field + ValueType *string `type:"string" required:"true" enum:"AdditionalResultAttributeValueType"` +} + +// 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 AdditionalResultAttribute) 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 AdditionalResultAttribute) GoString() string { + return s.String() +} + +// SetKey sets the Key field's value. +func (s *AdditionalResultAttribute) SetKey(v string) *AdditionalResultAttribute { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *AdditionalResultAttribute) SetValue(v *AdditionalResultAttributeValue) *AdditionalResultAttribute { + s.Value = v + return s +} + +// SetValueType sets the ValueType field's value. +func (s *AdditionalResultAttribute) SetValueType(v string) *AdditionalResultAttribute { + s.ValueType = &v + return s +} + +// An attribute returned with a document from a search. +type AdditionalResultAttributeValue struct { + _ struct{} `type:"structure"` + + // The text associated with the attribute and information about the highlight + // to apply to the text. + TextWithHighlightsValue *TextWithHighlights `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 AdditionalResultAttributeValue) 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 AdditionalResultAttributeValue) GoString() string { + return s.String() +} + +// SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value. +func (s *AdditionalResultAttributeValue) SetTextWithHighlightsValue(v *TextWithHighlights) *AdditionalResultAttributeValue { + s.TextWithHighlightsValue = v + return s +} + +type AssociateEntitiesToExperienceInput struct { + _ struct{} `type:"structure"` + + // Lists users or groups in your Amazon Web Services SSO identity source. + // + // EntityList is a required field + EntityList []*EntityConfiguration `min:"1" type:"list" required:"true"` + + // The identifier of your Amazon Kendra experience. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index for your Amazon Kendra experience. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociateEntitiesToExperienceInput) 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 AssociateEntitiesToExperienceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateEntitiesToExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateEntitiesToExperienceInput"} + if s.EntityList == nil { + invalidParams.Add(request.NewErrParamRequired("EntityList")) + } + if s.EntityList != nil && len(s.EntityList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityList", 1)) + } + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.EntityList != nil { + for i, v := range s.EntityList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "EntityList", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEntityList sets the EntityList field's value. +func (s *AssociateEntitiesToExperienceInput) SetEntityList(v []*EntityConfiguration) *AssociateEntitiesToExperienceInput { + s.EntityList = v + return s +} + +// SetId sets the Id field's value. +func (s *AssociateEntitiesToExperienceInput) SetId(v string) *AssociateEntitiesToExperienceInput { + s.Id = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *AssociateEntitiesToExperienceInput) SetIndexId(v string) *AssociateEntitiesToExperienceInput { + s.IndexId = &v + return s +} + +type AssociateEntitiesToExperienceOutput struct { + _ struct{} `type:"structure"` + + // Lists the users or groups in your Amazon Web Services SSO identity source + // that failed to properly configure with your Amazon Kendra experience. + FailedEntityList []*FailedEntity `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 AssociateEntitiesToExperienceOutput) 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 AssociateEntitiesToExperienceOutput) GoString() string { + return s.String() +} + +// SetFailedEntityList sets the FailedEntityList field's value. +func (s *AssociateEntitiesToExperienceOutput) SetFailedEntityList(v []*FailedEntity) *AssociateEntitiesToExperienceOutput { + s.FailedEntityList = v + return s +} + +type AssociatePersonasToEntitiesInput struct { + _ struct{} `type:"structure"` + + // The identifier of your Amazon Kendra experience. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index for your Amazon Kendra experience. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The personas that define the specific permissions of users or groups in your + // Amazon Web Services SSO identity source. The available personas or access + // roles are Owner and Viewer. For more information on these personas, see Providing + // access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + // + // Personas is a required field + Personas []*EntityPersonaConfiguration `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociatePersonasToEntitiesInput) 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 AssociatePersonasToEntitiesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociatePersonasToEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociatePersonasToEntitiesInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.Personas == nil { + invalidParams.Add(request.NewErrParamRequired("Personas")) + } + if s.Personas != nil && len(s.Personas) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Personas", 1)) + } + if s.Personas != nil { + for i, v := range s.Personas { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Personas", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *AssociatePersonasToEntitiesInput) SetId(v string) *AssociatePersonasToEntitiesInput { + s.Id = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *AssociatePersonasToEntitiesInput) SetIndexId(v string) *AssociatePersonasToEntitiesInput { + s.IndexId = &v + return s +} + +// SetPersonas sets the Personas field's value. +func (s *AssociatePersonasToEntitiesInput) SetPersonas(v []*EntityPersonaConfiguration) *AssociatePersonasToEntitiesInput { + s.Personas = v + return s +} + +type AssociatePersonasToEntitiesOutput struct { + _ struct{} `type:"structure"` + + // Lists the users or groups in your Amazon Web Services SSO identity source + // that failed to properly configure with your Amazon Kendra experience. + FailedEntityList []*FailedEntity `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 AssociatePersonasToEntitiesOutput) 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 AssociatePersonasToEntitiesOutput) GoString() string { + return s.String() +} + +// SetFailedEntityList sets the FailedEntityList field's value. +func (s *AssociatePersonasToEntitiesOutput) SetFailedEntityList(v []*FailedEntity) *AssociatePersonasToEntitiesOutput { + s.FailedEntityList = v + return s +} + +// Provides filtering the query results based on document attributes. +// +// When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers +// under the first attribute filter. For example, you can use: +// +// +// +// +// +// +// +// If you use more than 2 layers, you receive a ValidationException exception +// with the message "AttributeFilter cannot have a depth of more than 2." +// +// If you use more than 10 attribute filters in a given list for AndAllFilters +// or OrAllFilters, you receive a ValidationException with the message "AttributeFilter +// cannot have a length of more than 10". +type AttributeFilter struct { + _ struct{} `type:"structure"` + + // Performs a logical AND operation on all supplied filters. + AndAllFilters []*AttributeFilter `type:"list"` + + // Returns true when a document contains all of the specified document attributes. + // This filter is only applicable to StringListValue metadata. + ContainsAll *DocumentAttribute `type:"structure"` + + // Returns true when a document contains any of the specified document attributes. + // This filter is only applicable to StringListValue metadata. + ContainsAny *DocumentAttribute `type:"structure"` + + // Performs an equals operation on two document attributes. + EqualsTo *DocumentAttribute `type:"structure"` + + // Performs a greater than operation on two document attributes. Use with a + // document attribute of type Date or Long. + GreaterThan *DocumentAttribute `type:"structure"` + + // Performs a greater or equals than operation on two document attributes. Use + // with a document attribute of type Date or Long. + GreaterThanOrEquals *DocumentAttribute `type:"structure"` + + // Performs a less than operation on two document attributes. Use with a document + // attribute of type Date or Long. + LessThan *DocumentAttribute `type:"structure"` + + // Performs a less than or equals operation on two document attributes. Use + // with a document attribute of type Date or Long. + LessThanOrEquals *DocumentAttribute `type:"structure"` + + // Performs a logical NOT operation on all supplied filters. + NotFilter *AttributeFilter `type:"structure"` + + // Performs a logical OR operation on all supplied filters. + OrAllFilters []*AttributeFilter `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 AttributeFilter) 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 AttributeFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AttributeFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AttributeFilter"} + if s.ContainsAll != nil { + if err := s.ContainsAll.Validate(); err != nil { + invalidParams.AddNested("ContainsAll", err.(request.ErrInvalidParams)) + } + } + if s.ContainsAny != nil { + if err := s.ContainsAny.Validate(); err != nil { + invalidParams.AddNested("ContainsAny", err.(request.ErrInvalidParams)) + } + } + if s.EqualsTo != nil { + if err := s.EqualsTo.Validate(); err != nil { + invalidParams.AddNested("EqualsTo", err.(request.ErrInvalidParams)) + } + } + if s.GreaterThan != nil { + if err := s.GreaterThan.Validate(); err != nil { + invalidParams.AddNested("GreaterThan", err.(request.ErrInvalidParams)) + } + } + if s.GreaterThanOrEquals != nil { + if err := s.GreaterThanOrEquals.Validate(); err != nil { + invalidParams.AddNested("GreaterThanOrEquals", err.(request.ErrInvalidParams)) + } + } + if s.LessThan != nil { + if err := s.LessThan.Validate(); err != nil { + invalidParams.AddNested("LessThan", err.(request.ErrInvalidParams)) + } + } + if s.LessThanOrEquals != nil { + if err := s.LessThanOrEquals.Validate(); err != nil { + invalidParams.AddNested("LessThanOrEquals", err.(request.ErrInvalidParams)) + } + } + if s.NotFilter != nil { + if err := s.NotFilter.Validate(); err != nil { + invalidParams.AddNested("NotFilter", err.(request.ErrInvalidParams)) + } + } + if s.OrAllFilters != nil { + for i, v := range s.OrAllFilters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "OrAllFilters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAndAllFilters sets the AndAllFilters field's value. +func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter { + s.AndAllFilters = v + return s +} + +// SetContainsAll sets the ContainsAll field's value. +func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter { + s.ContainsAll = v + return s +} + +// SetContainsAny sets the ContainsAny field's value. +func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter { + s.ContainsAny = v + return s +} + +// SetEqualsTo sets the EqualsTo field's value. +func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter { + s.EqualsTo = v + return s +} + +// SetGreaterThan sets the GreaterThan field's value. +func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter { + s.GreaterThan = v + return s +} + +// SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value. +func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter { + s.GreaterThanOrEquals = v + return s +} + +// SetLessThan sets the LessThan field's value. +func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter { + s.LessThan = v + return s +} + +// SetLessThanOrEquals sets the LessThanOrEquals field's value. +func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter { + s.LessThanOrEquals = v + return s +} + +// SetNotFilter sets the NotFilter field's value. +func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter { + s.NotFilter = v + return s +} + +// SetOrAllFilters sets the OrAllFilters field's value. +func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter { + s.OrAllFilters = v + return s +} + +// Provides the configuration information to connect to websites that require +// user authentication. +type AuthenticationConfiguration struct { + _ struct{} `type:"structure"` + + // The list of configuration information that's required to connect to and crawl + // a website host using basic authentication credentials. + // + // The list includes the name and port number of the website host. + BasicAuthentication []*BasicAuthenticationConfiguration `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 AuthenticationConfiguration) 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 AuthenticationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AuthenticationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AuthenticationConfiguration"} + if s.BasicAuthentication != nil { + for i, v := range s.BasicAuthentication { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "BasicAuthentication", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBasicAuthentication sets the BasicAuthentication field's value. +func (s *AuthenticationConfiguration) SetBasicAuthentication(v []*BasicAuthenticationConfiguration) *AuthenticationConfiguration { + s.BasicAuthentication = v + return s +} + +// Provides the configuration information to connect to websites that require +// basic user authentication. +type BasicAuthenticationConfiguration struct { + _ struct{} `type:"structure"` + + // Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // + // You use a secret if basic authentication credentials are required to connect + // to a website. The secret stores your credentials of user name and password. + // + // Credentials is a required field + Credentials *string `min:"1" type:"string" required:"true"` + + // The name of the website host you want to connect to using authentication + // credentials. + // + // For example, the host name of https://a.example.com/page1.html is "a.example.com". + // + // Host is a required field + Host *string `min:"1" type:"string" required:"true"` + + // The port number of the website host you want to connect to using authentication + // credentials. + // + // For example, the port for https://a.example.com/page1.html is 443, the standard + // port for HTTPS. + // + // Port is a required field + Port *int64 `min:"1" type:"integer" 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 BasicAuthenticationConfiguration) 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 BasicAuthenticationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BasicAuthenticationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BasicAuthenticationConfiguration"} + if s.Credentials == nil { + invalidParams.Add(request.NewErrParamRequired("Credentials")) + } + if s.Credentials != nil && len(*s.Credentials) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Credentials", 1)) + } + if s.Host == nil { + invalidParams.Add(request.NewErrParamRequired("Host")) + } + if s.Host != nil && len(*s.Host) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Host", 1)) + } + if s.Port == nil { + invalidParams.Add(request.NewErrParamRequired("Port")) + } + if s.Port != nil && *s.Port < 1 { + invalidParams.Add(request.NewErrParamMinValue("Port", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCredentials sets the Credentials field's value. +func (s *BasicAuthenticationConfiguration) SetCredentials(v string) *BasicAuthenticationConfiguration { + s.Credentials = &v + return s +} + +// SetHost sets the Host field's value. +func (s *BasicAuthenticationConfiguration) SetHost(v string) *BasicAuthenticationConfiguration { + s.Host = &v + return s +} + +// SetPort sets the Port field's value. +func (s *BasicAuthenticationConfiguration) SetPort(v int64) *BasicAuthenticationConfiguration { + s.Port = &v + return s +} + +type BatchDeleteDocumentInput struct { + _ struct{} `type:"structure"` + + // Maps a particular data source sync job to a particular data source. + DataSourceSyncJobMetricTarget *DataSourceSyncJobMetricTarget `type:"structure"` + + // One or more identifiers for documents to delete from the index. + // + // DocumentIdList is a required field + DocumentIdList []*string `min:"1" type:"list" required:"true"` + + // The identifier of the index that contains the documents to delete. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchDeleteDocumentInput) 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 BatchDeleteDocumentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDeleteDocumentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDeleteDocumentInput"} + if s.DocumentIdList == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentIdList")) + } + if s.DocumentIdList != nil && len(s.DocumentIdList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentIdList", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.DataSourceSyncJobMetricTarget != nil { + if err := s.DataSourceSyncJobMetricTarget.Validate(); err != nil { + invalidParams.AddNested("DataSourceSyncJobMetricTarget", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceSyncJobMetricTarget sets the DataSourceSyncJobMetricTarget field's value. +func (s *BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget(v *DataSourceSyncJobMetricTarget) *BatchDeleteDocumentInput { + s.DataSourceSyncJobMetricTarget = v + return s +} + +// SetDocumentIdList sets the DocumentIdList field's value. +func (s *BatchDeleteDocumentInput) SetDocumentIdList(v []*string) *BatchDeleteDocumentInput { + s.DocumentIdList = v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput { + s.IndexId = &v + return s +} + +type BatchDeleteDocumentOutput struct { + _ struct{} `type:"structure"` + + // A list of documents that could not be removed from the index. Each entry + // contains an error message that indicates why the document couldn't be removed + // from the index. + FailedDocuments []*BatchDeleteDocumentResponseFailedDocument `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 BatchDeleteDocumentOutput) 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 BatchDeleteDocumentOutput) GoString() string { + return s.String() +} + +// SetFailedDocuments sets the FailedDocuments field's value. +func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*BatchDeleteDocumentResponseFailedDocument) *BatchDeleteDocumentOutput { + s.FailedDocuments = v + return s +} + +// Provides information about documents that could not be removed from an index +// by the BatchDeleteDocument operation. +type BatchDeleteDocumentResponseFailedDocument struct { + _ struct{} `type:"structure"` + + // The error code for why the document couldn't be removed from the index. + ErrorCode *string `type:"string" enum:"ErrorCode"` + + // An explanation for why the document couldn't be removed from the index. + ErrorMessage *string `min:"1" type:"string"` + + // The identifier of the document that couldn't be removed from the index. + Id *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 BatchDeleteDocumentResponseFailedDocument) 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 BatchDeleteDocumentResponseFailedDocument) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorCode(v string) *BatchDeleteDocumentResponseFailedDocument { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchDeleteDocumentResponseFailedDocument { + s.ErrorMessage = &v + return s +} + +// SetId sets the Id field's value. +func (s *BatchDeleteDocumentResponseFailedDocument) SetId(v string) *BatchDeleteDocumentResponseFailedDocument { + s.Id = &v + return s +} + +type BatchGetDocumentStatusInput struct { + _ struct{} `type:"structure"` + + // A list of DocumentInfo objects that identify the documents for which to get + // the status. You identify the documents by their document ID and optional + // attributes. + // + // DocumentInfoList is a required field + DocumentInfoList []*DocumentInfo `min:"1" type:"list" required:"true"` + + // The identifier of the index to add documents to. The index ID is returned + // by the CreateIndex (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) + // operation. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchGetDocumentStatusInput) 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 BatchGetDocumentStatusInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchGetDocumentStatusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchGetDocumentStatusInput"} + if s.DocumentInfoList == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentInfoList")) + } + if s.DocumentInfoList != nil && len(s.DocumentInfoList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentInfoList", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.DocumentInfoList != nil { + for i, v := range s.DocumentInfoList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DocumentInfoList", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDocumentInfoList sets the DocumentInfoList field's value. +func (s *BatchGetDocumentStatusInput) SetDocumentInfoList(v []*DocumentInfo) *BatchGetDocumentStatusInput { + s.DocumentInfoList = v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *BatchGetDocumentStatusInput) SetIndexId(v string) *BatchGetDocumentStatusInput { + s.IndexId = &v + return s +} + +type BatchGetDocumentStatusOutput struct { + _ struct{} `type:"structure"` + + // The status of documents. The status indicates if the document is waiting + // to be indexed, is in the process of indexing, has completed indexing, or + // failed indexing. If a document failed indexing, the status provides the reason + // why. + DocumentStatusList []*Status `type:"list"` + + // A list of documents that Amazon Kendra couldn't get the status for. The list + // includes the ID of the document and the reason that the status couldn't be + // found. + Errors []*BatchGetDocumentStatusResponseError `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 BatchGetDocumentStatusOutput) 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 BatchGetDocumentStatusOutput) GoString() string { + return s.String() +} + +// SetDocumentStatusList sets the DocumentStatusList field's value. +func (s *BatchGetDocumentStatusOutput) SetDocumentStatusList(v []*Status) *BatchGetDocumentStatusOutput { + s.DocumentStatusList = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *BatchGetDocumentStatusOutput) SetErrors(v []*BatchGetDocumentStatusResponseError) *BatchGetDocumentStatusOutput { + s.Errors = v + return s +} + +// Provides a response when the status of a document could not be retrieved. +type BatchGetDocumentStatusResponseError struct { + _ struct{} `type:"structure"` + + // The unique identifier of the document whose status could not be retrieved. + DocumentId *string `min:"1" type:"string"` + + // Indicates the source of the error. + ErrorCode *string `type:"string" enum:"ErrorCode"` + + // States that the API could not get the status of a document. This could be + // because the request is not valid or there is a system error. + ErrorMessage *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 BatchGetDocumentStatusResponseError) 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 BatchGetDocumentStatusResponseError) GoString() string { + return s.String() +} + +// SetDocumentId sets the DocumentId field's value. +func (s *BatchGetDocumentStatusResponseError) SetDocumentId(v string) *BatchGetDocumentStatusResponseError { + s.DocumentId = &v + return s +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchGetDocumentStatusResponseError) SetErrorCode(v string) *BatchGetDocumentStatusResponseError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchGetDocumentStatusResponseError) SetErrorMessage(v string) *BatchGetDocumentStatusResponseError { + s.ErrorMessage = &v + return s +} + +type BatchPutDocumentInput struct { + _ struct{} `type:"structure"` + + // Configuration information for altering your document metadata and content + // during the document ingestion process when you use the BatchPutDocument operation. + // + // For more information on how to create, modify and delete document metadata, + // or make other content alterations when you ingest documents into Amazon Kendra, + // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"` + + // One or more documents to add to the index. + // + // Documents can include custom attributes. For example, 'DataSourceId' and + // 'DataSourceSyncJobId' are custom attributes that provide information on the + // synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' + // could be an optional custom attribute as Amazon Kendra will use the ID of + // a running sync job. + // + // Documents have the following file size limits. + // + // * 5 MB total size for inline documents + // + // * 50 MB total size for files from an S3 bucket + // + // * 5 MB extracted text for any file + // + // For more information about file size and transaction per second quotas, see + // Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // + // Documents is a required field + Documents []*Document `min:"1" type:"list" required:"true"` + + // The identifier of the index to add the documents to. You need to create the + // index first using the CreateIndex operation. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument + // operation. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + RoleArn *string `type:"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 BatchPutDocumentInput) 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 BatchPutDocumentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchPutDocumentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchPutDocumentInput"} + if s.Documents == nil { + invalidParams.Add(request.NewErrParamRequired("Documents")) + } + if s.Documents != nil && len(s.Documents) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Documents", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.CustomDocumentEnrichmentConfiguration != nil { + if err := s.CustomDocumentEnrichmentConfiguration.Validate(); err != nil { + invalidParams.AddNested("CustomDocumentEnrichmentConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Documents != nil { + for i, v := range s.Documents { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Documents", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value. +func (s *BatchPutDocumentInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *BatchPutDocumentInput { + s.CustomDocumentEnrichmentConfiguration = v + return s +} + +// SetDocuments sets the Documents field's value. +func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput { + s.Documents = v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput { + s.IndexId = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput { + s.RoleArn = &v + return s +} + +type BatchPutDocumentOutput struct { + _ struct{} `type:"structure"` + + // A list of documents that were not added to the index because the document + // failed a validation check. Each document contains an error message that indicates + // why the document couldn't be added to the index. + // + // If there was an error adding a document to an index the error is reported + // in your Amazon Web Services CloudWatch log. For more information, see Monitoring + // Amazon Kendra with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html) + FailedDocuments []*BatchPutDocumentResponseFailedDocument `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 BatchPutDocumentOutput) 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 BatchPutDocumentOutput) GoString() string { + return s.String() +} + +// SetFailedDocuments sets the FailedDocuments field's value. +func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*BatchPutDocumentResponseFailedDocument) *BatchPutDocumentOutput { + s.FailedDocuments = v + return s +} + +// Provides information about a document that could not be indexed. +type BatchPutDocumentResponseFailedDocument struct { + _ struct{} `type:"structure"` + + // The type of error that caused the document to fail to be indexed. + ErrorCode *string `type:"string" enum:"ErrorCode"` + + // A description of the reason why the document could not be indexed. + ErrorMessage *string `min:"1" type:"string"` + + // The unique identifier of the document. + Id *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 BatchPutDocumentResponseFailedDocument) 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 BatchPutDocumentResponseFailedDocument) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchPutDocumentResponseFailedDocument) SetErrorCode(v string) *BatchPutDocumentResponseFailedDocument { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchPutDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchPutDocumentResponseFailedDocument { + s.ErrorMessage = &v + return s +} + +// SetId sets the Id field's value. +func (s *BatchPutDocumentResponseFailedDocument) SetId(v string) *BatchPutDocumentResponseFailedDocument { + s.Id = &v + return s +} + +// Specifies capacity units configured for your enterprise edition index. You +// can add and remove capacity units to tune an index to your requirements. +type CapacityUnitsConfiguration struct { + _ struct{} `type:"structure"` + + // The amount of extra query capacity for an index and GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) + // capacity. + // + // A single extra capacity unit for an index provides 0.1 queries per second + // or approximately 8,000 queries per day. + // + // GetQuerySuggestions capacity is five times the provisioned query capacity + // for an index, or the base capacity of 2.5 calls per second, whichever is + // higher. For example, the base capacity for an index is 0.1 queries per second, + // and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you + // add another 0.1 queries per second to total 0.2 queries per second for an + // index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than + // five times 0.2 queries per second). + // + // QueryCapacityUnits is a required field + QueryCapacityUnits *int64 `type:"integer" required:"true"` + + // The amount of extra storage capacity for an index. A single capacity unit + // provides 30 GB of storage space or 100,000 documents, whichever is reached + // first. + // + // StorageCapacityUnits is a required field + StorageCapacityUnits *int64 `type:"integer" 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 CapacityUnitsConfiguration) 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 CapacityUnitsConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacityUnitsConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacityUnitsConfiguration"} + if s.QueryCapacityUnits == nil { + invalidParams.Add(request.NewErrParamRequired("QueryCapacityUnits")) + } + if s.StorageCapacityUnits == nil { + invalidParams.Add(request.NewErrParamRequired("StorageCapacityUnits")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetQueryCapacityUnits sets the QueryCapacityUnits field's value. +func (s *CapacityUnitsConfiguration) SetQueryCapacityUnits(v int64) *CapacityUnitsConfiguration { + s.QueryCapacityUnits = &v + return s +} + +// SetStorageCapacityUnits sets the StorageCapacityUnits field's value. +func (s *CapacityUnitsConfiguration) SetStorageCapacityUnits(v int64) *CapacityUnitsConfiguration { + s.StorageCapacityUnits = &v + return s +} + +type ClearQuerySuggestionsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the index you want to clear query suggestions from. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ClearQuerySuggestionsInput) 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 ClearQuerySuggestionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ClearQuerySuggestionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ClearQuerySuggestionsInput"} + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIndexId sets the IndexId field's value. +func (s *ClearQuerySuggestionsInput) SetIndexId(v string) *ClearQuerySuggestionsInput { + s.IndexId = &v + return s +} + +type ClearQuerySuggestionsOutput 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 ClearQuerySuggestionsOutput) 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 ClearQuerySuggestionsOutput) GoString() string { + return s.String() +} + +// Gathers information about when a particular result was clicked by a user. +// Your application uses the SubmitFeedback operation to provide click information. +type ClickFeedback struct { + _ struct{} `type:"structure"` + + // The Unix timestamp of the date and time that the result was clicked. + // + // ClickTime is a required field + ClickTime *time.Time `type:"timestamp" required:"true"` + + // The unique identifier of the search result that was clicked. + // + // ResultId is a required field + ResultId *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 ClickFeedback) 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 ClickFeedback) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ClickFeedback) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ClickFeedback"} + if s.ClickTime == nil { + invalidParams.Add(request.NewErrParamRequired("ClickTime")) + } + if s.ResultId == nil { + invalidParams.Add(request.NewErrParamRequired("ResultId")) + } + if s.ResultId != nil && len(*s.ResultId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResultId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClickTime sets the ClickTime field's value. +func (s *ClickFeedback) SetClickTime(v time.Time) *ClickFeedback { + s.ClickTime = &v + return s +} + +// SetResultId sets the ResultId field's value. +func (s *ClickFeedback) SetResultId(v string) *ClickFeedback { + s.ResultId = &v + return s +} + +// Provides information about how Amazon Kendra should use the columns of a +// database in an index. +type ColumnConfiguration struct { + _ struct{} `type:"structure"` + + // One to five columns that indicate when a document in the database has changed. + // + // ChangeDetectingColumns is a required field + ChangeDetectingColumns []*string `min:"1" type:"list" required:"true"` + + // The column that contains the contents of the document. + // + // DocumentDataColumnName is a required field + DocumentDataColumnName *string `min:"1" type:"string" required:"true"` + + // The column that provides the document's unique identifier. + // + // DocumentIdColumnName is a required field + DocumentIdColumnName *string `min:"1" type:"string" required:"true"` + + // The column that contains the title of the document. + DocumentTitleColumnName *string `min:"1" type:"string"` + + // An array of objects that map database column names to the corresponding fields + // in an index. You must first create the fields in the index using the UpdateIndex + // operation. + FieldMappings []*DataSourceToIndexFieldMapping `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 ColumnConfiguration) 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 ColumnConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ColumnConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ColumnConfiguration"} + if s.ChangeDetectingColumns == nil { + invalidParams.Add(request.NewErrParamRequired("ChangeDetectingColumns")) + } + if s.ChangeDetectingColumns != nil && len(s.ChangeDetectingColumns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChangeDetectingColumns", 1)) + } + if s.DocumentDataColumnName == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentDataColumnName")) + } + if s.DocumentDataColumnName != nil && len(*s.DocumentDataColumnName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentDataColumnName", 1)) + } + if s.DocumentIdColumnName == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentIdColumnName")) + } + if s.DocumentIdColumnName != nil && len(*s.DocumentIdColumnName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentIdColumnName", 1)) + } + if s.DocumentTitleColumnName != nil && len(*s.DocumentTitleColumnName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentTitleColumnName", 1)) + } + if s.FieldMappings != nil && len(s.FieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FieldMappings", 1)) + } + if s.FieldMappings != nil { + for i, v := range s.FieldMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FieldMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChangeDetectingColumns sets the ChangeDetectingColumns field's value. +func (s *ColumnConfiguration) SetChangeDetectingColumns(v []*string) *ColumnConfiguration { + s.ChangeDetectingColumns = v + return s +} + +// SetDocumentDataColumnName sets the DocumentDataColumnName field's value. +func (s *ColumnConfiguration) SetDocumentDataColumnName(v string) *ColumnConfiguration { + s.DocumentDataColumnName = &v + return s +} + +// SetDocumentIdColumnName sets the DocumentIdColumnName field's value. +func (s *ColumnConfiguration) SetDocumentIdColumnName(v string) *ColumnConfiguration { + s.DocumentIdColumnName = &v + return s +} + +// SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value. +func (s *ColumnConfiguration) SetDocumentTitleColumnName(v string) *ColumnConfiguration { + s.DocumentTitleColumnName = &v + return s +} + +// SetFieldMappings sets the FieldMappings field's value. +func (s *ColumnConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ColumnConfiguration { + s.FieldMappings = v + return s +} + +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" 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 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 +} + +// Specifies the attachment settings for the Confluence data source. Attachment +// settings are optional, if you don't specify settings attachments, Amazon +// Kendra won't index them. +type ConfluenceAttachmentConfiguration struct { + _ struct{} `type:"structure"` + + // Defines how attachment metadata fields should be mapped to index fields. + // Before you can map a field, you must first create an index field with a matching + // type using the console or the UpdateIndex operation. + // + // If you specify the AttachentFieldMappings parameter, you must specify at + // least one field mapping. + AttachmentFieldMappings []*ConfluenceAttachmentToIndexFieldMapping `min:"1" type:"list"` + + // Indicates whether Amazon Kendra indexes attachments to the pages and blogs + // in the Confluence data source. + CrawlAttachments *bool `type:"boolean"` +} + +// 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 ConfluenceAttachmentConfiguration) 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 ConfluenceAttachmentConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceAttachmentConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceAttachmentConfiguration"} + if s.AttachmentFieldMappings != nil && len(s.AttachmentFieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttachmentFieldMappings", 1)) + } + if s.AttachmentFieldMappings != nil { + for i, v := range s.AttachmentFieldMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AttachmentFieldMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value. +func (s *ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings(v []*ConfluenceAttachmentToIndexFieldMapping) *ConfluenceAttachmentConfiguration { + s.AttachmentFieldMappings = v + return s +} + +// SetCrawlAttachments sets the CrawlAttachments field's value. +func (s *ConfluenceAttachmentConfiguration) SetCrawlAttachments(v bool) *ConfluenceAttachmentConfiguration { + s.CrawlAttachments = &v + return s +} + +// Defines the mapping between a field in the Confluence data source to a Amazon +// Kendra index field. +// +// You must first create the index field using the UpdateIndex operation. +type ConfluenceAttachmentToIndexFieldMapping struct { + _ struct{} `type:"structure"` + + // The name of the field in the data source. + // + // You must first create the index field using the UpdateIndex operation. + DataSourceFieldName *string `type:"string" enum:"ConfluenceAttachmentFieldName"` + + // The format for date fields in the data source. If the field specified in + // DataSourceFieldName is a date field you must specify the date format. If + // the field is not a date field, an exception is thrown. + DateFieldFormat *string `min:"4" type:"string"` + + // The name of the index field to map to the Confluence data source field. The + // index field type must match the Confluence field type. + IndexFieldName *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 ConfluenceAttachmentToIndexFieldMapping) 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 ConfluenceAttachmentToIndexFieldMapping) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceAttachmentToIndexFieldMapping"} + if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { + invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) + } + if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceFieldName sets the DataSourceFieldName field's value. +func (s *ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping { + s.DataSourceFieldName = &v + return s +} + +// SetDateFieldFormat sets the DateFieldFormat field's value. +func (s *ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceAttachmentToIndexFieldMapping { + s.DateFieldFormat = &v + return s +} + +// SetIndexFieldName sets the IndexFieldName field's value. +func (s *ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping { + s.IndexFieldName = &v + return s +} + +// Specifies the blog settings for the Confluence data source. Blogs are always +// indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns +// fields in the ConfluenceConfiguration type. +type ConfluenceBlogConfiguration struct { + _ struct{} `type:"structure"` + + // Defines how blog metadata fields should be mapped to index fields. Before + // you can map a field, you must first create an index field with a matching + // type using the console or the UpdateIndex operation. + // + // If you specify the BlogFieldMappings parameter, you must specify at least + // one field mapping. + BlogFieldMappings []*ConfluenceBlogToIndexFieldMapping `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 ConfluenceBlogConfiguration) 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 ConfluenceBlogConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceBlogConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceBlogConfiguration"} + if s.BlogFieldMappings != nil && len(s.BlogFieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BlogFieldMappings", 1)) + } + if s.BlogFieldMappings != nil { + for i, v := range s.BlogFieldMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "BlogFieldMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBlogFieldMappings sets the BlogFieldMappings field's value. +func (s *ConfluenceBlogConfiguration) SetBlogFieldMappings(v []*ConfluenceBlogToIndexFieldMapping) *ConfluenceBlogConfiguration { + s.BlogFieldMappings = v + return s +} + +// Defines the mapping between a blog field in the Confluence data source to +// a Amazon Kendra index field. +// +// You must first create the index field using the UpdateIndex operation. +type ConfluenceBlogToIndexFieldMapping struct { + _ struct{} `type:"structure"` + + // The name of the field in the data source. + DataSourceFieldName *string `type:"string" enum:"ConfluenceBlogFieldName"` + + // The format for date fields in the data source. If the field specified in + // DataSourceFieldName is a date field you must specify the date format. If + // the field is not a date field, an exception is thrown. + DateFieldFormat *string `min:"4" type:"string"` + + // The name of the index field to map to the Confluence data source field. The + // index field type must match the Confluence field type. + IndexFieldName *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 ConfluenceBlogToIndexFieldMapping) 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 ConfluenceBlogToIndexFieldMapping) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceBlogToIndexFieldMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceBlogToIndexFieldMapping"} + if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { + invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) + } + if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceFieldName sets the DataSourceFieldName field's value. +func (s *ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceBlogToIndexFieldMapping { + s.DataSourceFieldName = &v + return s +} + +// SetDateFieldFormat sets the DateFieldFormat field's value. +func (s *ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceBlogToIndexFieldMapping { + s.DateFieldFormat = &v + return s +} + +// SetIndexFieldName sets the IndexFieldName field's value. +func (s *ConfluenceBlogToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceBlogToIndexFieldMapping { + s.IndexFieldName = &v + return s +} + +// Provides configuration information for data sources that connect to Confluence. +type ConfluenceConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies configuration information for indexing attachments to Confluence + // blogs and pages. + AttachmentConfiguration *ConfluenceAttachmentConfiguration `type:"structure"` + + // Specifies configuration information for indexing Confluence blogs. + BlogConfiguration *ConfluenceBlogConfiguration `type:"structure"` + + // A list of regular expression patterns that apply to a URL on the Confluence + // server. An exclusion pattern can apply to a blog post, a page, a space, or + // an attachment. Items that match the pattern are excluded from the index. + // Items that don't match the pattern are included in the index. If a item matches + // both an exclusion pattern and an inclusion pattern, the item isn't included + // in the index. + ExclusionPatterns []*string `type:"list"` + + // A list of regular expression patterns that apply to a URL on the Confluence + // server. An inclusion pattern can apply to a blog post, a page, a space, or + // an attachment. Items that match the patterns are included in the index. Items + // that don't match the pattern are excluded from the index. If an item matches + // both an inclusion pattern and an exclusion pattern, the item isn't included + // in the index. + InclusionPatterns []*string `type:"list"` + + // Specifies configuration information for indexing Confluence pages. + PageConfiguration *ConfluencePageConfiguration `type:"structure"` + + // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains + // the key/value pairs required to connect to your Confluence server. The secret + // must contain a JSON structure with the following keys: + // + // * username - The user name or email address of a user with administrative + // privileges for the Confluence server. + // + // * password - The password associated with the user logging in to the Confluence + // server. + // + // SecretArn is a required field + SecretArn *string `min:"1" type:"string" required:"true"` + + // The URL of your Confluence instance. Use the full URL of the server. For + // example, https://server.example.com:port/. You can also use an IP address, + // for example, https://192.168.1.113/. + // + // ServerUrl is a required field + ServerUrl *string `min:"1" type:"string" required:"true"` + + // Specifies configuration information for indexing Confluence spaces. + SpaceConfiguration *ConfluenceSpaceConfiguration `type:"structure"` + + // Specifies the version of the Confluence installation that you are connecting + // to. + // + // Version is a required field + Version *string `type:"string" required:"true" enum:"ConfluenceVersion"` + + // Specifies the information for connecting to an Amazon VPC. + VpcConfiguration *DataSourceVpcConfiguration `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 ConfluenceConfiguration) 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 ConfluenceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceConfiguration"} + if s.SecretArn == nil { + invalidParams.Add(request.NewErrParamRequired("SecretArn")) + } + if s.SecretArn != nil && len(*s.SecretArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) + } + if s.ServerUrl == nil { + invalidParams.Add(request.NewErrParamRequired("ServerUrl")) + } + if s.ServerUrl != nil && len(*s.ServerUrl) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ServerUrl", 1)) + } + if s.Version == nil { + invalidParams.Add(request.NewErrParamRequired("Version")) + } + if s.AttachmentConfiguration != nil { + if err := s.AttachmentConfiguration.Validate(); err != nil { + invalidParams.AddNested("AttachmentConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.BlogConfiguration != nil { + if err := s.BlogConfiguration.Validate(); err != nil { + invalidParams.AddNested("BlogConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.PageConfiguration != nil { + if err := s.PageConfiguration.Validate(); err != nil { + invalidParams.AddNested("PageConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.SpaceConfiguration != nil { + if err := s.SpaceConfiguration.Validate(); err != nil { + invalidParams.AddNested("SpaceConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.VpcConfiguration != nil { + if err := s.VpcConfiguration.Validate(); err != nil { + invalidParams.AddNested("VpcConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttachmentConfiguration sets the AttachmentConfiguration field's value. +func (s *ConfluenceConfiguration) SetAttachmentConfiguration(v *ConfluenceAttachmentConfiguration) *ConfluenceConfiguration { + s.AttachmentConfiguration = v + return s +} + +// SetBlogConfiguration sets the BlogConfiguration field's value. +func (s *ConfluenceConfiguration) SetBlogConfiguration(v *ConfluenceBlogConfiguration) *ConfluenceConfiguration { + s.BlogConfiguration = v + return s +} + +// SetExclusionPatterns sets the ExclusionPatterns field's value. +func (s *ConfluenceConfiguration) SetExclusionPatterns(v []*string) *ConfluenceConfiguration { + s.ExclusionPatterns = v + return s +} + +// SetInclusionPatterns sets the InclusionPatterns field's value. +func (s *ConfluenceConfiguration) SetInclusionPatterns(v []*string) *ConfluenceConfiguration { + s.InclusionPatterns = v + return s +} + +// SetPageConfiguration sets the PageConfiguration field's value. +func (s *ConfluenceConfiguration) SetPageConfiguration(v *ConfluencePageConfiguration) *ConfluenceConfiguration { + s.PageConfiguration = v + return s +} + +// SetSecretArn sets the SecretArn field's value. +func (s *ConfluenceConfiguration) SetSecretArn(v string) *ConfluenceConfiguration { + s.SecretArn = &v + return s +} + +// SetServerUrl sets the ServerUrl field's value. +func (s *ConfluenceConfiguration) SetServerUrl(v string) *ConfluenceConfiguration { + s.ServerUrl = &v + return s +} + +// SetSpaceConfiguration sets the SpaceConfiguration field's value. +func (s *ConfluenceConfiguration) SetSpaceConfiguration(v *ConfluenceSpaceConfiguration) *ConfluenceConfiguration { + s.SpaceConfiguration = v + return s +} + +// SetVersion sets the Version field's value. +func (s *ConfluenceConfiguration) SetVersion(v string) *ConfluenceConfiguration { + s.Version = &v + return s +} + +// SetVpcConfiguration sets the VpcConfiguration field's value. +func (s *ConfluenceConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *ConfluenceConfiguration { + s.VpcConfiguration = v + return s +} + +// Specifies the page settings for the Confluence data source. +type ConfluencePageConfiguration struct { + _ struct{} `type:"structure"` + + // Defines how page metadata fields should be mapped to index fields. Before + // you can map a field, you must first create an index field with a matching + // type using the console or the UpdateIndex operation. + // + // If you specify the PageFieldMappings parameter, you must specify at least + // one field mapping. + PageFieldMappings []*ConfluencePageToIndexFieldMapping `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 ConfluencePageConfiguration) 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 ConfluencePageConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluencePageConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluencePageConfiguration"} + if s.PageFieldMappings != nil && len(s.PageFieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PageFieldMappings", 1)) + } + if s.PageFieldMappings != nil { + for i, v := range s.PageFieldMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PageFieldMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPageFieldMappings sets the PageFieldMappings field's value. +func (s *ConfluencePageConfiguration) SetPageFieldMappings(v []*ConfluencePageToIndexFieldMapping) *ConfluencePageConfiguration { + s.PageFieldMappings = v + return s +} + +// Defines the mapping between a field in the Confluence data source to a Amazon +// Kendra index field. +// +// You must first create the index field using the UpdateIndex operation. +type ConfluencePageToIndexFieldMapping struct { + _ struct{} `type:"structure"` + + // The name of the field in the data source. + DataSourceFieldName *string `type:"string" enum:"ConfluencePageFieldName"` + + // The format for date fields in the data source. If the field specified in + // DataSourceFieldName is a date field you must specify the date format. If + // the field is not a date field, an exception is thrown. + DateFieldFormat *string `min:"4" type:"string"` + + // The name of the index field to map to the Confluence data source field. The + // index field type must match the Confluence field type. + IndexFieldName *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 ConfluencePageToIndexFieldMapping) 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 ConfluencePageToIndexFieldMapping) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluencePageToIndexFieldMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluencePageToIndexFieldMapping"} + if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { + invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) + } + if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceFieldName sets the DataSourceFieldName field's value. +func (s *ConfluencePageToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluencePageToIndexFieldMapping { + s.DataSourceFieldName = &v + return s +} + +// SetDateFieldFormat sets the DateFieldFormat field's value. +func (s *ConfluencePageToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluencePageToIndexFieldMapping { + s.DateFieldFormat = &v + return s +} + +// SetIndexFieldName sets the IndexFieldName field's value. +func (s *ConfluencePageToIndexFieldMapping) SetIndexFieldName(v string) *ConfluencePageToIndexFieldMapping { + s.IndexFieldName = &v + return s +} + +// Specifies the configuration for indexing Confluence spaces. +type ConfluenceSpaceConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies whether Amazon Kendra should index archived spaces. + CrawlArchivedSpaces *bool `type:"boolean"` + + // Specifies whether Amazon Kendra should index personal spaces. Users can add + // restrictions to items in personal spaces. If personal spaces are indexed, + // queries without user context information may return restricted items from + // a personal space in their results. For more information, see Filtering on + // user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). + CrawlPersonalSpaces *bool `type:"boolean"` + + // A list of space keys of Confluence spaces. If you include a key, the blogs, + // documents, and attachments in the space are not indexed. If a space is in + // both the ExcludeSpaces and the IncludeSpaces list, the space is excluded. + ExcludeSpaces []*string `min:"1" type:"list"` + + // A list of space keys for Confluence spaces. If you include a key, the blogs, + // documents, and attachments in the space are indexed. Spaces that aren't in + // the list aren't indexed. A space in the list must exist. Otherwise, Amazon + // Kendra logs an error when the data source is synchronized. If a space is + // in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded. + IncludeSpaces []*string `min:"1" type:"list"` + + // Defines how space metadata fields should be mapped to index fields. Before + // you can map a field, you must first create an index field with a matching + // type using the console or the UpdateIndex operation. + // + // If you specify the SpaceFieldMappings parameter, you must specify at least + // one field mapping. + SpaceFieldMappings []*ConfluenceSpaceToIndexFieldMapping `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 ConfluenceSpaceConfiguration) 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 ConfluenceSpaceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceSpaceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceSpaceConfiguration"} + if s.ExcludeSpaces != nil && len(s.ExcludeSpaces) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExcludeSpaces", 1)) + } + if s.IncludeSpaces != nil && len(s.IncludeSpaces) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IncludeSpaces", 1)) + } + if s.SpaceFieldMappings != nil && len(s.SpaceFieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SpaceFieldMappings", 1)) + } + if s.SpaceFieldMappings != nil { + for i, v := range s.SpaceFieldMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SpaceFieldMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value. +func (s *ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces(v bool) *ConfluenceSpaceConfiguration { + s.CrawlArchivedSpaces = &v + return s +} + +// SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value. +func (s *ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces(v bool) *ConfluenceSpaceConfiguration { + s.CrawlPersonalSpaces = &v + return s +} + +// SetExcludeSpaces sets the ExcludeSpaces field's value. +func (s *ConfluenceSpaceConfiguration) SetExcludeSpaces(v []*string) *ConfluenceSpaceConfiguration { + s.ExcludeSpaces = v + return s +} + +// SetIncludeSpaces sets the IncludeSpaces field's value. +func (s *ConfluenceSpaceConfiguration) SetIncludeSpaces(v []*string) *ConfluenceSpaceConfiguration { + s.IncludeSpaces = v + return s +} + +// SetSpaceFieldMappings sets the SpaceFieldMappings field's value. +func (s *ConfluenceSpaceConfiguration) SetSpaceFieldMappings(v []*ConfluenceSpaceToIndexFieldMapping) *ConfluenceSpaceConfiguration { + s.SpaceFieldMappings = v + return s +} + +// Defines the mapping between a field in the Confluence data source to a Amazon +// Kendra index field. +// +// You must first create the index field using the UpdateIndex operation. +type ConfluenceSpaceToIndexFieldMapping struct { + _ struct{} `type:"structure"` + + // The name of the field in the data source. + DataSourceFieldName *string `type:"string" enum:"ConfluenceSpaceFieldName"` + + // The format for date fields in the data source. If the field specified in + // DataSourceFieldName is a date field you must specify the date format. If + // the field is not a date field, an exception is thrown. + DateFieldFormat *string `min:"4" type:"string"` + + // The name of the index field to map to the Confluence data source field. The + // index field type must match the Confluence field type. + IndexFieldName *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 ConfluenceSpaceToIndexFieldMapping) 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 ConfluenceSpaceToIndexFieldMapping) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfluenceSpaceToIndexFieldMapping"} + if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { + invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) + } + if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceFieldName sets the DataSourceFieldName field's value. +func (s *ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceSpaceToIndexFieldMapping { + s.DataSourceFieldName = &v + return s +} + +// SetDateFieldFormat sets the DateFieldFormat field's value. +func (s *ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceSpaceToIndexFieldMapping { + s.DateFieldFormat = &v + return s +} + +// SetIndexFieldName sets the IndexFieldName field's value. +func (s *ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceSpaceToIndexFieldMapping { + s.IndexFieldName = &v + return s +} + +// Provides the information necessary to connect to a database. +type ConnectionConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the host for the database. Can be either a string (host.subdomain.domain.tld) + // or an IPv4 or IPv6 address. + // + // DatabaseHost is a required field + DatabaseHost *string `min:"1" type:"string" required:"true"` + + // The name of the database containing the document data. + // + // DatabaseName is a required field + DatabaseName *string `min:"1" type:"string" required:"true"` + + // The port that the database uses for connections. + // + // DatabasePort is a required field + DatabasePort *int64 `min:"1" type:"integer" required:"true"` + + // The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. + // The credentials should be a user/password pair. For more information, see + // Using a Database Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). + // For more information about Secrets Manager, see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // in the Secrets Manager user guide. + // + // SecretArn is a required field + SecretArn *string `min:"1" type:"string" required:"true"` + + // The name of the table that contains the document data. + // + // TableName is a required field + TableName *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 ConnectionConfiguration) 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 ConnectionConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConnectionConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConnectionConfiguration"} + if s.DatabaseHost == nil { + invalidParams.Add(request.NewErrParamRequired("DatabaseHost")) + } + if s.DatabaseHost != nil && len(*s.DatabaseHost) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatabaseHost", 1)) + } + if s.DatabaseName == nil { + invalidParams.Add(request.NewErrParamRequired("DatabaseName")) + } + if s.DatabaseName != nil && len(*s.DatabaseName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatabaseName", 1)) + } + if s.DatabasePort == nil { + invalidParams.Add(request.NewErrParamRequired("DatabasePort")) + } + if s.DatabasePort != nil && *s.DatabasePort < 1 { + invalidParams.Add(request.NewErrParamMinValue("DatabasePort", 1)) + } + if s.SecretArn == nil { + invalidParams.Add(request.NewErrParamRequired("SecretArn")) + } + if s.SecretArn != nil && len(*s.SecretArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) + } + if s.TableName == nil { + invalidParams.Add(request.NewErrParamRequired("TableName")) + } + if s.TableName != nil && len(*s.TableName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TableName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatabaseHost sets the DatabaseHost field's value. +func (s *ConnectionConfiguration) SetDatabaseHost(v string) *ConnectionConfiguration { + s.DatabaseHost = &v + return s +} + +// SetDatabaseName sets the DatabaseName field's value. +func (s *ConnectionConfiguration) SetDatabaseName(v string) *ConnectionConfiguration { + s.DatabaseName = &v + return s +} + +// SetDatabasePort sets the DatabasePort field's value. +func (s *ConnectionConfiguration) SetDatabasePort(v int64) *ConnectionConfiguration { + s.DatabasePort = &v + return s +} + +// SetSecretArn sets the SecretArn field's value. +func (s *ConnectionConfiguration) SetSecretArn(v string) *ConnectionConfiguration { + s.SecretArn = &v + return s +} + +// SetTableName sets the TableName field's value. +func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguration { + s.TableName = &v + return s +} + +// Configuration information for your content sources, such as data sources, +// FAQs, and content indexed directly via BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html). +type ContentSourceConfiguration struct { + _ struct{} `type:"structure"` + + // The identifier of the data sources you want to use for your Amazon Kendra + // experience. + DataSourceIds []*string `min:"1" type:"list"` + + // TRUE to use documents you indexed directly using the BatchPutDocument operation. + DirectPutContent *bool `type:"boolean"` + + // The identifier of the FAQs that you want to use for your Amazon Kendra experience. + FaqIds []*string `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 ContentSourceConfiguration) 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 ContentSourceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ContentSourceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContentSourceConfiguration"} + if s.DataSourceIds != nil && len(s.DataSourceIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceIds", 1)) + } + if s.FaqIds != nil && len(s.FaqIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FaqIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceIds sets the DataSourceIds field's value. +func (s *ContentSourceConfiguration) SetDataSourceIds(v []*string) *ContentSourceConfiguration { + s.DataSourceIds = v + return s +} + +// SetDirectPutContent sets the DirectPutContent field's value. +func (s *ContentSourceConfiguration) SetDirectPutContent(v bool) *ContentSourceConfiguration { + s.DirectPutContent = &v + return s +} + +// SetFaqIds sets the FaqIds field's value. +func (s *ContentSourceConfiguration) SetFaqIds(v []*string) *ContentSourceConfiguration { + s.FaqIds = v + return s +} + +type CreateDataSourceInput struct { + _ struct{} `type:"structure"` + + // A token that you provide to identify the request to create a data source. + // Multiple calls to the CreateDataSource operation with the same client token + // will create only one data source. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The connector configuration information that is required to access the repository. + // + // You can't specify the Configuration parameter when the Type parameter is + // set to CUSTOM. If you do, you receive a ValidationException exception. + // + // The Configuration parameter is required for all other data sources. + Configuration *DataSourceConfiguration `type:"structure"` + + // Configuration information for altering document metadata and content during + // the document ingestion process when you create a data source. + // + // For more information on how to create, modify and delete document metadata, + // or make other content alterations when you ingest documents into Amazon Kendra, + // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"` + + // A description for the data source. + Description *string `type:"string"` + + // The identifier of the index that should be associated with this data source. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The code for a language. This allows you to support a language for all documents + // when creating the data source. English is supported by default. For more + // information on supported languages, including their codes, see Adding documents + // in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` + + // A unique name for the data source. A data source name can't be changed without + // deleting and recreating the data source. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of a role with permission to access the data + // source. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // + // You can't specify the RoleArn parameter when the Type parameter is set to + // CUSTOM. If you do, you receive a ValidationException exception. + // + // The RoleArn parameter is required for all other data sources. + RoleArn *string `type:"string"` + + // Sets the frequency that Amazon Kendra will check the documents in your repository + // and update the index. If you don't set a schedule Amazon Kendra will not + // periodically update the index. You can call the StartDataSourceSyncJob operation + // to update the index. + // + // You can't specify the Schedule parameter when the Type parameter is set to + // CUSTOM. If you do, you receive a ValidationException exception. + Schedule *string `type:"string"` + + // A list of key-value pairs that identify the data source. You can use the + // tags to identify and organize your resources and to control access to resources. + Tags []*Tag `type:"list"` + + // The type of repository that contains the data source. + // + // Type is a required field + Type *string `type:"string" required:"true" enum:"DataSourceType"` +} + +// 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 CreateDataSourceInput) 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 CreateDataSourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDataSourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDataSourceInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.LanguageCode != nil && len(*s.LanguageCode) < 2 { + invalidParams.Add(request.NewErrParamMinLen("LanguageCode", 2)) + } + 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.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Configuration != nil { + if err := s.Configuration.Validate(); err != nil { + invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) + } + } + if s.CustomDocumentEnrichmentConfiguration != nil { + if err := s.CustomDocumentEnrichmentConfiguration.Validate(); err != nil { + invalidParams.AddNested("CustomDocumentEnrichmentConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateDataSourceInput) SetClientToken(v string) *CreateDataSourceInput { + s.ClientToken = &v + return s +} + +// SetConfiguration sets the Configuration field's value. +func (s *CreateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput { + s.Configuration = v + return s +} + +// SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value. +func (s *CreateDataSourceInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *CreateDataSourceInput { + s.CustomDocumentEnrichmentConfiguration = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput { + s.Description = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *CreateDataSourceInput) SetIndexId(v string) *CreateDataSourceInput { + s.IndexId = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *CreateDataSourceInput) SetLanguageCode(v string) *CreateDataSourceInput { + s.LanguageCode = &v + return s } -// Provides information about the column that should be used for filtering the -// query response by groups. -type AclConfiguration struct { +// SetName sets the Name field's value. +func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreateDataSourceInput) SetRoleArn(v string) *CreateDataSourceInput { + s.RoleArn = &v + return s +} + +// SetSchedule sets the Schedule field's value. +func (s *CreateDataSourceInput) SetSchedule(v string) *CreateDataSourceInput { + s.Schedule = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateDataSourceInput) SetTags(v []*Tag) *CreateDataSourceInput { + s.Tags = v + return s +} + +// SetType sets the Type field's value. +func (s *CreateDataSourceInput) SetType(v string) *CreateDataSourceInput { + s.Type = &v + return s +} + +type CreateDataSourceOutput struct { _ struct{} `type:"structure"` - // A list of groups, separated by semi-colons, that filters a query response - // based on user context. The document is only returned to users that are in - // one of the groups specified in the UserContext field of the Query operation. + // A unique identifier for the data source. // - // AllowedGroupsColumnName is a required field - AllowedGroupsColumnName *string `min:"1" type:"string" required:"true"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4256,7 +8421,7 @@ type AclConfiguration 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 AclConfiguration) String() string { +func (s CreateDataSourceOutput) String() string { return awsutil.Prettify(s) } @@ -4265,18 +8430,280 @@ func (s AclConfiguration) 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 AclConfiguration) GoString() string { +func (s CreateDataSourceOutput) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *CreateDataSourceOutput) SetId(v string) *CreateDataSourceOutput { + s.Id = &v + return s +} + +type CreateExperienceInput struct { + _ struct{} `type:"structure"` + + // A token that you provide to identify the request to create your Amazon Kendra + // experience. Multiple calls to the CreateExperience operation with the same + // client token creates only one Amazon Kendra experience. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // Provides the configuration information for your Amazon Kendra experience. + // This includes ContentSourceConfiguration, which specifies the data source + // IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user + // or group information to grant access to your Amazon Kendra experience. + Configuration *ExperienceConfiguration `type:"structure"` + + // A description for your Amazon Kendra experience. + Description *string `type:"string"` + + // The identifier of the index for your Amazon Kendra experience. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // A name for your Amazon Kendra experience. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of a role with permission to access Query + // operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon + // Web Services SSO that stores your user and group information. For more information, + // see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + RoleArn *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 CreateExperienceInput) 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 CreateExperienceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *AclConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AclConfiguration"} - if s.AllowedGroupsColumnName == nil { - invalidParams.Add(request.NewErrParamRequired("AllowedGroupsColumnName")) +func (s *CreateExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateExperienceInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + 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.Configuration != nil { + if err := s.Configuration.Validate(); err != nil { + invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateExperienceInput) SetClientToken(v string) *CreateExperienceInput { + s.ClientToken = &v + return s +} + +// SetConfiguration sets the Configuration field's value. +func (s *CreateExperienceInput) SetConfiguration(v *ExperienceConfiguration) *CreateExperienceInput { + s.Configuration = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateExperienceInput) SetDescription(v string) *CreateExperienceInput { + s.Description = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *CreateExperienceInput) SetIndexId(v string) *CreateExperienceInput { + s.IndexId = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateExperienceInput) SetName(v string) *CreateExperienceInput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreateExperienceInput) SetRoleArn(v string) *CreateExperienceInput { + s.RoleArn = &v + return s +} + +type CreateExperienceOutput struct { + _ struct{} `type:"structure"` + + // The identifier for your created Amazon Kendra experience. + // + // Id is a required field + Id *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 CreateExperienceOutput) 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 CreateExperienceOutput) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *CreateExperienceOutput) SetId(v string) *CreateExperienceOutput { + s.Id = &v + return s +} + +type CreateFaqInput struct { + _ struct{} `type:"structure"` + + // A token that you provide to identify the request to create a FAQ. Multiple + // calls to the CreateFaqRequest operation with the same client token will create + // only one FAQ. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // A description of the FAQ. + Description *string `type:"string"` + + // The format of the input file. You can choose between a basic CSV format, + // a CSV format that includes customs attributes in a header, and a JSON format + // that includes custom attributes. + // + // The format must match the format of the file stored in the S3 bucket identified + // in the S3Path parameter. + // + // For more information, see Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html). + FileFormat *string `type:"string" enum:"FaqFileFormat"` + + // The identifier of the index that contains the FAQ. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The code for a language. This allows you to support a language for the FAQ + // document. English is supported by default. For more information on supported + // languages, including their codes, see Adding documents in languages other + // than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` + + // The name that should be associated with the FAQ. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of a role with permission to access the S3 + // bucket that contains the FAQs. For more information, see IAM Roles for Amazon + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` + + // The S3 location of the FAQ input data. + // + // S3Path is a required field + S3Path *S3Path `type:"structure" required:"true"` + + // A list of key-value pairs that identify the FAQ. You can use the tags to + // identify and organize your resources and to control access to resources. + Tags []*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 CreateFaqInput) 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 CreateFaqInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFaqInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFaqInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.AllowedGroupsColumnName != nil && len(*s.AllowedGroupsColumnName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("AllowedGroupsColumnName", 1)) + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.LanguageCode != nil && len(*s.LanguageCode) < 2 { + invalidParams.Add(request.NewErrParamMinLen("LanguageCode", 2)) + } + 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.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.S3Path == nil { + invalidParams.Add(request.NewErrParamRequired("S3Path")) + } + if s.S3Path != nil { + if err := s.S3Path.Validate(); err != nil { + invalidParams.AddNested("S3Path", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -4285,75 +8712,65 @@ func (s *AclConfiguration) Validate() error { return nil } -// SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value. -func (s *AclConfiguration) SetAllowedGroupsColumnName(v string) *AclConfiguration { - s.AllowedGroupsColumnName = &v +// SetClientToken sets the ClientToken field's value. +func (s *CreateFaqInput) SetClientToken(v string) *CreateFaqInput { + s.ClientToken = &v return s } -// An attribute returned from an index query. -type AdditionalResultAttribute struct { - _ struct{} `type:"structure"` - - // The key that identifies the attribute. - // - // Key is a required field - Key *string `min:"1" type:"string" required:"true"` +// SetDescription sets the Description field's value. +func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput { + s.Description = &v + return s +} - // An object that contains the attribute value. - // - // Value is a required field - Value *AdditionalResultAttributeValue `type:"structure" required:"true"` +// SetFileFormat sets the FileFormat field's value. +func (s *CreateFaqInput) SetFileFormat(v string) *CreateFaqInput { + s.FileFormat = &v + return s +} - // The data type of the Value property. - // - // ValueType is a required field - ValueType *string `type:"string" required:"true" enum:"AdditionalResultAttributeValueType"` +// SetIndexId sets the IndexId field's value. +func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput { + s.IndexId = &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 AdditionalResultAttribute) String() string { - return awsutil.Prettify(s) +// SetLanguageCode sets the LanguageCode field's value. +func (s *CreateFaqInput) SetLanguageCode(v string) *CreateFaqInput { + s.LanguageCode = &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 AdditionalResultAttribute) GoString() string { - return s.String() +// SetName sets the Name field's value. +func (s *CreateFaqInput) SetName(v string) *CreateFaqInput { + s.Name = &v + return s } -// SetKey sets the Key field's value. -func (s *AdditionalResultAttribute) SetKey(v string) *AdditionalResultAttribute { - s.Key = &v +// SetRoleArn sets the RoleArn field's value. +func (s *CreateFaqInput) SetRoleArn(v string) *CreateFaqInput { + s.RoleArn = &v return s } -// SetValue sets the Value field's value. -func (s *AdditionalResultAttribute) SetValue(v *AdditionalResultAttributeValue) *AdditionalResultAttribute { - s.Value = v +// SetS3Path sets the S3Path field's value. +func (s *CreateFaqInput) SetS3Path(v *S3Path) *CreateFaqInput { + s.S3Path = v return s } -// SetValueType sets the ValueType field's value. -func (s *AdditionalResultAttribute) SetValueType(v string) *AdditionalResultAttribute { - s.ValueType = &v +// SetTags sets the Tags field's value. +func (s *CreateFaqInput) SetTags(v []*Tag) *CreateFaqInput { + s.Tags = v return s } -// An attribute returned with a document from a search. -type AdditionalResultAttributeValue struct { +type CreateFaqOutput struct { _ struct{} `type:"structure"` - // The text associated with the attribute and information about the highlight - // to apply to the text. - TextWithHighlightsValue *TextWithHighlights `type:"structure"` + // The unique identifier of the FAQ. + Id *string `min:"1" type:"string"` } // String returns the string representation. @@ -4361,7 +8778,7 @@ type AdditionalResultAttributeValue 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 AdditionalResultAttributeValue) String() string { +func (s CreateFaqOutput) String() string { return awsutil.Prettify(s) } @@ -4370,71 +8787,83 @@ func (s AdditionalResultAttributeValue) 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 AdditionalResultAttributeValue) GoString() string { +func (s CreateFaqOutput) GoString() string { return s.String() } -// SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value. -func (s *AdditionalResultAttributeValue) SetTextWithHighlightsValue(v *TextWithHighlights) *AdditionalResultAttributeValue { - s.TextWithHighlightsValue = v +// SetId sets the Id field's value. +func (s *CreateFaqOutput) SetId(v string) *CreateFaqOutput { + s.Id = &v return s } -// Provides filtering the query results based on document attributes. -// -// When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers -// under the first attribute filter. For example, you can use: -// -// -// -// -// -// -// -// If you use more than 2 layers, you receive a ValidationException exception -// with the message "AttributeFilter cannot have a depth of more than 2." -// -// If you use more than 10 attribute filters in a given list for AndAllFilters -// or OrAllFilters, you receive a ValidationException with the message "AttributeFilter -// cannot have a length of more than 10". -type AttributeFilter struct { +type CreateIndexInput struct { _ struct{} `type:"structure"` - // Performs a logical AND operation on all supplied filters. - AndAllFilters []*AttributeFilter `type:"list"` + // A token that you provide to identify the request to create an index. Multiple + // calls to the CreateIndex operation with the same client token will create + // only one index. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - // Returns true when a document contains all of the specified document attributes. - // This filter is only applicable to StringListValue metadata. - ContainsAll *DocumentAttribute `type:"structure"` + // A description for the index. + Description *string `type:"string"` - // Returns true when a document contains any of the specified document attributes. - // This filter is only applicable to StringListValue metadata. - ContainsAny *DocumentAttribute `type:"structure"` + // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION + // for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION + // for your production databases. Once you set the edition for an index, it + // can't be changed. + // + // The Edition parameter is optional. If you don't supply a value, the default + // is ENTERPRISE_EDITION. + // + // For more information on quota limits for enterprise and developer editions, + // see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + Edition *string `type:"string" enum:"IndexEdition"` - // Performs an equals operation on two document attributes. - EqualsTo *DocumentAttribute `type:"structure"` + // The name for the new index. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // Performs a greater than operation on two document attributes. Use with a - // document attribute of type Date or Long. - GreaterThan *DocumentAttribute `type:"structure"` + // An Identity and Access Management(IAM) role that gives Amazon Kendra permissions + // to access your Amazon CloudWatch logs and metrics. This is also the role + // used when you use the BatchPutDocument operation to index documents from + // an Amazon S3 bucket. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` - // Performs a greater or equals than operation on two document attributes. Use - // with a document attribute of type Date or Long. - GreaterThanOrEquals *DocumentAttribute `type:"structure"` + // The identifier of the KMScustomer managed key (CMK) to use to encrypt data + // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` - // Performs a less than operation on two document attributes. Use with a document - // attribute of type Date or Long. - LessThan *DocumentAttribute `type:"structure"` + // A list of key-value pairs that identify the index. You can use the tags to + // identify and organize your resources and to control access to resources. + Tags []*Tag `type:"list"` - // Performs a less than or equals operation on two document attributes. Use - // with a document attribute of type Date or Long. - LessThanOrEquals *DocumentAttribute `type:"structure"` + // The user context policy. + // + // ATTRIBUTE_FILTER + // + // All indexed content is searchable and displayable for all users. If you want + // to filter search results on user context, you can use the attribute filters + // of _user_id and _group_ids or you can provide user and group information + // in UserContext. + // + // USER_TOKEN + // + // Enables token-based user access control to filter search results on user + // context. All documents with no access control and all documents accessible + // to the user will be searchable and displayable. + UserContextPolicy *string `type:"string" enum:"UserContextPolicy"` - // Performs a logical NOT operation on all supplied filters. - NotFilter *AttributeFilter `type:"structure"` + // Enables fetching access levels of groups and users from an Amazon Web Services + // Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration + // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). + UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"` - // Performs a logical OR operation on all supplied filters. - OrAllFilters []*AttributeFilter `type:"list"` + // The user token configuration. + UserTokenConfigurations []*UserTokenConfiguration `type:"list"` } // String returns the string representation. @@ -4442,7 +8871,7 @@ type AttributeFilter 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 AttributeFilter) String() string { +func (s CreateIndexInput) String() string { return awsutil.Prettify(s) } @@ -4451,60 +8880,52 @@ func (s AttributeFilter) 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 AttributeFilter) GoString() string { +func (s CreateIndexInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *AttributeFilter) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AttributeFilter"} - if s.ContainsAll != nil { - if err := s.ContainsAll.Validate(); err != nil { - invalidParams.AddNested("ContainsAll", err.(request.ErrInvalidParams)) - } - } - if s.ContainsAny != nil { - if err := s.ContainsAny.Validate(); err != nil { - invalidParams.AddNested("ContainsAny", err.(request.ErrInvalidParams)) - } +func (s *CreateIndexInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateIndexInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } - if s.EqualsTo != nil { - if err := s.EqualsTo.Validate(); err != nil { - invalidParams.AddNested("EqualsTo", err.(request.ErrInvalidParams)) - } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.GreaterThan != nil { - if err := s.GreaterThan.Validate(); err != nil { - invalidParams.AddNested("GreaterThan", err.(request.ErrInvalidParams)) - } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.GreaterThanOrEquals != nil { - if err := s.GreaterThanOrEquals.Validate(); err != nil { - invalidParams.AddNested("GreaterThanOrEquals", err.(request.ErrInvalidParams)) - } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) } - if s.LessThan != nil { - if err := s.LessThan.Validate(); err != nil { - invalidParams.AddNested("LessThan", err.(request.ErrInvalidParams)) + if s.ServerSideEncryptionConfiguration != nil { + if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) } } - if s.LessThanOrEquals != nil { - if err := s.LessThanOrEquals.Validate(); err != nil { - invalidParams.AddNested("LessThanOrEquals", err.(request.ErrInvalidParams)) + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } } } - if s.NotFilter != nil { - if err := s.NotFilter.Validate(); err != nil { - invalidParams.AddNested("NotFilter", err.(request.ErrInvalidParams)) + if s.UserGroupResolutionConfiguration != nil { + if err := s.UserGroupResolutionConfiguration.Validate(); err != nil { + invalidParams.AddNested("UserGroupResolutionConfiguration", err.(request.ErrInvalidParams)) } } - if s.OrAllFilters != nil { - for i, v := range s.OrAllFilters { + if s.UserTokenConfigurations != nil { + for i, v := range s.UserTokenConfigurations { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "OrAllFilters", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "UserTokenConfigurations", i), err.(request.ErrInvalidParams)) } } } @@ -4515,76 +8936,72 @@ func (s *AttributeFilter) Validate() error { return nil } -// SetAndAllFilters sets the AndAllFilters field's value. -func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter { - s.AndAllFilters = v +// SetClientToken sets the ClientToken field's value. +func (s *CreateIndexInput) SetClientToken(v string) *CreateIndexInput { + s.ClientToken = &v return s } -// SetContainsAll sets the ContainsAll field's value. -func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter { - s.ContainsAll = v +// SetDescription sets the Description field's value. +func (s *CreateIndexInput) SetDescription(v string) *CreateIndexInput { + s.Description = &v return s } -// SetContainsAny sets the ContainsAny field's value. -func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter { - s.ContainsAny = v +// SetEdition sets the Edition field's value. +func (s *CreateIndexInput) SetEdition(v string) *CreateIndexInput { + s.Edition = &v return s } -// SetEqualsTo sets the EqualsTo field's value. -func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter { - s.EqualsTo = v +// SetName sets the Name field's value. +func (s *CreateIndexInput) SetName(v string) *CreateIndexInput { + s.Name = &v return s } -// SetGreaterThan sets the GreaterThan field's value. -func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter { - s.GreaterThan = v +// SetRoleArn sets the RoleArn field's value. +func (s *CreateIndexInput) SetRoleArn(v string) *CreateIndexInput { + s.RoleArn = &v return s } -// SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value. -func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter { - s.GreaterThanOrEquals = v +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *CreateIndexInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateIndexInput { + s.ServerSideEncryptionConfiguration = v return s } -// SetLessThan sets the LessThan field's value. -func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter { - s.LessThan = v +// SetTags sets the Tags field's value. +func (s *CreateIndexInput) SetTags(v []*Tag) *CreateIndexInput { + s.Tags = v return s } -// SetLessThanOrEquals sets the LessThanOrEquals field's value. -func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter { - s.LessThanOrEquals = v +// SetUserContextPolicy sets the UserContextPolicy field's value. +func (s *CreateIndexInput) SetUserContextPolicy(v string) *CreateIndexInput { + s.UserContextPolicy = &v return s } -// SetNotFilter sets the NotFilter field's value. -func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter { - s.NotFilter = v +// SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value. +func (s *CreateIndexInput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *CreateIndexInput { + s.UserGroupResolutionConfiguration = v return s } -// SetOrAllFilters sets the OrAllFilters field's value. -func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter { - s.OrAllFilters = v +// SetUserTokenConfigurations sets the UserTokenConfigurations field's value. +func (s *CreateIndexInput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *CreateIndexInput { + s.UserTokenConfigurations = v return s } -// Provides the configuration information to connect to websites that require -// user authentication. -type AuthenticationConfiguration struct { +type CreateIndexOutput struct { _ struct{} `type:"structure"` - // The list of configuration information that's required to connect to and crawl - // a website host using basic authentication credentials. - // - // The list includes the name and port number of the website host. - BasicAuthentication []*BasicAuthenticationConfiguration `type:"list"` + // The unique identifier of the index. Use this identifier when you query an + // index, set up a data source, or index a document. + Id *string `min:"36" type:"string"` } // String returns the string representation. @@ -4592,7 +9009,7 @@ type AuthenticationConfiguration 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 AuthenticationConfiguration) String() string { +func (s CreateIndexOutput) String() string { return awsutil.Prettify(s) } @@ -4601,146 +9018,65 @@ func (s AuthenticationConfiguration) 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 AuthenticationConfiguration) GoString() string { +func (s CreateIndexOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *AuthenticationConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AuthenticationConfiguration"} - if s.BasicAuthentication != nil { - for i, v := range s.BasicAuthentication { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "BasicAuthentication", i), err.(request.ErrInvalidParams)) - } - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetBasicAuthentication sets the BasicAuthentication field's value. -func (s *AuthenticationConfiguration) SetBasicAuthentication(v []*BasicAuthenticationConfiguration) *AuthenticationConfiguration { - s.BasicAuthentication = v +// SetId sets the Id field's value. +func (s *CreateIndexOutput) SetId(v string) *CreateIndexOutput { + s.Id = &v return s } -// Provides the configuration information to connect to websites that require -// basic user authentication. -type BasicAuthenticationConfiguration struct { +type CreateQuerySuggestionsBlockListInput struct { _ struct{} `type:"structure"` - // Your secret ARN, which you can create in AWS Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) - // - // You use a secret if basic authentication credentials are required to connect - // to a website. The secret stores your credentials of user name and password. - // - // Credentials is a required field - Credentials *string `min:"1" type:"string" required:"true"` + // A token that you provide to identify the request to create a query suggestions + // block list. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - // The name of the website host you want to connect to using authentication - // credentials. + // A user-friendly description for the block list. // - // For example, the host name of https://a.example.com/page1.html is "a.example.com". + // For example, the description "List of all offensive words that can appear + // in user queries and need to be blocked from suggestions." + Description *string `type:"string"` + + // The identifier of the index you want to create a query suggestions block + // list for. // - // Host is a required field - Host *string `min:"1" type:"string" required:"true"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // The port number of the website host you want to connect to using authentication - // credentials. + // A user friendly name for the block list. // - // For example, the port for https://a.example.com/page1.html is 443, the standard - // port for HTTPS. + // For example, the block list named 'offensive-words' includes all offensive + // words that could appear in user queries and need to be blocked from suggestions. // - // Port is a required field - Port *int64 `min:"1" type:"integer" 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 BasicAuthenticationConfiguration) 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 BasicAuthenticationConfiguration) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *BasicAuthenticationConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BasicAuthenticationConfiguration"} - if s.Credentials == nil { - invalidParams.Add(request.NewErrParamRequired("Credentials")) - } - if s.Credentials != nil && len(*s.Credentials) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Credentials", 1)) - } - if s.Host == nil { - invalidParams.Add(request.NewErrParamRequired("Host")) - } - if s.Host != nil && len(*s.Host) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Host", 1)) - } - if s.Port == nil { - invalidParams.Add(request.NewErrParamRequired("Port")) - } - if s.Port != nil && *s.Port < 1 { - invalidParams.Add(request.NewErrParamMinValue("Port", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetCredentials sets the Credentials field's value. -func (s *BasicAuthenticationConfiguration) SetCredentials(v string) *BasicAuthenticationConfiguration { - s.Credentials = &v - return s -} - -// SetHost sets the Host field's value. -func (s *BasicAuthenticationConfiguration) SetHost(v string) *BasicAuthenticationConfiguration { - s.Host = &v - return s -} - -// SetPort sets the Port field's value. -func (s *BasicAuthenticationConfiguration) SetPort(v int64) *BasicAuthenticationConfiguration { - s.Port = &v - return s -} - -type BatchDeleteDocumentInput struct { - _ struct{} `type:"structure"` - - // Maps a particular data source sync job to a particular data source. - DataSourceSyncJobMetricTarget *DataSourceSyncJobMetricTarget `type:"structure"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // One or more identifiers for documents to delete from the index. + // The IAM (Identity and Access Management) role used by Amazon Kendra to access + // the block list text file in your S3 bucket. // - // DocumentIdList is a required field - DocumentIdList []*string `min:"1" type:"list" required:"true"` + // You need permissions to the role ARN (Amazon Resource Name). The role needs + // S3 read permissions to your file in S3 and needs to give STS (Security Token + // Service) assume role permissions to Amazon Kendra. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` - // The identifier of the index that contains the documents to delete. + // The S3 path to your block list text file in your S3 bucket. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // Each block word or phrase should be on a separate line in a text file. + // + // For information on the current quota limits for block lists, see Quotas for + // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // + // SourceS3Path is a required field + SourceS3Path *S3Path `type:"structure" required:"true"` + + // A tag that you can assign to a block list that categorizes the block list. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -4748,7 +9084,7 @@ type BatchDeleteDocumentInput 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 BatchDeleteDocumentInput) String() string { +func (s CreateQuerySuggestionsBlockListInput) String() string { return awsutil.Prettify(s) } @@ -4757,18 +9093,15 @@ func (s BatchDeleteDocumentInput) 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 BatchDeleteDocumentInput) GoString() string { +func (s CreateQuerySuggestionsBlockListInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDeleteDocumentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDeleteDocumentInput"} - if s.DocumentIdList == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentIdList")) - } - if s.DocumentIdList != nil && len(s.DocumentIdList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentIdList", 1)) +func (s *CreateQuerySuggestionsBlockListInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateQuerySuggestionsBlockListInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -4776,9 +9109,31 @@ func (s *BatchDeleteDocumentInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.DataSourceSyncJobMetricTarget != nil { - if err := s.DataSourceSyncJobMetricTarget.Validate(); err != nil { - invalidParams.AddNested("DataSourceSyncJobMetricTarget", 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 s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.SourceS3Path == nil { + invalidParams.Add(request.NewErrParamRequired("SourceS3Path")) + } + if s.SourceS3Path != nil { + if err := s.SourceS3Path.Validate(); err != nil { + invalidParams.AddNested("SourceS3Path", 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)) + } } } @@ -4788,70 +9143,53 @@ func (s *BatchDeleteDocumentInput) Validate() error { return nil } -// SetDataSourceSyncJobMetricTarget sets the DataSourceSyncJobMetricTarget field's value. -func (s *BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget(v *DataSourceSyncJobMetricTarget) *BatchDeleteDocumentInput { - s.DataSourceSyncJobMetricTarget = v +// SetClientToken sets the ClientToken field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetClientToken(v string) *CreateQuerySuggestionsBlockListInput { + s.ClientToken = &v return s } -// SetDocumentIdList sets the DocumentIdList field's value. -func (s *BatchDeleteDocumentInput) SetDocumentIdList(v []*string) *BatchDeleteDocumentInput { - s.DocumentIdList = v +// SetDescription sets the Description field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetDescription(v string) *CreateQuerySuggestionsBlockListInput { + s.Description = &v return s } // SetIndexId sets the IndexId field's value. -func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput { +func (s *CreateQuerySuggestionsBlockListInput) SetIndexId(v string) *CreateQuerySuggestionsBlockListInput { s.IndexId = &v return s } -type BatchDeleteDocumentOutput struct { - _ struct{} `type:"structure"` - - // A list of documents that could not be removed from the index. Each entry - // contains an error message that indicates why the document couldn't be removed - // from the index. - FailedDocuments []*BatchDeleteDocumentResponseFailedDocument `type:"list"` +// SetName sets the Name field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetName(v string) *CreateQuerySuggestionsBlockListInput { + s.Name = &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 BatchDeleteDocumentOutput) String() string { - return awsutil.Prettify(s) +// SetRoleArn sets the RoleArn field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetRoleArn(v string) *CreateQuerySuggestionsBlockListInput { + s.RoleArn = &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 BatchDeleteDocumentOutput) GoString() string { - return s.String() +// SetSourceS3Path sets the SourceS3Path field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetSourceS3Path(v *S3Path) *CreateQuerySuggestionsBlockListInput { + s.SourceS3Path = v + return s } -// SetFailedDocuments sets the FailedDocuments field's value. -func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*BatchDeleteDocumentResponseFailedDocument) *BatchDeleteDocumentOutput { - s.FailedDocuments = v +// SetTags sets the Tags field's value. +func (s *CreateQuerySuggestionsBlockListInput) SetTags(v []*Tag) *CreateQuerySuggestionsBlockListInput { + s.Tags = v return s } -// Provides information about documents that could not be removed from an index -// by the BatchDeleteDocument operation. -type BatchDeleteDocumentResponseFailedDocument struct { +type CreateQuerySuggestionsBlockListOutput struct { _ struct{} `type:"structure"` - // The error code for why the document couldn't be removed from the index. - ErrorCode *string `type:"string" enum:"ErrorCode"` - - // An explanation for why the document couldn't be removed from the index. - ErrorMessage *string `min:"1" type:"string"` - - // The identifier of the document that couldn't be removed from the index. - Id *string `min:"1" type:"string"` + // The unique identifier of the created block list. + Id *string `min:"36" type:"string"` } // String returns the string representation. @@ -4859,7 +9197,7 @@ type BatchDeleteDocumentResponseFailedDocument 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 BatchDeleteDocumentResponseFailedDocument) String() string { +func (s CreateQuerySuggestionsBlockListOutput) String() string { return awsutil.Prettify(s) } @@ -4868,44 +9206,51 @@ func (s BatchDeleteDocumentResponseFailedDocument) 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 BatchDeleteDocumentResponseFailedDocument) GoString() string { +func (s CreateQuerySuggestionsBlockListOutput) GoString() string { return s.String() } -// SetErrorCode sets the ErrorCode field's value. -func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorCode(v string) *BatchDeleteDocumentResponseFailedDocument { - s.ErrorCode = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchDeleteDocumentResponseFailedDocument { - s.ErrorMessage = &v - return s -} - // SetId sets the Id field's value. -func (s *BatchDeleteDocumentResponseFailedDocument) SetId(v string) *BatchDeleteDocumentResponseFailedDocument { +func (s *CreateQuerySuggestionsBlockListOutput) SetId(v string) *CreateQuerySuggestionsBlockListOutput { s.Id = &v return s } -type BatchGetDocumentStatusInput struct { +type CreateThesaurusInput struct { _ struct{} `type:"structure"` - // A list of DocumentInfo objects that identify the documents for which to get - // the status. You identify the documents by their document ID and optional - // attributes. - // - // DocumentInfoList is a required field - DocumentInfoList []*DocumentInfo `min:"1" type:"list" required:"true"` + // A token that you provide to identify the request to create a thesaurus. Multiple + // calls to the CreateThesaurus operation with the same client token will create + // only one thesaurus. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - // The identifier of the index to add documents to. The index ID is returned - // by the CreateIndex (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) - // operation. + // The description for the new thesaurus. + Description *string `type:"string"` + + // The unique identifier of the index for the new thesaurus. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` + + // The name for the new thesaurus. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // An IAM role that gives Amazon Kendra permissions to access thesaurus file + // specified in SourceS3Path. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` + + // The thesaurus file Amazon S3 source path. + // + // SourceS3Path is a required field + SourceS3Path *S3Path `type:"structure" required:"true"` + + // A list of key-value pairs that identify the thesaurus. You can use the tags + // to identify and organize your resources and to control access to resources. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -4913,7 +9258,7 @@ type BatchGetDocumentStatusInput 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 BatchGetDocumentStatusInput) String() string { +func (s CreateThesaurusInput) String() string { return awsutil.Prettify(s) } @@ -4922,18 +9267,15 @@ func (s BatchGetDocumentStatusInput) 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 BatchGetDocumentStatusInput) GoString() string { +func (s CreateThesaurusInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchGetDocumentStatusInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchGetDocumentStatusInput"} - if s.DocumentInfoList == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentInfoList")) - } - if s.DocumentInfoList != nil && len(s.DocumentInfoList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentInfoList", 1)) +func (s *CreateThesaurusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateThesaurusInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -4941,13 +9283,30 @@ func (s *BatchGetDocumentStatusInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.DocumentInfoList != nil { - for i, v := range s.DocumentInfoList { + 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.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.SourceS3Path == nil { + invalidParams.Add(request.NewErrParamRequired("SourceS3Path")) + } + if s.SourceS3Path != nil { + if err := s.SourceS3Path.Validate(); err != nil { + invalidParams.AddNested("SourceS3Path", 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]", "DocumentInfoList", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) } } } @@ -4958,76 +9317,53 @@ func (s *BatchGetDocumentStatusInput) Validate() error { return nil } -// SetDocumentInfoList sets the DocumentInfoList field's value. -func (s *BatchGetDocumentStatusInput) SetDocumentInfoList(v []*DocumentInfo) *BatchGetDocumentStatusInput { - s.DocumentInfoList = v +// SetClientToken sets the ClientToken field's value. +func (s *CreateThesaurusInput) SetClientToken(v string) *CreateThesaurusInput { + s.ClientToken = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *BatchGetDocumentStatusInput) SetIndexId(v string) *BatchGetDocumentStatusInput { - s.IndexId = &v +// SetDescription sets the Description field's value. +func (s *CreateThesaurusInput) SetDescription(v string) *CreateThesaurusInput { + s.Description = &v return s } -type BatchGetDocumentStatusOutput struct { - _ struct{} `type:"structure"` - - // The status of documents. The status indicates if the document is waiting - // to be indexed, is in the process of indexing, has completed indexing, or - // failed indexing. If a document failed indexing, the status provides the reason - // why. - DocumentStatusList []*Status `type:"list"` - - // A list of documents that Amazon Kendra couldn't get the status for. The list - // includes the ID of the document and the reason that the status couldn't be - // found. - Errors []*BatchGetDocumentStatusResponseError `type:"list"` +// SetIndexId sets the IndexId field's value. +func (s *CreateThesaurusInput) SetIndexId(v string) *CreateThesaurusInput { + s.IndexId = &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 BatchGetDocumentStatusOutput) String() string { - return awsutil.Prettify(s) +// SetName sets the Name field's value. +func (s *CreateThesaurusInput) SetName(v string) *CreateThesaurusInput { + s.Name = &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 BatchGetDocumentStatusOutput) GoString() string { - return s.String() +// SetRoleArn sets the RoleArn field's value. +func (s *CreateThesaurusInput) SetRoleArn(v string) *CreateThesaurusInput { + s.RoleArn = &v + return s } -// SetDocumentStatusList sets the DocumentStatusList field's value. -func (s *BatchGetDocumentStatusOutput) SetDocumentStatusList(v []*Status) *BatchGetDocumentStatusOutput { - s.DocumentStatusList = v +// SetSourceS3Path sets the SourceS3Path field's value. +func (s *CreateThesaurusInput) SetSourceS3Path(v *S3Path) *CreateThesaurusInput { + s.SourceS3Path = v return s } -// SetErrors sets the Errors field's value. -func (s *BatchGetDocumentStatusOutput) SetErrors(v []*BatchGetDocumentStatusResponseError) *BatchGetDocumentStatusOutput { - s.Errors = v +// SetTags sets the Tags field's value. +func (s *CreateThesaurusInput) SetTags(v []*Tag) *CreateThesaurusInput { + s.Tags = v return s } -// Provides a response when the status of a document could not be retrieved. -type BatchGetDocumentStatusResponseError struct { +type CreateThesaurusOutput struct { _ struct{} `type:"structure"` - // The unique identifier of the document whose status could not be retrieved. - DocumentId *string `min:"1" type:"string"` - - // Indicates the source of the error. - ErrorCode *string `type:"string" enum:"ErrorCode"` - - // States that the API could not get the status of a document. This could be - // because the request is not valid or there is a system error. - ErrorMessage *string `min:"1" type:"string"` + // The unique identifier of the thesaurus. + Id *string `min:"1" type:"string"` } // String returns the string representation. @@ -5035,7 +9371,7 @@ type BatchGetDocumentStatusResponseError 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 BatchGetDocumentStatusResponseError) String() string { +func (s CreateThesaurusOutput) String() string { return awsutil.Prettify(s) } @@ -5044,62 +9380,47 @@ func (s BatchGetDocumentStatusResponseError) 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 BatchGetDocumentStatusResponseError) GoString() string { +func (s CreateThesaurusOutput) GoString() string { return s.String() } -// SetDocumentId sets the DocumentId field's value. -func (s *BatchGetDocumentStatusResponseError) SetDocumentId(v string) *BatchGetDocumentStatusResponseError { - s.DocumentId = &v - return s -} - -// SetErrorCode sets the ErrorCode field's value. -func (s *BatchGetDocumentStatusResponseError) SetErrorCode(v string) *BatchGetDocumentStatusResponseError { - s.ErrorCode = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *BatchGetDocumentStatusResponseError) SetErrorMessage(v string) *BatchGetDocumentStatusResponseError { - s.ErrorMessage = &v +// SetId sets the Id field's value. +func (s *CreateThesaurusOutput) SetId(v string) *CreateThesaurusOutput { + s.Id = &v return s } -type BatchPutDocumentInput struct { +// Provides the configuration information for altering document metadata and +// content during the document ingestion process. +// +// For more information, see Customizing document metadata during the ingestion +// process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +type CustomDocumentEnrichmentConfiguration struct { _ struct{} `type:"structure"` - // One or more documents to add to the index. - // - // Documents can include custom attributes. For example, 'DataSourceId' and - // 'DataSourceSyncJobId' are custom attributes that provide information on the - // synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' - // could be an optional custom attribute as Amazon Kendra will use the ID of - // a running sync job. - // - // Documents have the following file size limits. - // - // * 5 MB total size for inline documents - // - // * 50 MB total size for files from an S3 bucket - // - // * 5 MB extracted text for any file - // - // For more information about file size and transaction per second quotas, see - // Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). - // - // Documents is a required field - Documents []*Document `min:"1" type:"list" required:"true"` + // Configuration information to alter document attributes or metadata fields + // and content when ingesting documents into Amazon Kendra. + InlineConfigurations []*InlineCustomDocumentEnrichmentConfiguration `type:"list"` - // The identifier of the index to add the documents to. You need to create the - // index first using the CreateIndex operation. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // Configuration information for invoking a Lambda function in Lambda on the + // structured documents with their metadata and text extracted. You can use + // a Lambda function to apply advanced logic for creating, modifying, or deleting + // document metadata and content. For more information, see Advanced data manipulation + // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation). + PostExtractionHookConfiguration *HookConfiguration `type:"structure"` - // The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument - // operation. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - RoleArn *string `min:"1" type:"string"` + // Configuration information for invoking a Lambda function in Lambda on the + // original or raw documents before extracting their metadata and text. You + // can use a Lambda function to apply advanced logic for creating, modifying, + // or deleting document metadata and content. For more information, see Advanced + // data manipulation (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation). + PreExtractionHookConfiguration *HookConfiguration `type:"structure"` + + // The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration + // and PostExtractionHookConfiguration for altering document metadata and content + // during the document ingestion process. For more information, see IAM roles + // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + RoleArn *string `type:"string"` } // String returns the string representation. @@ -5107,7 +9428,7 @@ type BatchPutDocumentInput 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 BatchPutDocumentInput) String() string { +func (s CustomDocumentEnrichmentConfiguration) String() string { return awsutil.Prettify(s) } @@ -5116,38 +9437,33 @@ func (s BatchPutDocumentInput) 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 BatchPutDocumentInput) GoString() string { +func (s CustomDocumentEnrichmentConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchPutDocumentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchPutDocumentInput"} - if s.Documents == nil { - invalidParams.Add(request.NewErrParamRequired("Documents")) - } - if s.Documents != nil && len(s.Documents) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Documents", 1)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) - } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.Documents != nil { - for i, v := range s.Documents { +func (s *CustomDocumentEnrichmentConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CustomDocumentEnrichmentConfiguration"} + if s.InlineConfigurations != nil { + for i, v := range s.InlineConfigurations { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Documents", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "InlineConfigurations", i), err.(request.ErrInvalidParams)) } } } + if s.PostExtractionHookConfiguration != nil { + if err := s.PostExtractionHookConfiguration.Validate(); err != nil { + invalidParams.AddNested("PostExtractionHookConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.PreExtractionHookConfiguration != nil { + if err := s.PreExtractionHookConfiguration.Validate(); err != nil { + invalidParams.AddNested("PreExtractionHookConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -5155,35 +9471,67 @@ func (s *BatchPutDocumentInput) Validate() error { return nil } -// SetDocuments sets the Documents field's value. -func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput { - s.Documents = v +// SetInlineConfigurations sets the InlineConfigurations field's value. +func (s *CustomDocumentEnrichmentConfiguration) SetInlineConfigurations(v []*InlineCustomDocumentEnrichmentConfiguration) *CustomDocumentEnrichmentConfiguration { + s.InlineConfigurations = v return s } -// SetIndexId sets the IndexId field's value. -func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput { - s.IndexId = &v +// SetPostExtractionHookConfiguration sets the PostExtractionHookConfiguration field's value. +func (s *CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration { + s.PostExtractionHookConfiguration = v + return s +} + +// SetPreExtractionHookConfiguration sets the PreExtractionHookConfiguration field's value. +func (s *CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration { + s.PreExtractionHookConfiguration = v return s } // SetRoleArn sets the RoleArn field's value. -func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput { +func (s *CustomDocumentEnrichmentConfiguration) SetRoleArn(v string) *CustomDocumentEnrichmentConfiguration { s.RoleArn = &v return s } -type BatchPutDocumentOutput struct { +// Configuration information for an Amazon Kendra data source. +type DataSourceConfiguration struct { _ struct{} `type:"structure"` - // A list of documents that were not added to the index because the document - // failed a validation check. Each document contains an error message that indicates - // why the document couldn't be added to the index. - // - // If there was an error adding a document to an index the error is reported - // in your Amazon Web Services CloudWatch log. For more information, see Monitoring - // Amazon Kendra with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html) - FailedDocuments []*BatchPutDocumentResponseFailedDocument `type:"list"` + // Provides configuration information for connecting to a Confluence data source. + ConfluenceConfiguration *ConfluenceConfiguration `type:"structure"` + + // Provides information necessary to create a data source connector for a database. + DatabaseConfiguration *DatabaseConfiguration `type:"structure"` + + // Provides configuration for data sources that connect to Google Drive. + GoogleDriveConfiguration *GoogleDriveConfiguration `type:"structure"` + + // Provides configuration for data sources that connect to Microsoft OneDrive. + OneDriveConfiguration *OneDriveConfiguration `type:"structure"` + + // Provides information to create a data source connector for a document repository + // in an Amazon S3 bucket. + S3Configuration *S3DataSourceConfiguration `type:"structure"` + + // Provides configuration information for data sources that connect to a Salesforce + // site. + SalesforceConfiguration *SalesforceConfiguration `type:"structure"` + + // Provides configuration for data sources that connect to ServiceNow instances. + ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"` + + // Provides information necessary to create a data source connector for a Microsoft + // SharePoint site. + SharePointConfiguration *SharePointConfiguration `type:"structure"` + + // Provides the configuration information required for Amazon Kendra Web Crawler. + WebCrawlerConfiguration *WebCrawlerConfiguration `type:"structure"` + + // Provides the configuration information to connect to WorkDocs as your data + // source. + WorkDocsConfiguration *WorkDocsConfiguration `type:"structure"` } // String returns the string representation. @@ -5191,7 +9539,7 @@ type BatchPutDocumentOutput 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 BatchPutDocumentOutput) String() string { +func (s DataSourceConfiguration) String() string { return awsutil.Prettify(s) } @@ -5200,94 +9548,146 @@ func (s BatchPutDocumentOutput) 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 BatchPutDocumentOutput) GoString() string { +func (s DataSourceConfiguration) GoString() string { return s.String() } -// SetFailedDocuments sets the FailedDocuments field's value. -func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*BatchPutDocumentResponseFailedDocument) *BatchPutDocumentOutput { - s.FailedDocuments = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataSourceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceConfiguration"} + if s.ConfluenceConfiguration != nil { + if err := s.ConfluenceConfiguration.Validate(); err != nil { + invalidParams.AddNested("ConfluenceConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.DatabaseConfiguration != nil { + if err := s.DatabaseConfiguration.Validate(); err != nil { + invalidParams.AddNested("DatabaseConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.GoogleDriveConfiguration != nil { + if err := s.GoogleDriveConfiguration.Validate(); err != nil { + invalidParams.AddNested("GoogleDriveConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.OneDriveConfiguration != nil { + if err := s.OneDriveConfiguration.Validate(); err != nil { + invalidParams.AddNested("OneDriveConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3Configuration != nil { + if err := s.S3Configuration.Validate(); err != nil { + invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) + } + } + if s.SalesforceConfiguration != nil { + if err := s.SalesforceConfiguration.Validate(); err != nil { + invalidParams.AddNested("SalesforceConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.ServiceNowConfiguration != nil { + if err := s.ServiceNowConfiguration.Validate(); err != nil { + invalidParams.AddNested("ServiceNowConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.SharePointConfiguration != nil { + if err := s.SharePointConfiguration.Validate(); err != nil { + invalidParams.AddNested("SharePointConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.WebCrawlerConfiguration != nil { + if err := s.WebCrawlerConfiguration.Validate(); err != nil { + invalidParams.AddNested("WebCrawlerConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.WorkDocsConfiguration != nil { + if err := s.WorkDocsConfiguration.Validate(); err != nil { + invalidParams.AddNested("WorkDocsConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfluenceConfiguration sets the ConfluenceConfiguration field's value. +func (s *DataSourceConfiguration) SetConfluenceConfiguration(v *ConfluenceConfiguration) *DataSourceConfiguration { + s.ConfluenceConfiguration = v return s } -// Provides information about a document that could not be indexed. -type BatchPutDocumentResponseFailedDocument struct { - _ struct{} `type:"structure"` +// SetDatabaseConfiguration sets the DatabaseConfiguration field's value. +func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration { + s.DatabaseConfiguration = v + return s +} - // The type of error that caused the document to fail to be indexed. - ErrorCode *string `type:"string" enum:"ErrorCode"` +// SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value. +func (s *DataSourceConfiguration) SetGoogleDriveConfiguration(v *GoogleDriveConfiguration) *DataSourceConfiguration { + s.GoogleDriveConfiguration = v + return s +} - // A description of the reason why the document could not be indexed. - ErrorMessage *string `min:"1" type:"string"` +// SetOneDriveConfiguration sets the OneDriveConfiguration field's value. +func (s *DataSourceConfiguration) SetOneDriveConfiguration(v *OneDriveConfiguration) *DataSourceConfiguration { + s.OneDriveConfiguration = v + return s +} - // The unique identifier of the document. - Id *string `min:"1" type:"string"` +// SetS3Configuration sets the S3Configuration field's value. +func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration { + s.S3Configuration = 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 BatchPutDocumentResponseFailedDocument) String() string { - return awsutil.Prettify(s) +// SetSalesforceConfiguration sets the SalesforceConfiguration field's value. +func (s *DataSourceConfiguration) SetSalesforceConfiguration(v *SalesforceConfiguration) *DataSourceConfiguration { + s.SalesforceConfiguration = 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 BatchPutDocumentResponseFailedDocument) GoString() string { - return s.String() +// SetServiceNowConfiguration sets the ServiceNowConfiguration field's value. +func (s *DataSourceConfiguration) SetServiceNowConfiguration(v *ServiceNowConfiguration) *DataSourceConfiguration { + s.ServiceNowConfiguration = v + return s } -// SetErrorCode sets the ErrorCode field's value. -func (s *BatchPutDocumentResponseFailedDocument) SetErrorCode(v string) *BatchPutDocumentResponseFailedDocument { - s.ErrorCode = &v +// SetSharePointConfiguration sets the SharePointConfiguration field's value. +func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration { + s.SharePointConfiguration = v return s } -// SetErrorMessage sets the ErrorMessage field's value. -func (s *BatchPutDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchPutDocumentResponseFailedDocument { - s.ErrorMessage = &v +// SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value. +func (s *DataSourceConfiguration) SetWebCrawlerConfiguration(v *WebCrawlerConfiguration) *DataSourceConfiguration { + s.WebCrawlerConfiguration = v return s } -// SetId sets the Id field's value. -func (s *BatchPutDocumentResponseFailedDocument) SetId(v string) *BatchPutDocumentResponseFailedDocument { - s.Id = &v +// SetWorkDocsConfiguration sets the WorkDocsConfiguration field's value. +func (s *DataSourceConfiguration) SetWorkDocsConfiguration(v *WorkDocsConfiguration) *DataSourceConfiguration { + s.WorkDocsConfiguration = v return s } -// Specifies capacity units configured for your enterprise edition index. You -// can add and remove capacity units to tune an index to your requirements. -type CapacityUnitsConfiguration struct { +// Data source information for user context filtering. +type DataSourceGroup struct { _ struct{} `type:"structure"` - // The amount of extra query capacity for an index and GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) - // capacity. - // - // A single extra capacity unit for an index provides 0.1 queries per second - // or approximately 8,000 queries per day. - // - // GetQuerySuggestions capacity is five times the provisioned query capacity - // for an index, or the base capacity of 2.5 calls per second, whichever is - // higher. For example, the base capacity for an index is 0.1 queries per second, - // and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you - // add another 0.1 queries per second to total 0.2 queries per second for an - // index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than - // five times 0.2 queries per second). + // The identifier of the data source group you want to add to your list of data + // source groups. This is for filtering search results based on the groups' + // access to documents in that data source. // - // QueryCapacityUnits is a required field - QueryCapacityUnits *int64 `type:"integer" required:"true"` + // DataSourceId is a required field + DataSourceId *string `min:"1" type:"string" required:"true"` - // The amount of extra storage capacity for an index. A single capacity unit - // provides 30 GB of storage space or 100,000 documents, whichever is reached - // first. + // The identifier of the group you want to add to your list of groups. This + // is for filtering search results based on the groups' access to documents. // - // StorageCapacityUnits is a required field - StorageCapacityUnits *int64 `type:"integer" required:"true"` + // GroupId is a required field + GroupId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -5295,7 +9695,7 @@ type CapacityUnitsConfiguration 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 CapacityUnitsConfiguration) String() string { +func (s DataSourceGroup) String() string { return awsutil.Prettify(s) } @@ -5304,18 +9704,24 @@ func (s CapacityUnitsConfiguration) 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 CapacityUnitsConfiguration) GoString() string { +func (s DataSourceGroup) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CapacityUnitsConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CapacityUnitsConfiguration"} - if s.QueryCapacityUnits == nil { - invalidParams.Add(request.NewErrParamRequired("QueryCapacityUnits")) +func (s *DataSourceGroup) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceGroup"} + if s.DataSourceId == nil { + invalidParams.Add(request.NewErrParamRequired("DataSourceId")) } - if s.StorageCapacityUnits == nil { - invalidParams.Add(request.NewErrParamRequired("StorageCapacityUnits")) + if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) + } + if s.GroupId == nil { + invalidParams.Add(request.NewErrParamRequired("GroupId")) + } + if s.GroupId != nil && len(*s.GroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GroupId", 1)) } if invalidParams.Len() > 0 { @@ -5324,69 +9730,47 @@ func (s *CapacityUnitsConfiguration) Validate() error { return nil } -// SetQueryCapacityUnits sets the QueryCapacityUnits field's value. -func (s *CapacityUnitsConfiguration) SetQueryCapacityUnits(v int64) *CapacityUnitsConfiguration { - s.QueryCapacityUnits = &v +// SetDataSourceId sets the DataSourceId field's value. +func (s *DataSourceGroup) SetDataSourceId(v string) *DataSourceGroup { + s.DataSourceId = &v return s } -// SetStorageCapacityUnits sets the StorageCapacityUnits field's value. -func (s *CapacityUnitsConfiguration) SetStorageCapacityUnits(v int64) *CapacityUnitsConfiguration { - s.StorageCapacityUnits = &v +// SetGroupId sets the GroupId field's value. +func (s *DataSourceGroup) SetGroupId(v string) *DataSourceGroup { + s.GroupId = &v return s } -type ClearQuerySuggestionsInput struct { +// Summary information for a Amazon Kendra data source. Returned in a call to +// the DescribeDataSource operation. +type DataSourceSummary struct { _ struct{} `type:"structure"` - // The identifier of the index you want to clear query suggestions from. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` -} + // The UNIX datetime that the data source was created. + CreatedAt *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 ClearQuerySuggestionsInput) String() string { - return awsutil.Prettify(s) -} + // The unique identifier for the data source. + Id *string `min:"1" 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 ClearQuerySuggestionsInput) GoString() string { - return s.String() -} + // The code for a language. This shows a supported language for all documents + // in the data source. English is supported by default. For more information + // on supported languages, including their codes, see Adding documents in languages + // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` -// Validate inspects the fields of the type to determine if they are valid. -func (s *ClearQuerySuggestionsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ClearQuerySuggestionsInput"} - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) - } + // The name of the data source. + Name *string `min:"1" type:"string"` - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} + // The status of the data source. When the status is ACTIVE the data source + // is ready to use. + Status *string `type:"string" enum:"DataSourceStatus"` -// SetIndexId sets the IndexId field's value. -func (s *ClearQuerySuggestionsInput) SetIndexId(v string) *ClearQuerySuggestionsInput { - s.IndexId = &v - return s -} + // The type of the data source. + Type *string `type:"string" enum:"DataSourceType"` -type ClearQuerySuggestionsOutput struct { - _ struct{} `type:"structure"` + // The UNIX datetime that the data source was lasted updated. + UpdatedAt *time.Time `type:"timestamp"` } // String returns the string representation. @@ -5394,7 +9778,7 @@ type ClearQuerySuggestionsOutput 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 ClearQuerySuggestionsOutput) String() string { +func (s DataSourceSummary) String() string { return awsutil.Prettify(s) } @@ -5403,102 +9787,87 @@ func (s ClearQuerySuggestionsOutput) 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 ClearQuerySuggestionsOutput) GoString() string { +func (s DataSourceSummary) GoString() string { return s.String() } -// Gathers information about when a particular result was clicked by a user. -// Your application uses the SubmitFeedback operation to provide click information. -type ClickFeedback struct { - _ struct{} `type:"structure"` - - // The Unix timestamp of the date and time that the result was clicked. - // - // ClickTime is a required field - ClickTime *time.Time `type:"timestamp" required:"true"` - - // The unique identifier of the search result that was clicked. - // - // ResultId is a required field - ResultId *string `min:"1" type:"string" required:"true"` +// SetCreatedAt sets the CreatedAt field's value. +func (s *DataSourceSummary) SetCreatedAt(v time.Time) *DataSourceSummary { + s.CreatedAt = &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 ClickFeedback) String() string { - return awsutil.Prettify(s) +// SetId sets the Id field's value. +func (s *DataSourceSummary) SetId(v string) *DataSourceSummary { + s.Id = &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 ClickFeedback) GoString() string { - return s.String() +// SetLanguageCode sets the LanguageCode field's value. +func (s *DataSourceSummary) SetLanguageCode(v string) *DataSourceSummary { + s.LanguageCode = &v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ClickFeedback) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ClickFeedback"} - if s.ClickTime == nil { - invalidParams.Add(request.NewErrParamRequired("ClickTime")) - } - if s.ResultId == nil { - invalidParams.Add(request.NewErrParamRequired("ResultId")) - } - if s.ResultId != nil && len(*s.ResultId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResultId", 1)) - } +// SetName sets the Name field's value. +func (s *DataSourceSummary) SetName(v string) *DataSourceSummary { + s.Name = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetStatus sets the Status field's value. +func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary { + s.Status = &v + return s } -// SetClickTime sets the ClickTime field's value. -func (s *ClickFeedback) SetClickTime(v time.Time) *ClickFeedback { - s.ClickTime = &v +// SetType sets the Type field's value. +func (s *DataSourceSummary) SetType(v string) *DataSourceSummary { + s.Type = &v return s } -// SetResultId sets the ResultId field's value. -func (s *ClickFeedback) SetResultId(v string) *ClickFeedback { - s.ResultId = &v +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary { + s.UpdatedAt = &v return s } -// Provides information about how Amazon Kendra should use the columns of a -// database in an index. -type ColumnConfiguration struct { +// Provides information about a synchronization job. +type DataSourceSyncJob struct { _ struct{} `type:"structure"` - // One to five columns that indicate when a document in the database has changed. - // - // ChangeDetectingColumns is a required field - ChangeDetectingColumns []*string `min:"1" type:"list" required:"true"` + // If the reason that the synchronization failed is due to an error with the + // underlying data source, this field contains a code that identifies the error. + DataSourceErrorCode *string `min:"1" type:"string"` - // The column that contains the contents of the document. - // - // DocumentDataColumnName is a required field - DocumentDataColumnName *string `min:"1" type:"string" required:"true"` + // The UNIX datetime that the synchronization job was completed. + EndTime *time.Time `type:"timestamp"` - // The column that provides the document's unique identifier. - // - // DocumentIdColumnName is a required field - DocumentIdColumnName *string `min:"1" type:"string" required:"true"` + // If the Status field is set to FAILED, the ErrorCode field contains a the + // reason that the synchronization failed. + ErrorCode *string `type:"string" enum:"ErrorCode"` - // The column that contains the title of the document. - DocumentTitleColumnName *string `min:"1" type:"string"` + // If the Status field is set to ERROR, the ErrorMessage field contains a description + // of the error that caused the synchronization to fail. + ErrorMessage *string `min:"1" type:"string"` - // An array of objects that map database column names to the corresponding fields - // in an index. You must first create the fields in the index using the UpdateIndex - // operation. - FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"` + // A unique identifier for the synchronization job. + ExecutionId *string `min:"1" type:"string"` + + // Maps a batch delete document request to a specific data source sync job. + // This is optional and should only be supplied when documents are deleted by + // a data source connector. + Metrics *DataSourceSyncJobMetrics `type:"structure"` + + // The UNIX datetime that the synchronization job was started. + StartTime *time.Time `type:"timestamp"` + + // The execution status of the synchronization job. When the Status field is + // set to SUCCEEDED, the synchronization job is done. If the status code is + // set to FAILED, the ErrorCode and ErrorMessage fields give you the reason + // for the failure. + Status *string `type:"string" enum:"DataSourceSyncJobStatus"` } // String returns the string representation. @@ -5506,7 +9875,7 @@ type ColumnConfiguration 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 ColumnConfiguration) String() string { +func (s DataSourceSyncJob) String() string { return awsutil.Prettify(s) } @@ -5515,89 +9884,77 @@ func (s ColumnConfiguration) 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 ColumnConfiguration) GoString() string { +func (s DataSourceSyncJob) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ColumnConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ColumnConfiguration"} - if s.ChangeDetectingColumns == nil { - invalidParams.Add(request.NewErrParamRequired("ChangeDetectingColumns")) - } - if s.ChangeDetectingColumns != nil && len(s.ChangeDetectingColumns) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ChangeDetectingColumns", 1)) - } - if s.DocumentDataColumnName == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentDataColumnName")) - } - if s.DocumentDataColumnName != nil && len(*s.DocumentDataColumnName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentDataColumnName", 1)) - } - if s.DocumentIdColumnName == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentIdColumnName")) - } - if s.DocumentIdColumnName != nil && len(*s.DocumentIdColumnName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentIdColumnName", 1)) - } - if s.DocumentTitleColumnName != nil && len(*s.DocumentTitleColumnName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentTitleColumnName", 1)) - } - if s.FieldMappings != nil && len(s.FieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("FieldMappings", 1)) - } - if s.FieldMappings != nil { - for i, v := range s.FieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FieldMappings", i), err.(request.ErrInvalidParams)) - } - } - } +// SetDataSourceErrorCode sets the DataSourceErrorCode field's value. +func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob { + s.DataSourceErrorCode = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetEndTime sets the EndTime field's value. +func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob { + s.EndTime = &v + return s } -// SetChangeDetectingColumns sets the ChangeDetectingColumns field's value. -func (s *ColumnConfiguration) SetChangeDetectingColumns(v []*string) *ColumnConfiguration { - s.ChangeDetectingColumns = v +// SetErrorCode sets the ErrorCode field's value. +func (s *DataSourceSyncJob) SetErrorCode(v string) *DataSourceSyncJob { + s.ErrorCode = &v return s } -// SetDocumentDataColumnName sets the DocumentDataColumnName field's value. -func (s *ColumnConfiguration) SetDocumentDataColumnName(v string) *ColumnConfiguration { - s.DocumentDataColumnName = &v +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DataSourceSyncJob) SetErrorMessage(v string) *DataSourceSyncJob { + s.ErrorMessage = &v return s } -// SetDocumentIdColumnName sets the DocumentIdColumnName field's value. -func (s *ColumnConfiguration) SetDocumentIdColumnName(v string) *ColumnConfiguration { - s.DocumentIdColumnName = &v +// SetExecutionId sets the ExecutionId field's value. +func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob { + s.ExecutionId = &v return s } -// SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value. -func (s *ColumnConfiguration) SetDocumentTitleColumnName(v string) *ColumnConfiguration { - s.DocumentTitleColumnName = &v +// SetMetrics sets the Metrics field's value. +func (s *DataSourceSyncJob) SetMetrics(v *DataSourceSyncJobMetrics) *DataSourceSyncJob { + s.Metrics = v return s } -// SetFieldMappings sets the FieldMappings field's value. -func (s *ColumnConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ColumnConfiguration { - s.FieldMappings = v +// SetStartTime sets the StartTime field's value. +func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob { + s.StartTime = &v return s } -type ConflictException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetStatus sets the Status field's value. +func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob { + s.Status = &v + return s +} - Message_ *string `locationName:"Message" min:"1" type:"string"` +// Maps a particular data source sync job to a particular data source. +type DataSourceSyncJobMetricTarget struct { + _ struct{} `type:"structure"` + + // The ID of the data source that is running the sync job. + // + // DataSourceId is a required field + DataSourceId *string `min:"1" type:"string" required:"true"` + + // The ID of the sync job that is running on the data source. + // + // If the ID of a sync job is not provided and there is a sync job running, + // then the ID of this sync job is used and metrics are generated for this sync + // job. + // + // If the ID of a sync job is not provided and there is no sync job running, + // then no metrics are generated and documents are indexed/deleted at the index + // level without sync job metrics included. + DataSourceSyncJobId *string `min:"1" type:"string"` } // String returns the string representation. @@ -5605,7 +9962,7 @@ type ConflictException 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 ConflictException) String() string { +func (s DataSourceSyncJobMetricTarget) String() string { return awsutil.Prettify(s) } @@ -5614,65 +9971,66 @@ func (s ConflictException) 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 ConflictException) GoString() string { +func (s DataSourceSyncJobMetricTarget) GoString() string { return s.String() } -func newErrorConflictException(v protocol.ResponseMetadata) error { - return &ConflictException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataSourceSyncJobMetricTarget) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceSyncJobMetricTarget"} + if s.DataSourceId == nil { + invalidParams.Add(request.NewErrParamRequired("DataSourceId")) } -} - -// 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_ + if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) + } + if s.DataSourceSyncJobId != nil && len(*s.DataSourceSyncJobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceSyncJobId", 1)) } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ConflictException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } 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 +// SetDataSourceId sets the DataSourceId field's value. +func (s *DataSourceSyncJobMetricTarget) SetDataSourceId(v string) *DataSourceSyncJobMetricTarget { + s.DataSourceId = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ConflictException) RequestID() string { - return s.RespMetadata.RequestID +// SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value. +func (s *DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId(v string) *DataSourceSyncJobMetricTarget { + s.DataSourceSyncJobId = &v + return s } -// Specifies the attachment settings for the Confluence data source. Attachment -// settings are optional, if you don't specify settings attachments, Amazon -// Kendra won't index them. -type ConfluenceAttachmentConfiguration struct { +// Maps a batch delete document request to a specific data source sync job. +// This is optional and should only be supplied when documents are deleted by +// a data source connector. +type DataSourceSyncJobMetrics struct { _ struct{} `type:"structure"` - // Defines how attachment metadata fields should be mapped to index fields. - // Before you can map a field, you must first create an index field with a matching - // type using the console or the UpdateIndex operation. - // - // If you specify the AttachentFieldMappings parameter, you must specify at - // least one field mapping. - AttachmentFieldMappings []*ConfluenceAttachmentToIndexFieldMapping `min:"1" type:"list"` + // The number of documents added from the data source up to now in the data + // source sync. + DocumentsAdded *string `type:"string"` - // Indicates whether Amazon Kendra indexes attachments to the pages and blogs - // in the Confluence data source. - CrawlAttachments *bool `type:"boolean"` + // The number of documents deleted from the data source up to now in the data + // source sync run. + DocumentsDeleted *string `type:"string"` + + // The number of documents that failed to sync from the data source up to now + // in the data source sync run. + DocumentsFailed *string `type:"string"` + + // The number of documents modified in the data source up to now in the data + // source sync run. + DocumentsModified *string `type:"string"` + + // The current number of documents crawled by the current sync job in the data + // source. + DocumentsScanned *string `type:"string"` } // String returns the string representation. @@ -5680,7 +10038,7 @@ type ConfluenceAttachmentConfiguration 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 ConfluenceAttachmentConfiguration) String() string { +func (s DataSourceSyncJobMetrics) String() string { return awsutil.Prettify(s) } @@ -5689,65 +10047,57 @@ func (s ConfluenceAttachmentConfiguration) 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 ConfluenceAttachmentConfiguration) GoString() string { +func (s DataSourceSyncJobMetrics) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceAttachmentConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceAttachmentConfiguration"} - if s.AttachmentFieldMappings != nil && len(s.AttachmentFieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("AttachmentFieldMappings", 1)) - } - if s.AttachmentFieldMappings != nil { - for i, v := range s.AttachmentFieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AttachmentFieldMappings", i), err.(request.ErrInvalidParams)) - } - } - } +// SetDocumentsAdded sets the DocumentsAdded field's value. +func (s *DataSourceSyncJobMetrics) SetDocumentsAdded(v string) *DataSourceSyncJobMetrics { + s.DocumentsAdded = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDocumentsDeleted sets the DocumentsDeleted field's value. +func (s *DataSourceSyncJobMetrics) SetDocumentsDeleted(v string) *DataSourceSyncJobMetrics { + s.DocumentsDeleted = &v + return s } -// SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value. -func (s *ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings(v []*ConfluenceAttachmentToIndexFieldMapping) *ConfluenceAttachmentConfiguration { - s.AttachmentFieldMappings = v +// SetDocumentsFailed sets the DocumentsFailed field's value. +func (s *DataSourceSyncJobMetrics) SetDocumentsFailed(v string) *DataSourceSyncJobMetrics { + s.DocumentsFailed = &v return s } -// SetCrawlAttachments sets the CrawlAttachments field's value. -func (s *ConfluenceAttachmentConfiguration) SetCrawlAttachments(v bool) *ConfluenceAttachmentConfiguration { - s.CrawlAttachments = &v +// SetDocumentsModified sets the DocumentsModified field's value. +func (s *DataSourceSyncJobMetrics) SetDocumentsModified(v string) *DataSourceSyncJobMetrics { + s.DocumentsModified = &v return s } -// Defines the mapping between a field in the Confluence data source to a Amazon -// Kendra index field. -// -// You must first create the index field using the UpdateIndex operation. -type ConfluenceAttachmentToIndexFieldMapping struct { +// SetDocumentsScanned sets the DocumentsScanned field's value. +func (s *DataSourceSyncJobMetrics) SetDocumentsScanned(v string) *DataSourceSyncJobMetrics { + s.DocumentsScanned = &v + return s +} + +// Maps a column or attribute in the data source to an index field. You must +// first create the fields in the index using the UpdateIndex operation. +type DataSourceToIndexFieldMapping struct { _ struct{} `type:"structure"` - // The name of the field in the data source. + // The name of the column or attribute in the data source. // - // You must first create the index field using the UpdateIndex operation. - DataSourceFieldName *string `type:"string" enum:"ConfluenceAttachmentFieldName"` + // DataSourceFieldName is a required field + DataSourceFieldName *string `min:"1" type:"string" required:"true"` - // The format for date fields in the data source. If the field specified in - // DataSourceFieldName is a date field you must specify the date format. If - // the field is not a date field, an exception is thrown. + // The type of data stored in the column or attribute. DateFieldFormat *string `min:"4" type:"string"` - // The name of the index field to map to the Confluence data source field. The - // index field type must match the Confluence field type. - IndexFieldName *string `min:"1" type:"string"` + // The name of the field in the index. + // + // IndexFieldName is a required field + IndexFieldName *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -5755,7 +10105,7 @@ type ConfluenceAttachmentToIndexFieldMapping 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 ConfluenceAttachmentToIndexFieldMapping) String() string { +func (s DataSourceToIndexFieldMapping) String() string { return awsutil.Prettify(s) } @@ -5764,16 +10114,25 @@ func (s ConfluenceAttachmentToIndexFieldMapping) 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 ConfluenceAttachmentToIndexFieldMapping) GoString() string { +func (s DataSourceToIndexFieldMapping) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceAttachmentToIndexFieldMapping"} +func (s *DataSourceToIndexFieldMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceToIndexFieldMapping"} + if s.DataSourceFieldName == nil { + invalidParams.Add(request.NewErrParamRequired("DataSourceFieldName")) + } + if s.DataSourceFieldName != nil && len(*s.DataSourceFieldName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceFieldName", 1)) + } if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) } + if s.IndexFieldName == nil { + invalidParams.Add(request.NewErrParamRequired("IndexFieldName")) + } if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) } @@ -5785,36 +10144,39 @@ func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error { } // SetDataSourceFieldName sets the DataSourceFieldName field's value. -func (s *ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping { +func (s *DataSourceToIndexFieldMapping) SetDataSourceFieldName(v string) *DataSourceToIndexFieldMapping { s.DataSourceFieldName = &v return s } // SetDateFieldFormat sets the DateFieldFormat field's value. -func (s *ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceAttachmentToIndexFieldMapping { +func (s *DataSourceToIndexFieldMapping) SetDateFieldFormat(v string) *DataSourceToIndexFieldMapping { s.DateFieldFormat = &v return s } // SetIndexFieldName sets the IndexFieldName field's value. -func (s *ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping { +func (s *DataSourceToIndexFieldMapping) SetIndexFieldName(v string) *DataSourceToIndexFieldMapping { s.IndexFieldName = &v return s } -// Specifies the blog settings for the Confluence data source. Blogs are always -// indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns -// fields in the ConfluenceConfiguration type. -type ConfluenceBlogConfiguration struct { +// Provides information for connecting to an Amazon VPC. +type DataSourceVpcConfiguration struct { _ struct{} `type:"structure"` - // Defines how blog metadata fields should be mapped to index fields. Before - // you can map a field, you must first create an index field with a matching - // type using the console or the UpdateIndex operation. + // A list of identifiers of security groups within your Amazon VPC. The security + // groups should enable Amazon Kendra to connect to the data source. // - // If you specify the BlogFieldMappings parameter, you must specify at least - // one field mapping. - BlogFieldMappings []*ConfluenceBlogToIndexFieldMapping `min:"1" type:"list"` + // SecurityGroupIds is a required field + SecurityGroupIds []*string `min:"1" type:"list" required:"true"` + + // A list of identifiers for subnets within your Amazon VPC. The subnets should + // be able to connect to each other in the VPC, and they should have outgoing + // access to the Internet through a NAT device. + // + // SubnetIds is a required field + SubnetIds []*string `min:"1" type:"list" required:"true"` } // String returns the string representation. @@ -5822,7 +10184,7 @@ type ConfluenceBlogConfiguration 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 ConfluenceBlogConfiguration) String() string { +func (s DataSourceVpcConfiguration) String() string { return awsutil.Prettify(s) } @@ -5831,85 +10193,24 @@ func (s ConfluenceBlogConfiguration) 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 ConfluenceBlogConfiguration) GoString() string { +func (s DataSourceVpcConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceBlogConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceBlogConfiguration"} - if s.BlogFieldMappings != nil && len(s.BlogFieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BlogFieldMappings", 1)) - } - if s.BlogFieldMappings != nil { - for i, v := range s.BlogFieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "BlogFieldMappings", i), err.(request.ErrInvalidParams)) - } - } +func (s *DataSourceVpcConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceVpcConfiguration"} + if s.SecurityGroupIds == nil { + invalidParams.Add(request.NewErrParamRequired("SecurityGroupIds")) } - - if invalidParams.Len() > 0 { - return invalidParams + if s.SecurityGroupIds != nil && len(s.SecurityGroupIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecurityGroupIds", 1)) } - return nil -} - -// SetBlogFieldMappings sets the BlogFieldMappings field's value. -func (s *ConfluenceBlogConfiguration) SetBlogFieldMappings(v []*ConfluenceBlogToIndexFieldMapping) *ConfluenceBlogConfiguration { - s.BlogFieldMappings = v - return s -} - -// Defines the mapping between a blog field in the Confluence data source to -// a Amazon Kendra index field. -// -// You must first create the index field using the UpdateIndex operation. -type ConfluenceBlogToIndexFieldMapping struct { - _ struct{} `type:"structure"` - - // The name of the field in the data source. - DataSourceFieldName *string `type:"string" enum:"ConfluenceBlogFieldName"` - - // The format for date fields in the data source. If the field specified in - // DataSourceFieldName is a date field you must specify the date format. If - // the field is not a date field, an exception is thrown. - DateFieldFormat *string `min:"4" type:"string"` - - // The name of the index field to map to the Confluence data source field. The - // index field type must match the Confluence field type. - IndexFieldName *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 ConfluenceBlogToIndexFieldMapping) 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 ConfluenceBlogToIndexFieldMapping) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceBlogToIndexFieldMapping) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceBlogToIndexFieldMapping"} - if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { - invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) + if s.SubnetIds == nil { + invalidParams.Add(request.NewErrParamRequired("SubnetIds")) } - if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + if s.SubnetIds != nil && len(s.SubnetIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SubnetIds", 1)) } if invalidParams.Len() > 0 { @@ -5918,84 +10219,47 @@ func (s *ConfluenceBlogToIndexFieldMapping) Validate() error { return nil } -// SetDataSourceFieldName sets the DataSourceFieldName field's value. -func (s *ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceBlogToIndexFieldMapping { - s.DataSourceFieldName = &v - return s -} - -// SetDateFieldFormat sets the DateFieldFormat field's value. -func (s *ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceBlogToIndexFieldMapping { - s.DateFieldFormat = &v +// SetSecurityGroupIds sets the SecurityGroupIds field's value. +func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration { + s.SecurityGroupIds = v return s } -// SetIndexFieldName sets the IndexFieldName field's value. -func (s *ConfluenceBlogToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceBlogToIndexFieldMapping { - s.IndexFieldName = &v +// SetSubnetIds sets the SubnetIds field's value. +func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration { + s.SubnetIds = v return s } -// Provides configuration information for data sources that connect to Confluence. -type ConfluenceConfiguration struct { +// Provides the information necessary to connect a database to an index. +type DatabaseConfiguration struct { _ struct{} `type:"structure"` - // Specifies configuration information for indexing attachments to Confluence - // blogs and pages. - AttachmentConfiguration *ConfluenceAttachmentConfiguration `type:"structure"` - - // Specifies configuration information for indexing Confluence blogs. - BlogConfiguration *ConfluenceBlogConfiguration `type:"structure"` - - // A list of regular expression patterns that apply to a URL on the Confluence - // server. An exclusion pattern can apply to a blog post, a page, a space, or - // an attachment. Items that match the pattern are excluded from the index. - // Items that don't match the pattern are included in the index. If a item matches - // both an exclusion pattern and an inclusion pattern, the item isn't included - // in the index. - ExclusionPatterns []*string `type:"list"` - - // A list of regular expression patterns that apply to a URL on the Confluence - // server. An inclusion pattern can apply to a blog post, a page, a space, or - // an attachment. Items that match the patterns are included in the index. Items - // that don't match the pattern are excluded from the index. If an item matches - // both an inclusion pattern and an exclusion pattern, the item isn't included - // in the index. - InclusionPatterns []*string `type:"list"` - - // Specifies configuration information for indexing Confluence pages. - PageConfiguration *ConfluencePageConfiguration `type:"structure"` + // Information about the database column that provides information for user + // context filtering. + AclConfiguration *AclConfiguration `type:"structure"` - // The Amazon Resource Name (ARN) of an Secrets Managersecret that contains - // the key/value pairs required to connect to your Confluence server. The secret - // must contain a JSON structure with the following keys: - // - // * username - The user name or email address of a user with administrative - // privileges for the Confluence server. - // - // * password - The password associated with the user logging in to the Confluence - // server. + // Information about where the index should get the document information from + // the database. // - // SecretArn is a required field - SecretArn *string `min:"1" type:"string" required:"true"` + // ColumnConfiguration is a required field + ColumnConfiguration *ColumnConfiguration `type:"structure" required:"true"` - // The URL of your Confluence instance. Use the full URL of the server. For - // example, https://server.example.com:port/. You can also use an IP address, - // for example, https://192.168.1.113/. + // The information necessary to connect to a database. // - // ServerUrl is a required field - ServerUrl *string `min:"1" type:"string" required:"true"` - - // Specifies configuration information for indexing Confluence spaces. - SpaceConfiguration *ConfluenceSpaceConfiguration `type:"structure"` + // ConnectionConfiguration is a required field + ConnectionConfiguration *ConnectionConfiguration `type:"structure" required:"true"` - // Specifies the version of the Confluence installation that you are connecting - // to. + // The type of database engine that runs the database. // - // Version is a required field - Version *string `type:"string" required:"true" enum:"ConfluenceVersion"` + // DatabaseEngineType is a required field + DatabaseEngineType *string `type:"string" required:"true" enum:"DatabaseEngineType"` - // Specifies the information for connecting to an Amazon VPC. + // Provides information about how Amazon Kendra uses quote marks around SQL + // identifiers when querying a database data source. + SqlConfiguration *SqlConfiguration `type:"structure"` + + // Provides information for connecting to an Amazon VPC. VpcConfiguration *DataSourceVpcConfiguration `type:"structure"` } @@ -6004,7 +10268,7 @@ type ConfluenceConfiguration 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 ConfluenceConfiguration) String() string { +func (s DatabaseConfiguration) String() string { return awsutil.Prettify(s) } @@ -6013,46 +10277,35 @@ func (s ConfluenceConfiguration) 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 ConfluenceConfiguration) GoString() string { +func (s DatabaseConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceConfiguration"} - if s.SecretArn == nil { - invalidParams.Add(request.NewErrParamRequired("SecretArn")) - } - if s.SecretArn != nil && len(*s.SecretArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) - } - if s.ServerUrl == nil { - invalidParams.Add(request.NewErrParamRequired("ServerUrl")) - } - if s.ServerUrl != nil && len(*s.ServerUrl) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ServerUrl", 1)) +func (s *DatabaseConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatabaseConfiguration"} + if s.ColumnConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ColumnConfiguration")) } - if s.Version == nil { - invalidParams.Add(request.NewErrParamRequired("Version")) + if s.ConnectionConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionConfiguration")) } - if s.AttachmentConfiguration != nil { - if err := s.AttachmentConfiguration.Validate(); err != nil { - invalidParams.AddNested("AttachmentConfiguration", err.(request.ErrInvalidParams)) - } + if s.DatabaseEngineType == nil { + invalidParams.Add(request.NewErrParamRequired("DatabaseEngineType")) } - if s.BlogConfiguration != nil { - if err := s.BlogConfiguration.Validate(); err != nil { - invalidParams.AddNested("BlogConfiguration", err.(request.ErrInvalidParams)) + if s.AclConfiguration != nil { + if err := s.AclConfiguration.Validate(); err != nil { + invalidParams.AddNested("AclConfiguration", err.(request.ErrInvalidParams)) } } - if s.PageConfiguration != nil { - if err := s.PageConfiguration.Validate(); err != nil { - invalidParams.AddNested("PageConfiguration", err.(request.ErrInvalidParams)) + if s.ColumnConfiguration != nil { + if err := s.ColumnConfiguration.Validate(); err != nil { + invalidParams.AddNested("ColumnConfiguration", err.(request.ErrInvalidParams)) } } - if s.SpaceConfiguration != nil { - if err := s.SpaceConfiguration.Validate(); err != nil { - invalidParams.AddNested("SpaceConfiguration", err.(request.ErrInvalidParams)) + if s.ConnectionConfiguration != nil { + if err := s.ConnectionConfiguration.Validate(); err != nil { + invalidParams.AddNested("ConnectionConfiguration", err.(request.ErrInvalidParams)) } } if s.VpcConfiguration != nil { @@ -6067,77 +10320,54 @@ func (s *ConfluenceConfiguration) Validate() error { return nil } -// SetAttachmentConfiguration sets the AttachmentConfiguration field's value. -func (s *ConfluenceConfiguration) SetAttachmentConfiguration(v *ConfluenceAttachmentConfiguration) *ConfluenceConfiguration { - s.AttachmentConfiguration = v - return s -} - -// SetBlogConfiguration sets the BlogConfiguration field's value. -func (s *ConfluenceConfiguration) SetBlogConfiguration(v *ConfluenceBlogConfiguration) *ConfluenceConfiguration { - s.BlogConfiguration = v - return s -} - -// SetExclusionPatterns sets the ExclusionPatterns field's value. -func (s *ConfluenceConfiguration) SetExclusionPatterns(v []*string) *ConfluenceConfiguration { - s.ExclusionPatterns = v - return s -} - -// SetInclusionPatterns sets the InclusionPatterns field's value. -func (s *ConfluenceConfiguration) SetInclusionPatterns(v []*string) *ConfluenceConfiguration { - s.InclusionPatterns = v - return s -} - -// SetPageConfiguration sets the PageConfiguration field's value. -func (s *ConfluenceConfiguration) SetPageConfiguration(v *ConfluencePageConfiguration) *ConfluenceConfiguration { - s.PageConfiguration = v +// SetAclConfiguration sets the AclConfiguration field's value. +func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration { + s.AclConfiguration = v return s } -// SetSecretArn sets the SecretArn field's value. -func (s *ConfluenceConfiguration) SetSecretArn(v string) *ConfluenceConfiguration { - s.SecretArn = &v +// SetColumnConfiguration sets the ColumnConfiguration field's value. +func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration { + s.ColumnConfiguration = v return s } -// SetServerUrl sets the ServerUrl field's value. -func (s *ConfluenceConfiguration) SetServerUrl(v string) *ConfluenceConfiguration { - s.ServerUrl = &v +// SetConnectionConfiguration sets the ConnectionConfiguration field's value. +func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration { + s.ConnectionConfiguration = v return s } -// SetSpaceConfiguration sets the SpaceConfiguration field's value. -func (s *ConfluenceConfiguration) SetSpaceConfiguration(v *ConfluenceSpaceConfiguration) *ConfluenceConfiguration { - s.SpaceConfiguration = v +// SetDatabaseEngineType sets the DatabaseEngineType field's value. +func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration { + s.DatabaseEngineType = &v return s } -// SetVersion sets the Version field's value. -func (s *ConfluenceConfiguration) SetVersion(v string) *ConfluenceConfiguration { - s.Version = &v +// SetSqlConfiguration sets the SqlConfiguration field's value. +func (s *DatabaseConfiguration) SetSqlConfiguration(v *SqlConfiguration) *DatabaseConfiguration { + s.SqlConfiguration = v return s } // SetVpcConfiguration sets the VpcConfiguration field's value. -func (s *ConfluenceConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *ConfluenceConfiguration { +func (s *DatabaseConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DatabaseConfiguration { s.VpcConfiguration = v return s } -// Specifies the page settings for the Confluence data source. -type ConfluencePageConfiguration struct { +type DeleteDataSourceInput struct { _ struct{} `type:"structure"` - // Defines how page metadata fields should be mapped to index fields. Before - // you can map a field, you must first create an index field with a matching - // type using the console or the UpdateIndex operation. + // The unique identifier of the data source to delete. // - // If you specify the PageFieldMappings parameter, you must specify at least - // one field mapping. - PageFieldMappings []*ConfluencePageToIndexFieldMapping `min:"1" type:"list"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The unique identifier of the index associated with the data source. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -6145,7 +10375,7 @@ type ConfluencePageConfiguration 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 ConfluencePageConfiguration) String() string { +func (s DeleteDataSourceInput) String() string { return awsutil.Prettify(s) } @@ -6154,25 +10384,24 @@ func (s ConfluencePageConfiguration) 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 ConfluencePageConfiguration) GoString() string { +func (s DeleteDataSourceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluencePageConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluencePageConfiguration"} - if s.PageFieldMappings != nil && len(s.PageFieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PageFieldMappings", 1)) +func (s *DeleteDataSourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDataSourceInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.PageFieldMappings != nil { - for i, v := range s.PageFieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PageFieldMappings", i), err.(request.ErrInvalidParams)) - } - } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -6181,30 +10410,53 @@ func (s *ConfluencePageConfiguration) Validate() error { return nil } -// SetPageFieldMappings sets the PageFieldMappings field's value. -func (s *ConfluencePageConfiguration) SetPageFieldMappings(v []*ConfluencePageToIndexFieldMapping) *ConfluencePageConfiguration { - s.PageFieldMappings = v +// SetId sets the Id field's value. +func (s *DeleteDataSourceInput) SetId(v string) *DeleteDataSourceInput { + s.Id = &v return s } -// Defines the mapping between a field in the Confluence data source to a Amazon -// Kendra index field. -// -// You must first create the index field using the UpdateIndex operation. -type ConfluencePageToIndexFieldMapping struct { +// SetIndexId sets the IndexId field's value. +func (s *DeleteDataSourceInput) SetIndexId(v string) *DeleteDataSourceInput { + s.IndexId = &v + return s +} + +type DeleteDataSourceOutput struct { _ struct{} `type:"structure"` +} - // The name of the field in the data source. - DataSourceFieldName *string `type:"string" enum:"ConfluencePageFieldName"` +// 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 DeleteDataSourceOutput) String() string { + return awsutil.Prettify(s) +} - // The format for date fields in the data source. If the field specified in - // DataSourceFieldName is a date field you must specify the date format. If - // the field is not a date field, an exception is thrown. - DateFieldFormat *string `min:"4" 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 DeleteDataSourceOutput) GoString() string { + return s.String() +} - // The name of the index field to map to the Confluence data source field. The - // index field type must match the Confluence field type. - IndexFieldName *string `min:"1" type:"string"` +type DeleteExperienceInput struct { + _ struct{} `type:"structure"` + + // The identifier of your Amazon Kendra experience you want to delete. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index for your Amazon Kendra experience you want to + // delete. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -6212,7 +10464,7 @@ type ConfluencePageToIndexFieldMapping 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 ConfluencePageToIndexFieldMapping) String() string { +func (s DeleteExperienceInput) String() string { return awsutil.Prettify(s) } @@ -6221,18 +10473,24 @@ func (s ConfluencePageToIndexFieldMapping) 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 ConfluencePageToIndexFieldMapping) GoString() string { +func (s DeleteExperienceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluencePageToIndexFieldMapping) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluencePageToIndexFieldMapping"} - if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { - invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) +func (s *DeleteExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteExperienceInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } - if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -6241,57 +10499,52 @@ func (s *ConfluencePageToIndexFieldMapping) Validate() error { return nil } -// SetDataSourceFieldName sets the DataSourceFieldName field's value. -func (s *ConfluencePageToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluencePageToIndexFieldMapping { - s.DataSourceFieldName = &v - return s -} - -// SetDateFieldFormat sets the DateFieldFormat field's value. -func (s *ConfluencePageToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluencePageToIndexFieldMapping { - s.DateFieldFormat = &v +// SetId sets the Id field's value. +func (s *DeleteExperienceInput) SetId(v string) *DeleteExperienceInput { + s.Id = &v return s } -// SetIndexFieldName sets the IndexFieldName field's value. -func (s *ConfluencePageToIndexFieldMapping) SetIndexFieldName(v string) *ConfluencePageToIndexFieldMapping { - s.IndexFieldName = &v +// SetIndexId sets the IndexId field's value. +func (s *DeleteExperienceInput) SetIndexId(v string) *DeleteExperienceInput { + s.IndexId = &v return s } -// Specifies the configuration for indexing Confluence spaces. -type ConfluenceSpaceConfiguration struct { +type DeleteExperienceOutput struct { _ struct{} `type:"structure"` +} - // Specifies whether Amazon Kendra should index archived spaces. - CrawlArchivedSpaces *bool `type:"boolean"` +// 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 DeleteExperienceOutput) String() string { + return awsutil.Prettify(s) +} - // Specifies whether Amazon Kendra should index personal spaces. Users can add - // restrictions to items in personal spaces. If personal spaces are indexed, - // queries without user context information may return restricted items from - // a personal space in their results. For more information, see Filtering on - // user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). - CrawlPersonalSpaces *bool `type:"boolean"` +// 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 DeleteExperienceOutput) GoString() string { + return s.String() +} - // A list of space keys of Confluence spaces. If you include a key, the blogs, - // documents, and attachments in the space are not indexed. If a space is in - // both the ExcludeSpaces and the IncludeSpaces list, the space is excluded. - ExcludeSpaces []*string `min:"1" type:"list"` +type DeleteFaqInput struct { + _ struct{} `type:"structure"` - // A list of space keys for Confluence spaces. If you include a key, the blogs, - // documents, and attachments in the space are indexed. Spaces that aren't in - // the list aren't indexed. A space in the list must exist. Otherwise, Amazon - // Kendra logs an error when the data source is synchronized. If a space is - // in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded. - IncludeSpaces []*string `min:"1" type:"list"` + // The identifier of the FAQ to remove. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // Defines how space metadata fields should be mapped to index fields. Before - // you can map a field, you must first create an index field with a matching - // type using the console or the UpdateIndex operation. + // The index to remove the FAQ from. // - // If you specify the SpaceFieldMappings parameter, you must specify at least - // one field mapping. - SpaceFieldMappings []*ConfluenceSpaceToIndexFieldMapping `min:"1" type:"list"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -6299,7 +10552,7 @@ type ConfluenceSpaceConfiguration 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 ConfluenceSpaceConfiguration) String() string { +func (s DeleteFaqInput) String() string { return awsutil.Prettify(s) } @@ -6308,31 +10561,24 @@ func (s ConfluenceSpaceConfiguration) 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 ConfluenceSpaceConfiguration) GoString() string { +func (s DeleteFaqInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceSpaceConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceSpaceConfiguration"} - if s.ExcludeSpaces != nil && len(s.ExcludeSpaces) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ExcludeSpaces", 1)) +func (s *DeleteFaqInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFaqInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.IncludeSpaces != nil && len(s.IncludeSpaces) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IncludeSpaces", 1)) + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } - if s.SpaceFieldMappings != nil && len(s.SpaceFieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SpaceFieldMappings", 1)) + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.SpaceFieldMappings != nil { - for i, v := range s.SpaceFieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SpaceFieldMappings", i), err.(request.ErrInvalidParams)) - } - } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -6341,54 +10587,47 @@ func (s *ConfluenceSpaceConfiguration) Validate() error { return nil } -// SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value. -func (s *ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces(v bool) *ConfluenceSpaceConfiguration { - s.CrawlArchivedSpaces = &v +// SetId sets the Id field's value. +func (s *DeleteFaqInput) SetId(v string) *DeleteFaqInput { + s.Id = &v return s } -// SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value. -func (s *ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces(v bool) *ConfluenceSpaceConfiguration { - s.CrawlPersonalSpaces = &v +// SetIndexId sets the IndexId field's value. +func (s *DeleteFaqInput) SetIndexId(v string) *DeleteFaqInput { + s.IndexId = &v return s } -// SetExcludeSpaces sets the ExcludeSpaces field's value. -func (s *ConfluenceSpaceConfiguration) SetExcludeSpaces(v []*string) *ConfluenceSpaceConfiguration { - s.ExcludeSpaces = v - return s +type DeleteFaqOutput struct { + _ struct{} `type:"structure"` } -// SetIncludeSpaces sets the IncludeSpaces field's value. -func (s *ConfluenceSpaceConfiguration) SetIncludeSpaces(v []*string) *ConfluenceSpaceConfiguration { - s.IncludeSpaces = 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 DeleteFaqOutput) String() string { + return awsutil.Prettify(s) } -// SetSpaceFieldMappings sets the SpaceFieldMappings field's value. -func (s *ConfluenceSpaceConfiguration) SetSpaceFieldMappings(v []*ConfluenceSpaceToIndexFieldMapping) *ConfluenceSpaceConfiguration { - s.SpaceFieldMappings = 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 DeleteFaqOutput) GoString() string { + return s.String() } -// Defines the mapping between a field in the Confluence data source to a Amazon -// Kendra index field. -// -// You must first create the index field using the UpdateIndex operation. -type ConfluenceSpaceToIndexFieldMapping struct { +type DeleteIndexInput struct { _ struct{} `type:"structure"` - // The name of the field in the data source. - DataSourceFieldName *string `type:"string" enum:"ConfluenceSpaceFieldName"` - - // The format for date fields in the data source. If the field specified in - // DataSourceFieldName is a date field you must specify the date format. If - // the field is not a date field, an exception is thrown. - DateFieldFormat *string `min:"4" type:"string"` - - // The name of the index field to map to the Confluence data source field. The - // index field type must match the Confluence field type. - IndexFieldName *string `min:"1" type:"string"` + // The identifier of the index to delete. + // + // Id is a required field + Id *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -6396,7 +10635,7 @@ type ConfluenceSpaceToIndexFieldMapping 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 ConfluenceSpaceToIndexFieldMapping) String() string { +func (s DeleteIndexInput) String() string { return awsutil.Prettify(s) } @@ -6405,18 +10644,18 @@ func (s ConfluenceSpaceToIndexFieldMapping) 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 ConfluenceSpaceToIndexFieldMapping) GoString() string { +func (s DeleteIndexInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConfluenceSpaceToIndexFieldMapping"} - if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { - invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) +func (s *DeleteIndexInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIndexInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) } if invalidParams.Len() > 0 { @@ -6425,57 +10664,74 @@ func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error { return nil } -// SetDataSourceFieldName sets the DataSourceFieldName field's value. -func (s *ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceSpaceToIndexFieldMapping { - s.DataSourceFieldName = &v +// SetId sets the Id field's value. +func (s *DeleteIndexInput) SetId(v string) *DeleteIndexInput { + s.Id = &v return s } -// SetDateFieldFormat sets the DateFieldFormat field's value. -func (s *ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceSpaceToIndexFieldMapping { - s.DateFieldFormat = &v - return s +type DeleteIndexOutput struct { + _ struct{} `type:"structure"` } -// SetIndexFieldName sets the IndexFieldName field's value. -func (s *ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceSpaceToIndexFieldMapping { - s.IndexFieldName = &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 DeleteIndexOutput) String() string { + return awsutil.Prettify(s) } -// Provides the information necessary to connect to a database. -type ConnectionConfiguration struct { +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteIndexOutput) GoString() string { + return s.String() +} + +type DeletePrincipalMappingInput struct { _ struct{} `type:"structure"` - // The name of the host for the database. Can be either a string (host.subdomain.domain.tld) - // or an IPv4 or IPv6 address. + // The identifier of the data source you want to delete a group from. // - // DatabaseHost is a required field - DatabaseHost *string `min:"1" type:"string" required:"true"` + // This is useful if a group is tied to multiple data sources and you want to + // delete a group from accessing documents in a certain data source. For example, + // the groups "Research", "Engineering", and "Sales and Marketing" are all tied + // to the company's documents stored in the data sources Confluence and Salesforce. + // You want to delete "Research" and "Engineering" groups from Salesforce, so + // that these groups cannot access customer-related documents stored in Salesforce. + // Only "Sales and Marketing" should access documents in the Salesforce data + // source. + DataSourceId *string `min:"1" type:"string"` - // The name of the database containing the document data. + // The identifier of the group you want to delete. // - // DatabaseName is a required field - DatabaseName *string `min:"1" type:"string" required:"true"` + // GroupId is a required field + GroupId *string `min:"1" type:"string" required:"true"` - // The port that the database uses for connections. + // The identifier of the index you want to delete a group from. // - // DatabasePort is a required field - DatabasePort *int64 `min:"1" type:"integer" required:"true"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. - // The credentials should be a user/password pair. For more information, see - // Using a Database Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). - // For more information about Secrets Manager, see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) - // in the Secrets Manager user guide. + // The timestamp identifier you specify to ensure Amazon Kendra does not override + // the latest DELETE action with previous actions. The highest number ID, which + // is the ordering ID, is the latest action you want to process and apply on + // top of other actions with lower number IDs. This prevents previous actions + // with lower number IDs from possibly overriding the latest action. // - // SecretArn is a required field - SecretArn *string `min:"1" type:"string" required:"true"` - - // The name of the table that contains the document data. + // The ordering ID can be the UNIX time of the last update you made to a group + // members list. You would then provide this list when calling PutPrincipalMapping. + // This ensures your DELETE action for that updated group with the latest members + // list doesn't get overwritten by earlier DELETE actions for the same group + // which are yet to be processed. // - // TableName is a required field - TableName *string `min:"1" type:"string" required:"true"` + // The default ordering ID is the current UNIX time in milliseconds that the + // action was received by Amazon Kendra. + OrderingId *int64 `type:"long"` } // String returns the string representation. @@ -6483,7 +10739,7 @@ type ConnectionConfiguration 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 ConnectionConfiguration) String() string { +func (s DeletePrincipalMappingInput) String() string { return awsutil.Prettify(s) } @@ -6492,42 +10748,27 @@ func (s ConnectionConfiguration) 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 ConnectionConfiguration) GoString() string { +func (s DeletePrincipalMappingInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ConnectionConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConnectionConfiguration"} - if s.DatabaseHost == nil { - invalidParams.Add(request.NewErrParamRequired("DatabaseHost")) - } - if s.DatabaseHost != nil && len(*s.DatabaseHost) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatabaseHost", 1)) - } - if s.DatabaseName == nil { - invalidParams.Add(request.NewErrParamRequired("DatabaseName")) - } - if s.DatabaseName != nil && len(*s.DatabaseName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatabaseName", 1)) - } - if s.DatabasePort == nil { - invalidParams.Add(request.NewErrParamRequired("DatabasePort")) - } - if s.DatabasePort != nil && *s.DatabasePort < 1 { - invalidParams.Add(request.NewErrParamMinValue("DatabasePort", 1)) +func (s *DeletePrincipalMappingInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePrincipalMappingInput"} + if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) } - if s.SecretArn == nil { - invalidParams.Add(request.NewErrParamRequired("SecretArn")) + if s.GroupId == nil { + invalidParams.Add(request.NewErrParamRequired("GroupId")) } - if s.SecretArn != nil && len(*s.SecretArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) + if s.GroupId != nil && len(*s.GroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GroupId", 1)) } - if s.TableName == nil { - invalidParams.Add(request.NewErrParamRequired("TableName")) + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.TableName != nil && len(*s.TableName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TableName", 1)) + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -6536,98 +10777,64 @@ func (s *ConnectionConfiguration) Validate() error { return nil } -// SetDatabaseHost sets the DatabaseHost field's value. -func (s *ConnectionConfiguration) SetDatabaseHost(v string) *ConnectionConfiguration { - s.DatabaseHost = &v +// SetDataSourceId sets the DataSourceId field's value. +func (s *DeletePrincipalMappingInput) SetDataSourceId(v string) *DeletePrincipalMappingInput { + s.DataSourceId = &v return s } -// SetDatabaseName sets the DatabaseName field's value. -func (s *ConnectionConfiguration) SetDatabaseName(v string) *ConnectionConfiguration { - s.DatabaseName = &v +// SetGroupId sets the GroupId field's value. +func (s *DeletePrincipalMappingInput) SetGroupId(v string) *DeletePrincipalMappingInput { + s.GroupId = &v return s } -// SetDatabasePort sets the DatabasePort field's value. -func (s *ConnectionConfiguration) SetDatabasePort(v int64) *ConnectionConfiguration { - s.DatabasePort = &v +// SetIndexId sets the IndexId field's value. +func (s *DeletePrincipalMappingInput) SetIndexId(v string) *DeletePrincipalMappingInput { + s.IndexId = &v return s } -// SetSecretArn sets the SecretArn field's value. -func (s *ConnectionConfiguration) SetSecretArn(v string) *ConnectionConfiguration { - s.SecretArn = &v +// SetOrderingId sets the OrderingId field's value. +func (s *DeletePrincipalMappingInput) SetOrderingId(v int64) *DeletePrincipalMappingInput { + s.OrderingId = &v return s } -// SetTableName sets the TableName field's value. -func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguration { - s.TableName = &v - return s +type DeletePrincipalMappingOutput struct { + _ struct{} `type:"structure"` } -type CreateDataSourceInput 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 DeletePrincipalMappingOutput) String() string { + return awsutil.Prettify(s) +} - // A token that you provide to identify the request to create a data source. - // Multiple calls to the CreateDataSource operation with the same client token - // will create only one data source. - ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` +// 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 DeletePrincipalMappingOutput) GoString() string { + return s.String() +} - // The connector configuration information that is required to access the repository. - // - // You can't specify the Configuration parameter when the Type parameter is - // set to CUSTOM. If you do, you receive a ValidationException exception. - // - // The Configuration parameter is required for all other data sources. - Configuration *DataSourceConfiguration `type:"structure"` +type DeleteQuerySuggestionsBlockListInput struct { + _ struct{} `type:"structure"` - // A description for the data source. - Description *string `type:"string"` + // The unique identifier of the block list that needs to be deleted. + // + // Id is a required field + Id *string `min:"36" type:"string" required:"true"` - // The identifier of the index that should be associated with this data source. + // The identifier of the you want to delete a block list from. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` - - // The code for a language. This allows you to support a language for all documents - // when creating the data source. English is supported by default. For more - // information on supported languages, including their codes, see Adding documents - // in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" type:"string"` - - // A unique name for the data source. A data source name can't be changed without - // deleting and recreating the data source. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // The Amazon Resource Name (ARN) of a role with permission to access the data - // source. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - // - // You can't specify the RoleArn parameter when the Type parameter is set to - // CUSTOM. If you do, you receive a ValidationException exception. - // - // The RoleArn parameter is required for all other data sources. - RoleArn *string `min:"1" type:"string"` - - // Sets the frequency that Amazon Kendra will check the documents in your repository - // and update the index. If you don't set a schedule Amazon Kendra will not - // periodically update the index. You can call the StartDataSourceSyncJob operation - // to update the index. - // - // You can't specify the Schedule parameter when the Type parameter is set to - // CUSTOM. If you do, you receive a ValidationException exception. - Schedule *string `type:"string"` - - // A list of key-value pairs that identify the data source. You can use the - // tags to identify and organize your resources and to control access to resources. - Tags []*Tag `type:"list"` - - // The type of repository that contains the data source. - // - // Type is a required field - Type *string `type:"string" required:"true" enum:"DataSourceType"` } // String returns the string representation. @@ -6635,7 +10842,7 @@ type CreateDataSourceInput 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 CreateDataSourceInput) String() string { +func (s DeleteQuerySuggestionsBlockListInput) String() string { return awsutil.Prettify(s) } @@ -6644,15 +10851,18 @@ func (s CreateDataSourceInput) 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 CreateDataSourceInput) GoString() string { +func (s DeleteQuerySuggestionsBlockListInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDataSourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDataSourceInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) +func (s *DeleteQuerySuggestionsBlockListInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteQuerySuggestionsBlockListInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -6660,36 +10870,6 @@ func (s *CreateDataSourceInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.LanguageCode != nil && len(*s.LanguageCode) < 2 { - invalidParams.Add(request.NewErrParamMinLen("LanguageCode", 2)) - } - 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.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.Type == nil { - invalidParams.Add(request.NewErrParamRequired("Type")) - } - if s.Configuration != nil { - if err := s.Configuration.Validate(); err != nil { - invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -6697,73 +10877,20 @@ func (s *CreateDataSourceInput) Validate() error { return nil } -// SetClientToken sets the ClientToken field's value. -func (s *CreateDataSourceInput) SetClientToken(v string) *CreateDataSourceInput { - s.ClientToken = &v - return s -} - -// SetConfiguration sets the Configuration field's value. -func (s *CreateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput { - s.Configuration = v - return s -} - -// SetDescription sets the Description field's value. -func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput { - s.Description = &v - return s -} - -// SetIndexId sets the IndexId field's value. -func (s *CreateDataSourceInput) SetIndexId(v string) *CreateDataSourceInput { - s.IndexId = &v - return s -} - -// SetLanguageCode sets the LanguageCode field's value. -func (s *CreateDataSourceInput) SetLanguageCode(v string) *CreateDataSourceInput { - s.LanguageCode = &v - return s -} - -// SetName sets the Name field's value. -func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput { - s.Name = &v - return s -} - -// SetRoleArn sets the RoleArn field's value. -func (s *CreateDataSourceInput) SetRoleArn(v string) *CreateDataSourceInput { - s.RoleArn = &v - return s -} - -// SetSchedule sets the Schedule field's value. -func (s *CreateDataSourceInput) SetSchedule(v string) *CreateDataSourceInput { - s.Schedule = &v - return s -} - -// SetTags sets the Tags field's value. -func (s *CreateDataSourceInput) SetTags(v []*Tag) *CreateDataSourceInput { - s.Tags = v +// SetId sets the Id field's value. +func (s *DeleteQuerySuggestionsBlockListInput) SetId(v string) *DeleteQuerySuggestionsBlockListInput { + s.Id = &v return s } -// SetType sets the Type field's value. -func (s *CreateDataSourceInput) SetType(v string) *CreateDataSourceInput { - s.Type = &v +// SetIndexId sets the IndexId field's value. +func (s *DeleteQuerySuggestionsBlockListInput) SetIndexId(v string) *DeleteQuerySuggestionsBlockListInput { + s.IndexId = &v return s } -type CreateDataSourceOutput struct { +type DeleteQuerySuggestionsBlockListOutput struct { _ struct{} `type:"structure"` - - // A unique identifier for the data source. - // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -6771,7 +10898,7 @@ type CreateDataSourceOutput 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 CreateDataSourceOutput) String() string { +func (s DeleteQuerySuggestionsBlockListOutput) String() string { return awsutil.Prettify(s) } @@ -6780,68 +10907,22 @@ func (s CreateDataSourceOutput) 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 CreateDataSourceOutput) GoString() string { +func (s DeleteQuerySuggestionsBlockListOutput) GoString() string { return s.String() } -// SetId sets the Id field's value. -func (s *CreateDataSourceOutput) SetId(v string) *CreateDataSourceOutput { - s.Id = &v - return s -} - -type CreateFaqInput struct { +type DeleteThesaurusInput struct { _ struct{} `type:"structure"` - // A token that you provide to identify the request to create a FAQ. Multiple - // calls to the CreateFaqRequest operation with the same client token will create - // only one FAQ. - ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - - // A description of the FAQ. - Description *string `type:"string"` - - // The format of the input file. You can choose between a basic CSV format, - // a CSV format that includes customs attributes in a header, and a JSON format - // that includes custom attributes. - // - // The format must match the format of the file stored in the S3 bucket identified - // in the S3Path parameter. + // The identifier of the thesaurus to delete. // - // For more information, see Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html). - FileFormat *string `type:"string" enum:"FaqFileFormat"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index that contains the FAQ. + // The identifier of the index associated with the thesaurus to delete. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` - - // The code for a language. This allows you to support a language for the FAQ - // document. English is supported by default. For more information on supported - // languages, including their codes, see Adding documents in languages other - // than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" type:"string"` - - // The name that should be associated with the FAQ. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // The Amazon Resource Name (ARN) of a role with permission to access the S3 - // bucket that contains the FAQs. For more information, see IAM Roles for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - // - // RoleArn is a required field - RoleArn *string `min:"1" type:"string" required:"true"` - - // The S3 location of the FAQ input data. - // - // S3Path is a required field - S3Path *S3Path `type:"structure" required:"true"` - - // A list of key-value pairs that identify the FAQ. You can use the tags to - // identify and organize your resources and to control access to resources. - Tags []*Tag `type:"list"` } // String returns the string representation. @@ -6849,7 +10930,7 @@ type CreateFaqInput 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 CreateFaqInput) String() string { +func (s DeleteThesaurusInput) String() string { return awsutil.Prettify(s) } @@ -6858,15 +10939,18 @@ func (s CreateFaqInput) 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 CreateFaqInput) GoString() string { +func (s DeleteThesaurusInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateFaqInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateFaqInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) +func (s *DeleteThesaurusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteThesaurusInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -6874,39 +10958,6 @@ func (s *CreateFaqInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.LanguageCode != nil && len(*s.LanguageCode) < 2 { - invalidParams.Add(request.NewErrParamMinLen("LanguageCode", 2)) - } - 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.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) - } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.S3Path == nil { - invalidParams.Add(request.NewErrParamRequired("S3Path")) - } - if s.S3Path != nil { - if err := s.S3Path.Validate(); err != nil { - invalidParams.AddNested("S3Path", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -6914,65 +10965,52 @@ func (s *CreateFaqInput) Validate() error { return nil } -// SetClientToken sets the ClientToken field's value. -func (s *CreateFaqInput) SetClientToken(v string) *CreateFaqInput { - s.ClientToken = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput { - s.Description = &v - return s -} - -// SetFileFormat sets the FileFormat field's value. -func (s *CreateFaqInput) SetFileFormat(v string) *CreateFaqInput { - s.FileFormat = &v +// SetId sets the Id field's value. +func (s *DeleteThesaurusInput) SetId(v string) *DeleteThesaurusInput { + s.Id = &v return s } // SetIndexId sets the IndexId field's value. -func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput { +func (s *DeleteThesaurusInput) SetIndexId(v string) *DeleteThesaurusInput { s.IndexId = &v return s } -// SetLanguageCode sets the LanguageCode field's value. -func (s *CreateFaqInput) SetLanguageCode(v string) *CreateFaqInput { - s.LanguageCode = &v - return s -} - -// SetName sets the Name field's value. -func (s *CreateFaqInput) SetName(v string) *CreateFaqInput { - s.Name = &v - return s -} - -// SetRoleArn sets the RoleArn field's value. -func (s *CreateFaqInput) SetRoleArn(v string) *CreateFaqInput { - s.RoleArn = &v - return s +type DeleteThesaurusOutput struct { + _ struct{} `type:"structure"` } -// SetS3Path sets the S3Path field's value. -func (s *CreateFaqInput) SetS3Path(v *S3Path) *CreateFaqInput { - s.S3Path = 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 DeleteThesaurusOutput) String() string { + return awsutil.Prettify(s) } -// SetTags sets the Tags field's value. -func (s *CreateFaqInput) SetTags(v []*Tag) *CreateFaqInput { - s.Tags = 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 DeleteThesaurusOutput) GoString() string { + return s.String() } -type CreateFaqOutput struct { +type DescribeDataSourceInput struct { _ struct{} `type:"structure"` - // The unique identifier of the FAQ. - Id *string `min:"1" type:"string"` + // The unique identifier of the data source to describe. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index that contains the data source. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -6980,7 +11018,7 @@ type CreateFaqOutput 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 CreateFaqOutput) String() string { +func (s DescribeDataSourceInput) String() string { return awsutil.Prettify(s) } @@ -6989,83 +11027,102 @@ func (s CreateFaqOutput) 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 CreateFaqOutput) GoString() string { +func (s DescribeDataSourceInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDataSourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDataSourceInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetId sets the Id field's value. -func (s *CreateFaqOutput) SetId(v string) *CreateFaqOutput { +func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput { s.Id = &v return s } -type CreateIndexInput struct { +// SetIndexId sets the IndexId field's value. +func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput { + s.IndexId = &v + return s +} + +type DescribeDataSourceOutput struct { _ struct{} `type:"structure"` - // A token that you provide to identify the request to create an index. Multiple - // calls to the CreateIndex operation with the same client token will create - // only one index. - ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + // Information that describes where the data source is located and how the data + // source is configured. The specific information in the description depends + // on the data source provider. + Configuration *DataSourceConfiguration `type:"structure"` - // A description for the index. - Description *string `type:"string"` + // The Unix timestamp of when the data source was created. + CreatedAt *time.Time `type:"timestamp"` - // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION - // for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION - // for your production databases. Once you set the edition for an index, it - // can't be changed. + // Configuration information for altering document metadata and content during + // the document ingestion process when you describe a data source. // - // The Edition parameter is optional. If you don't supply a value, the default - // is ENTERPRISE_EDITION. - // - // For more information on quota limits for enterprise and developer editions, - // see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). - Edition *string `type:"string" enum:"IndexEdition"` + // For more information on how to create, modify and delete document metadata, + // or make other content alterations when you ingest documents into Amazon Kendra, + // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"` + + // The description of the data source. + Description *string `type:"string"` + + // When the Status field value is FAILED, the ErrorMessage field contains a + // description of the error that caused the data source to fail. + ErrorMessage *string `min:"1" type:"string"` - // The name for the new index. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // The identifier of the data source. + Id *string `min:"1" type:"string"` - // An Identity and Access Management(IAM) role that gives Amazon Kendra permissions - // to access your Amazon CloudWatch logs and metrics. This is also the role - // used when you use the BatchPutDocument operation to index documents from - // an Amazon S3 bucket. - // - // RoleArn is a required field - RoleArn *string `min:"1" type:"string" required:"true"` + // The identifier of the index that contains the data source. + IndexId *string `min:"36" type:"string"` - // The identifier of the KMScustomer managed key (CMK) to use to encrypt data - // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. - ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` + // The code for a language. This shows a supported language for all documents + // in the data source. English is supported by default. For more information + // on supported languages, including their codes, see Adding documents in languages + // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` - // A list of key-value pairs that identify the index. You can use the tags to - // identify and organize your resources and to control access to resources. - Tags []*Tag `type:"list"` + // The name that you gave the data source when it was created. + Name *string `min:"1" type:"string"` - // The user context policy. - // - // ATTRIBUTE_FILTER - // - // All indexed content is searchable and displayable for all users. If you want - // to filter search results on user context, you can use the attribute filters - // of _user_id and _group_ids or you can provide user and group information - // in UserContext. - // - // USER_TOKEN - // - // Enables token-based user access control to filter search results on user - // context. All documents with no access control and all documents accessible - // to the user will be searchable and displayable. - UserContextPolicy *string `type:"string" enum:"UserContextPolicy"` + // The Amazon Resource Name (ARN) of the role that enables the data source to + // access its resources. + RoleArn *string `type:"string"` - // Enables fetching access levels of groups and users from an AWS Single Sign-On - // identity source. To configure this, see UserGroupResolutionConfiguration - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). - UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"` + // The schedule that Amazon Kendra will update the data source. + Schedule *string `type:"string"` - // The user token configuration. - UserTokenConfigurations []*UserTokenConfiguration `type:"list"` + // The current status of the data source. When the status is ACTIVE the data + // source is ready to use. When the status is FAILED, the ErrorMessage field + // contains the reason that the data source failed. + Status *string `type:"string" enum:"DataSourceStatus"` + + // The type of the data source. + Type *string `type:"string" enum:"DataSourceType"` + + // The Unix timestamp of when the data source was last updated. + UpdatedAt *time.Time `type:"timestamp"` } // String returns the string representation. @@ -7073,7 +11130,7 @@ type CreateIndexInput 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 CreateIndexInput) String() string { +func (s DescribeDataSourceOutput) String() string { return awsutil.Prettify(s) } @@ -7082,206 +11139,108 @@ func (s CreateIndexInput) 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 CreateIndexInput) GoString() string { +func (s DescribeDataSourceOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateIndexInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateIndexInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) - } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) - } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.ServerSideEncryptionConfiguration != nil { - if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { - invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } - if s.UserGroupResolutionConfiguration != nil { - if err := s.UserGroupResolutionConfiguration.Validate(); err != nil { - invalidParams.AddNested("UserGroupResolutionConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.UserTokenConfigurations != nil { - for i, v := range s.UserTokenConfigurations { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "UserTokenConfigurations", i), err.(request.ErrInvalidParams)) - } - } - } +// SetConfiguration sets the Configuration field's value. +func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput { + s.Configuration = v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput { + s.CreatedAt = &v + return s } -// SetClientToken sets the ClientToken field's value. -func (s *CreateIndexInput) SetClientToken(v string) *CreateIndexInput { - s.ClientToken = &v +// SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value. +func (s *DescribeDataSourceOutput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *DescribeDataSourceOutput { + s.CustomDocumentEnrichmentConfiguration = v return s } // SetDescription sets the Description field's value. -func (s *CreateIndexInput) SetDescription(v string) *CreateIndexInput { +func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput { s.Description = &v return s } -// SetEdition sets the Edition field's value. -func (s *CreateIndexInput) SetEdition(v string) *CreateIndexInput { - s.Edition = &v +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput { + s.ErrorMessage = &v return s } -// SetName sets the Name field's value. -func (s *CreateIndexInput) SetName(v string) *CreateIndexInput { - s.Name = &v +// SetId sets the Id field's value. +func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput { + s.Id = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *CreateIndexInput) SetRoleArn(v string) *CreateIndexInput { - s.RoleArn = &v +// SetIndexId sets the IndexId field's value. +func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput { + s.IndexId = &v return s } -// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. -func (s *CreateIndexInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateIndexInput { - s.ServerSideEncryptionConfiguration = v +// SetLanguageCode sets the LanguageCode field's value. +func (s *DescribeDataSourceOutput) SetLanguageCode(v string) *DescribeDataSourceOutput { + s.LanguageCode = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateIndexInput) SetTags(v []*Tag) *CreateIndexInput { - s.Tags = v +// SetName sets the Name field's value. +func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput { + s.Name = &v return s } -// SetUserContextPolicy sets the UserContextPolicy field's value. -func (s *CreateIndexInput) SetUserContextPolicy(v string) *CreateIndexInput { - s.UserContextPolicy = &v +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput { + s.RoleArn = &v return s } -// SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value. -func (s *CreateIndexInput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *CreateIndexInput { - s.UserGroupResolutionConfiguration = v +// SetSchedule sets the Schedule field's value. +func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput { + s.Schedule = &v return s } -// SetUserTokenConfigurations sets the UserTokenConfigurations field's value. -func (s *CreateIndexInput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *CreateIndexInput { - s.UserTokenConfigurations = v +// SetStatus sets the Status field's value. +func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput { + s.Status = &v return s } -type CreateIndexOutput struct { - _ struct{} `type:"structure"` - - // The unique identifier of the index. Use this identifier when you query an - // index, set up a data source, or index a document. - Id *string `min:"36" 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 CreateIndexOutput) 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 CreateIndexOutput) GoString() string { - return s.String() +// SetType sets the Type field's value. +func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput { + s.Type = &v + return s } -// SetId sets the Id field's value. -func (s *CreateIndexOutput) SetId(v string) *CreateIndexOutput { - s.Id = &v +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput { + s.UpdatedAt = &v return s } -type CreateQuerySuggestionsBlockListInput struct { +type DescribeExperienceInput struct { _ struct{} `type:"structure"` - // A token that you provide to identify the request to create a query suggestions - // block list. - ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - - // A user-friendly description for the block list. - // - // For example, the description "List of all offensive words that can appear - // in user queries and need to be blocked from suggestions." - Description *string `type:"string"` - - // The identifier of the index you want to create a query suggestions block - // list for. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` - - // A user friendly name for the block list. - // - // For example, the block list named 'offensive-words' includes all offensive - // words that could appear in user queries and need to be blocked from suggestions. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // The IAM (Identity and Access Management) role used by Amazon Kendra to access - // the block list text file in your S3 bucket. - // - // You need permissions to the role ARN (Amazon Resource Name). The role needs - // S3 read permissions to your file in S3 and needs to give STS (Security Token - // Service) assume role permissions to Amazon Kendra. + // The identifier of your Amazon Kendra experience you want to get information + // on. // - // RoleArn is a required field - RoleArn *string `min:"1" type:"string" required:"true"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // The S3 path to your block list text file in your S3 bucket. - // - // Each block word or phrase should be on a separate line in a text file. + // The identifier of the index for your Amazon Kendra experience you want to + // get information on. // - // For information on the current quota limits for block lists, see Quotas for - // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). - // - // SourceS3Path is a required field - SourceS3Path *S3Path `type:"structure" required:"true"` - - // A tag that you can assign to a block list that categorizes the block list. - Tags []*Tag `type:"list"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -7289,7 +11248,7 @@ type CreateQuerySuggestionsBlockListInput 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 CreateQuerySuggestionsBlockListInput) String() string { +func (s DescribeExperienceInput) String() string { return awsutil.Prettify(s) } @@ -7298,15 +11257,18 @@ func (s CreateQuerySuggestionsBlockListInput) 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 CreateQuerySuggestionsBlockListInput) GoString() string { +func (s DescribeExperienceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateQuerySuggestionsBlockListInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateQuerySuggestionsBlockListInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) +func (s *DescribeExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeExperienceInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -7314,36 +11276,6 @@ func (s *CreateQuerySuggestionsBlockListInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - 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.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) - } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.SourceS3Path == nil { - invalidParams.Add(request.NewErrParamRequired("SourceS3Path")) - } - if s.SourceS3Path != nil { - if err := s.SourceS3Path.Validate(); err != nil { - invalidParams.AddNested("SourceS3Path", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -7351,53 +11283,61 @@ func (s *CreateQuerySuggestionsBlockListInput) Validate() error { return nil } -// SetClientToken sets the ClientToken field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetClientToken(v string) *CreateQuerySuggestionsBlockListInput { - s.ClientToken = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetDescription(v string) *CreateQuerySuggestionsBlockListInput { - s.Description = &v +// SetId sets the Id field's value. +func (s *DescribeExperienceInput) SetId(v string) *DescribeExperienceInput { + s.Id = &v return s } // SetIndexId sets the IndexId field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetIndexId(v string) *CreateQuerySuggestionsBlockListInput { +func (s *DescribeExperienceInput) SetIndexId(v string) *DescribeExperienceInput { s.IndexId = &v return s } -// SetName sets the Name field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetName(v string) *CreateQuerySuggestionsBlockListInput { - s.Name = &v - return s -} +type DescribeExperienceOutput struct { + _ struct{} `type:"structure"` -// SetRoleArn sets the RoleArn field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetRoleArn(v string) *CreateQuerySuggestionsBlockListInput { - s.RoleArn = &v - return s -} + // Shows the configuration information for your Amazon Kendra experience. This + // includes ContentSourceConfiguration, which specifies the data source IDs + // and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or + // group information to grant access to your Amazon Kendra experience. + Configuration *ExperienceConfiguration `type:"structure"` -// SetSourceS3Path sets the SourceS3Path field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetSourceS3Path(v *S3Path) *CreateQuerySuggestionsBlockListInput { - s.SourceS3Path = v - return s -} + // Shows the date-time your Amazon Kendra experience was created. + CreatedAt *time.Time `type:"timestamp"` -// SetTags sets the Tags field's value. -func (s *CreateQuerySuggestionsBlockListInput) SetTags(v []*Tag) *CreateQuerySuggestionsBlockListInput { - s.Tags = v - return s -} + // Shows the description for your Amazon Kendra experience. + Description *string `type:"string"` -type CreateQuerySuggestionsBlockListOutput struct { - _ struct{} `type:"structure"` + // Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are + // unique and fully hosted by Amazon Web Services. + Endpoints []*ExperienceEndpoint `min:"1" type:"list"` - // The unique identifier of the created block list. - Id *string `min:"36" type:"string"` + // The reason your Amazon Kendra experience could not properly process. + ErrorMessage *string `min:"1" type:"string"` + + // Shows the identifier of your Amazon Kendra experience. + Id *string `min:"1" type:"string"` + + // Shows the identifier of the index for your Amazon Kendra experience. + IndexId *string `min:"36" type:"string"` + + // Shows the name of your Amazon Kendra experience. + Name *string `min:"1" type:"string"` + + // Shows the Amazon Resource Name (ARN) of a role with permission to access + // Query operations, QuerySuggestions operations, SubmitFeedback operations, + // and Amazon Web Services SSO that stores your user and group information. + RoleArn *string `type:"string"` + + // The current processing status of your Amazon Kendra experience. When the + // status is ACTIVE, your Amazon Kendra experience is ready to use. When the + // status is FAILED, the ErrorMessage field contains the reason that this failed. + Status *string `type:"string" enum:"ExperienceStatus"` + + // Shows the date-time your Amazon Kendra experience was last updated. + UpdatedAt *time.Time `type:"timestamp"` } // String returns the string representation. @@ -7405,7 +11345,7 @@ type CreateQuerySuggestionsBlockListOutput 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 CreateQuerySuggestionsBlockListOutput) String() string { +func (s DescribeExperienceOutput) String() string { return awsutil.Prettify(s) } @@ -7414,51 +11354,88 @@ func (s CreateQuerySuggestionsBlockListOutput) 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 CreateQuerySuggestionsBlockListOutput) GoString() string { +func (s DescribeExperienceOutput) GoString() string { return s.String() } +// SetConfiguration sets the Configuration field's value. +func (s *DescribeExperienceOutput) SetConfiguration(v *ExperienceConfiguration) *DescribeExperienceOutput { + s.Configuration = v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeExperienceOutput) SetCreatedAt(v time.Time) *DescribeExperienceOutput { + s.CreatedAt = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeExperienceOutput) SetDescription(v string) *DescribeExperienceOutput { + s.Description = &v + return s +} + +// SetEndpoints sets the Endpoints field's value. +func (s *DescribeExperienceOutput) SetEndpoints(v []*ExperienceEndpoint) *DescribeExperienceOutput { + s.Endpoints = v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeExperienceOutput) SetErrorMessage(v string) *DescribeExperienceOutput { + s.ErrorMessage = &v + return s +} + // SetId sets the Id field's value. -func (s *CreateQuerySuggestionsBlockListOutput) SetId(v string) *CreateQuerySuggestionsBlockListOutput { +func (s *DescribeExperienceOutput) SetId(v string) *DescribeExperienceOutput { s.Id = &v return s } -type CreateThesaurusInput struct { - _ struct{} `type:"structure"` +// SetIndexId sets the IndexId field's value. +func (s *DescribeExperienceOutput) SetIndexId(v string) *DescribeExperienceOutput { + s.IndexId = &v + return s +} - // A token that you provide to identify the request to create a thesaurus. Multiple - // calls to the CreateThesaurus operation with the same client token will create - // only one thesaurus. - ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` +// SetName sets the Name field's value. +func (s *DescribeExperienceOutput) SetName(v string) *DescribeExperienceOutput { + s.Name = &v + return s +} - // The description for the new thesaurus. - Description *string `type:"string"` +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeExperienceOutput) SetRoleArn(v string) *DescribeExperienceOutput { + s.RoleArn = &v + return s +} - // The unique identifier of the index for the new thesaurus. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` +// SetStatus sets the Status field's value. +func (s *DescribeExperienceOutput) SetStatus(v string) *DescribeExperienceOutput { + s.Status = &v + return s +} - // The name for the new thesaurus. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeExperienceOutput) SetUpdatedAt(v time.Time) *DescribeExperienceOutput { + s.UpdatedAt = &v + return s +} - // An AWS Identity and Access Management (IAM) role that gives Amazon Kendra - // permissions to access thesaurus file specified in SourceS3Path. - // - // RoleArn is a required field - RoleArn *string `min:"1" type:"string" required:"true"` +type DescribeFaqInput struct { + _ struct{} `type:"structure"` - // The thesaurus file Amazon S3 source path. + // The unique identifier of the FAQ. // - // SourceS3Path is a required field - SourceS3Path *S3Path `type:"structure" required:"true"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // A list of key-value pairs that identify the thesaurus. You can use the tags - // to identify and organize your resources and to control access to resources. - Tags []*Tag `type:"list"` + // The identifier of the index that contains the FAQ. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -7466,7 +11443,7 @@ type CreateThesaurusInput 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 CreateThesaurusInput) String() string { +func (s DescribeFaqInput) String() string { return awsutil.Prettify(s) } @@ -7475,15 +11452,18 @@ func (s CreateThesaurusInput) 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 CreateThesaurusInput) GoString() string { +func (s DescribeFaqInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateThesaurusInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateThesaurusInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) +func (s *DescribeFaqInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFaqInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) @@ -7491,90 +11471,167 @@ func (s *CreateThesaurusInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - 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.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) - } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } - if s.SourceS3Path == nil { - invalidParams.Add(request.NewErrParamRequired("SourceS3Path")) - } - if s.SourceS3Path != nil { - if err := s.SourceS3Path.Validate(); err != nil { - invalidParams.AddNested("SourceS3Path", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil +} + +// SetId sets the Id field's value. +func (s *DescribeFaqInput) SetId(v string) *DescribeFaqInput { + s.Id = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *DescribeFaqInput) SetIndexId(v string) *DescribeFaqInput { + s.IndexId = &v + return s +} + +type DescribeFaqOutput struct { + _ struct{} `type:"structure"` + + // The date and time that the FAQ was created. + CreatedAt *time.Time `type:"timestamp"` + + // The description of the FAQ that you provided when it was created. + Description *string `type:"string"` + + // If the Status field is FAILED, the ErrorMessage field contains the reason + // why the FAQ failed. + ErrorMessage *string `min:"1" type:"string"` + + // The file format used by the input files for the FAQ. + FileFormat *string `type:"string" enum:"FaqFileFormat"` + + // The identifier of the FAQ. + Id *string `min:"1" type:"string"` + + // The identifier of the index that contains the FAQ. + IndexId *string `min:"36" type:"string"` + + // The code for a language. This shows a supported language for the FAQ document. + // English is supported by default. For more information on supported languages, + // including their codes, see Adding documents in languages other than English + // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + // The name that you gave the FAQ when it was created. + Name *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the role that provides access to the S3 + // bucket containing the input files for the FAQ. + RoleArn *string `type:"string"` + + // Information required to find a specific file in an Amazon S3 bucket. + S3Path *S3Path `type:"structure"` + + // The status of the FAQ. It is ready to use when the status is ACTIVE. + Status *string `type:"string" enum:"FaqStatus"` + + // The date and time that the FAQ was last updated. + UpdatedAt *time.Time `type:"timestamp"` } -// SetClientToken sets the ClientToken field's value. -func (s *CreateThesaurusInput) SetClientToken(v string) *CreateThesaurusInput { - s.ClientToken = &v +// 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 DescribeFaqOutput) 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 DescribeFaqOutput) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput { + s.CreatedAt = &v return s } // SetDescription sets the Description field's value. -func (s *CreateThesaurusInput) SetDescription(v string) *CreateThesaurusInput { +func (s *DescribeFaqOutput) SetDescription(v string) *DescribeFaqOutput { s.Description = &v return s } +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput { + s.ErrorMessage = &v + return s +} + +// SetFileFormat sets the FileFormat field's value. +func (s *DescribeFaqOutput) SetFileFormat(v string) *DescribeFaqOutput { + s.FileFormat = &v + return s +} + +// SetId sets the Id field's value. +func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput { + s.Id = &v + return s +} + // SetIndexId sets the IndexId field's value. -func (s *CreateThesaurusInput) SetIndexId(v string) *CreateThesaurusInput { +func (s *DescribeFaqOutput) SetIndexId(v string) *DescribeFaqOutput { s.IndexId = &v return s } +// SetLanguageCode sets the LanguageCode field's value. +func (s *DescribeFaqOutput) SetLanguageCode(v string) *DescribeFaqOutput { + s.LanguageCode = &v + return s +} + // SetName sets the Name field's value. -func (s *CreateThesaurusInput) SetName(v string) *CreateThesaurusInput { +func (s *DescribeFaqOutput) SetName(v string) *DescribeFaqOutput { s.Name = &v return s } // SetRoleArn sets the RoleArn field's value. -func (s *CreateThesaurusInput) SetRoleArn(v string) *CreateThesaurusInput { +func (s *DescribeFaqOutput) SetRoleArn(v string) *DescribeFaqOutput { s.RoleArn = &v return s } -// SetSourceS3Path sets the SourceS3Path field's value. -func (s *CreateThesaurusInput) SetSourceS3Path(v *S3Path) *CreateThesaurusInput { - s.SourceS3Path = v +// SetS3Path sets the S3Path field's value. +func (s *DescribeFaqOutput) SetS3Path(v *S3Path) *DescribeFaqOutput { + s.S3Path = v return s } -// SetTags sets the Tags field's value. -func (s *CreateThesaurusInput) SetTags(v []*Tag) *CreateThesaurusInput { - s.Tags = v +// SetStatus sets the Status field's value. +func (s *DescribeFaqOutput) SetStatus(v string) *DescribeFaqOutput { + s.Status = &v return s } -type CreateThesaurusOutput struct { +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput { + s.UpdatedAt = &v + return s +} + +type DescribeIndexInput struct { _ struct{} `type:"structure"` - // The unique identifier of the thesaurus. - Id *string `min:"1" type:"string"` + // The name of the index to describe. + // + // Id is a required field + Id *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -7582,7 +11639,7 @@ type CreateThesaurusOutput 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 CreateThesaurusOutput) String() string { +func (s DescribeIndexInput) String() string { return awsutil.Prettify(s) } @@ -7591,53 +11648,93 @@ func (s CreateThesaurusOutput) 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 CreateThesaurusOutput) GoString() string { +func (s DescribeIndexInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeIndexInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeIndexInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetId sets the Id field's value. -func (s *CreateThesaurusOutput) SetId(v string) *CreateThesaurusOutput { +func (s *DescribeIndexInput) SetId(v string) *DescribeIndexInput { s.Id = &v return s } -// Configuration information for a Amazon Kendra data source. -type DataSourceConfiguration struct { +type DescribeIndexOutput struct { _ struct{} `type:"structure"` - // Provides configuration information for connecting to a Confluence data source. - ConfluenceConfiguration *ConfluenceConfiguration `type:"structure"` + // For Enterprise edition indexes, you can choose to use additional capacity + // to meet the needs of your application. This contains the capacity units used + // for the index. A 0 for the query capacity or the storage capacity indicates + // that the index is using the default capacity for the index. + CapacityUnits *CapacityUnitsConfiguration `type:"structure"` - // Provides information necessary to create a data source connector for a database. - DatabaseConfiguration *DatabaseConfiguration `type:"structure"` + // The Unix datetime that the index was created. + CreatedAt *time.Time `type:"timestamp"` - // Provides configuration for data sources that connect to Google Drive. - GoogleDriveConfiguration *GoogleDriveConfiguration `type:"structure"` + // The description of the index. + Description *string `type:"string"` - // Provides configuration for data sources that connect to Microsoft OneDrive. - OneDriveConfiguration *OneDriveConfiguration `type:"structure"` + // Configuration settings for any metadata applied to the documents in the index. + DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"` - // Provides information to create a data source connector for a document repository - // in an Amazon S3 bucket. - S3Configuration *S3DataSourceConfiguration `type:"structure"` + // The Amazon Kendra edition used for the index. You decide the edition when + // you create the index. + Edition *string `type:"string" enum:"IndexEdition"` - // Provides configuration information for data sources that connect to a Salesforce - // site. - SalesforceConfiguration *SalesforceConfiguration `type:"structure"` + // When th eStatus field value is FAILED, the ErrorMessage field contains a + // message that explains why. + ErrorMessage *string `min:"1" type:"string"` - // Provides configuration for data sources that connect to ServiceNow instances. - ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"` + // The name of the index. + Id *string `min:"36" type:"string"` - // Provides information necessary to create a data source connector for a Microsoft - // SharePoint site. - SharePointConfiguration *SharePointConfiguration `type:"structure"` + // Provides information about the number of FAQ questions and answers and the + // number of text documents indexed. + IndexStatistics *IndexStatistics `type:"structure"` - // Provides the configuration information required for Amazon Kendra web crawler. - WebCrawlerConfiguration *WebCrawlerConfiguration `type:"structure"` + // The name of the index. + Name *string `min:"1" type:"string"` - // Provides the configuration information to connect to WorkDocs as your data - // source. - WorkDocsConfiguration *WorkDocsConfiguration `type:"structure"` + // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission + // to write to your Amazon Cloudwatch logs. + RoleArn *string `type:"string"` + + // The identifier of the KMScustomer master key (CMK) used to encrypt your data. + // Amazon Kendra doesn't support asymmetric CMKs. + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` + + // The current status of the index. When the value is ACTIVE, the index is ready + // for use. If the Status field value is FAILED, the ErrorMessage field contains + // a message that explains why. + Status *string `type:"string" enum:"IndexStatus"` + + // The Unix datetime that the index was last updated. + UpdatedAt *time.Time `type:"timestamp"` + + // The user context policy for the Amazon Kendra index. + UserContextPolicy *string `type:"string" enum:"UserContextPolicy"` + + // Shows whether you have enabled the configuration for fetching access levels + // of groups and users from an Amazon Web Services Single Sign On identity source. + UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"` + + // The user token configuration for the Amazon Kendra index. + UserTokenConfigurations []*UserTokenConfiguration `type:"list"` } // String returns the string representation. @@ -7645,155 +11742,133 @@ type DataSourceConfiguration 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 DataSourceConfiguration) String() string { +func (s DescribeIndexOutput) 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 DataSourceConfiguration) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceConfiguration"} - if s.ConfluenceConfiguration != nil { - if err := s.ConfluenceConfiguration.Validate(); err != nil { - invalidParams.AddNested("ConfluenceConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.DatabaseConfiguration != nil { - if err := s.DatabaseConfiguration.Validate(); err != nil { - invalidParams.AddNested("DatabaseConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.GoogleDriveConfiguration != nil { - if err := s.GoogleDriveConfiguration.Validate(); err != nil { - invalidParams.AddNested("GoogleDriveConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.OneDriveConfiguration != nil { - if err := s.OneDriveConfiguration.Validate(); err != nil { - invalidParams.AddNested("OneDriveConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.S3Configuration != nil { - if err := s.S3Configuration.Validate(); err != nil { - invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) - } - } - if s.SalesforceConfiguration != nil { - if err := s.SalesforceConfiguration.Validate(); err != nil { - invalidParams.AddNested("SalesforceConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.ServiceNowConfiguration != nil { - if err := s.ServiceNowConfiguration.Validate(); err != nil { - invalidParams.AddNested("ServiceNowConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.SharePointConfiguration != nil { - if err := s.SharePointConfiguration.Validate(); err != nil { - invalidParams.AddNested("SharePointConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.WebCrawlerConfiguration != nil { - if err := s.WebCrawlerConfiguration.Validate(); err != nil { - invalidParams.AddNested("WebCrawlerConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.WorkDocsConfiguration != nil { - if err := s.WorkDocsConfiguration.Validate(); err != nil { - invalidParams.AddNested("WorkDocsConfiguration", err.(request.ErrInvalidParams)) - } - } +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeIndexOutput) GoString() string { + return s.String() +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCapacityUnits sets the CapacityUnits field's value. +func (s *DescribeIndexOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeIndexOutput { + s.CapacityUnits = v + return s } -// SetConfluenceConfiguration sets the ConfluenceConfiguration field's value. -func (s *DataSourceConfiguration) SetConfluenceConfiguration(v *ConfluenceConfiguration) *DataSourceConfiguration { - s.ConfluenceConfiguration = v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput { + s.CreatedAt = &v return s } -// SetDatabaseConfiguration sets the DatabaseConfiguration field's value. -func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration { - s.DatabaseConfiguration = v +// SetDescription sets the Description field's value. +func (s *DescribeIndexOutput) SetDescription(v string) *DescribeIndexOutput { + s.Description = &v return s } -// SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value. -func (s *DataSourceConfiguration) SetGoogleDriveConfiguration(v *GoogleDriveConfiguration) *DataSourceConfiguration { - s.GoogleDriveConfiguration = v +// SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value. +func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput { + s.DocumentMetadataConfigurations = v return s } -// SetOneDriveConfiguration sets the OneDriveConfiguration field's value. -func (s *DataSourceConfiguration) SetOneDriveConfiguration(v *OneDriveConfiguration) *DataSourceConfiguration { - s.OneDriveConfiguration = v +// SetEdition sets the Edition field's value. +func (s *DescribeIndexOutput) SetEdition(v string) *DescribeIndexOutput { + s.Edition = &v return s } -// SetS3Configuration sets the S3Configuration field's value. -func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration { - s.S3Configuration = v +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeIndexOutput) SetErrorMessage(v string) *DescribeIndexOutput { + s.ErrorMessage = &v return s } -// SetSalesforceConfiguration sets the SalesforceConfiguration field's value. -func (s *DataSourceConfiguration) SetSalesforceConfiguration(v *SalesforceConfiguration) *DataSourceConfiguration { - s.SalesforceConfiguration = v +// SetId sets the Id field's value. +func (s *DescribeIndexOutput) SetId(v string) *DescribeIndexOutput { + s.Id = &v return s } -// SetServiceNowConfiguration sets the ServiceNowConfiguration field's value. -func (s *DataSourceConfiguration) SetServiceNowConfiguration(v *ServiceNowConfiguration) *DataSourceConfiguration { - s.ServiceNowConfiguration = v +// SetIndexStatistics sets the IndexStatistics field's value. +func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput { + s.IndexStatistics = v return s } -// SetSharePointConfiguration sets the SharePointConfiguration field's value. -func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration { - s.SharePointConfiguration = v +// SetName sets the Name field's value. +func (s *DescribeIndexOutput) SetName(v string) *DescribeIndexOutput { + s.Name = &v return s } -// SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value. -func (s *DataSourceConfiguration) SetWebCrawlerConfiguration(v *WebCrawlerConfiguration) *DataSourceConfiguration { - s.WebCrawlerConfiguration = v +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeIndexOutput) SetRoleArn(v string) *DescribeIndexOutput { + s.RoleArn = &v return s } -// SetWorkDocsConfiguration sets the WorkDocsConfiguration field's value. -func (s *DataSourceConfiguration) SetWorkDocsConfiguration(v *WorkDocsConfiguration) *DataSourceConfiguration { - s.WorkDocsConfiguration = v +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput { + s.ServerSideEncryptionConfiguration = v return s } -// Data source information for user context filtering. -type DataSourceGroup struct { +// SetStatus sets the Status field's value. +func (s *DescribeIndexOutput) SetStatus(v string) *DescribeIndexOutput { + s.Status = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput { + s.UpdatedAt = &v + return s +} + +// SetUserContextPolicy sets the UserContextPolicy field's value. +func (s *DescribeIndexOutput) SetUserContextPolicy(v string) *DescribeIndexOutput { + s.UserContextPolicy = &v + return s +} + +// SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value. +func (s *DescribeIndexOutput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *DescribeIndexOutput { + s.UserGroupResolutionConfiguration = v + return s +} + +// SetUserTokenConfigurations sets the UserTokenConfigurations field's value. +func (s *DescribeIndexOutput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *DescribeIndexOutput { + s.UserTokenConfigurations = v + return s +} + +type DescribePrincipalMappingInput struct { _ struct{} `type:"structure"` - // The identifier of the data source group you want to add to your list of data - // source groups. This is for filtering search results based on the groups' - // access to documents in that data source. - // - // DataSourceId is a required field - DataSourceId *string `min:"1" type:"string" required:"true"` + // The identifier of the data source to check the processing of PUT and DELETE + // actions for mapping users to their groups. + DataSourceId *string `min:"1" type:"string"` - // The identifier of the group you want to add to your list of groups. This - // is for filtering search results based on the groups' access to documents. + // The identifier of the group required to check the processing of PUT and DELETE + // actions for mapping users to their groups. // // GroupId is a required field GroupId *string `min:"1" type:"string" required:"true"` + + // The identifier of the index required to check the processing of PUT and DELETE + // actions for mapping users to their groups. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -7801,7 +11876,7 @@ type DataSourceGroup 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 DataSourceGroup) String() string { +func (s DescribePrincipalMappingInput) String() string { return awsutil.Prettify(s) } @@ -7810,16 +11885,13 @@ func (s DataSourceGroup) 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 DataSourceGroup) GoString() string { +func (s DescribePrincipalMappingInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceGroup) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceGroup"} - if s.DataSourceId == nil { - invalidParams.Add(request.NewErrParamRequired("DataSourceId")) - } +func (s *DescribePrincipalMappingInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePrincipalMappingInput"} if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) } @@ -7829,6 +11901,12 @@ func (s *DataSourceGroup) Validate() error { if s.GroupId != nil && len(*s.GroupId) < 1 { invalidParams.Add(request.NewErrParamMinLen("GroupId", 1)) } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } if invalidParams.Len() > 0 { return invalidParams @@ -7837,143 +11915,53 @@ func (s *DataSourceGroup) Validate() error { } // SetDataSourceId sets the DataSourceId field's value. -func (s *DataSourceGroup) SetDataSourceId(v string) *DataSourceGroup { +func (s *DescribePrincipalMappingInput) SetDataSourceId(v string) *DescribePrincipalMappingInput { s.DataSourceId = &v return s } // SetGroupId sets the GroupId field's value. -func (s *DataSourceGroup) SetGroupId(v string) *DataSourceGroup { +func (s *DescribePrincipalMappingInput) SetGroupId(v string) *DescribePrincipalMappingInput { s.GroupId = &v return s } -// Summary information for a Amazon Kendra data source. Returned in a call to -// the DescribeDataSource operation. -type DataSourceSummary struct { - _ struct{} `type:"structure"` - - // The UNIX datetime that the data source was created. - CreatedAt *time.Time `type:"timestamp"` - - // The unique identifier for the data source. - Id *string `min:"1" type:"string"` - - // The code for a language. This shows a supported language for all documents - // in the data source. English is supported by default. For more information - // on supported languages, including their codes, see Adding documents in languages - // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" type:"string"` - - // The name of the data source. - Name *string `min:"1" type:"string"` - - // The status of the data source. When the status is ACTIVE the data source - // is ready to use. - Status *string `type:"string" enum:"DataSourceStatus"` - - // The type of the data source. - Type *string `type:"string" enum:"DataSourceType"` - - // The UNIX datetime that the data source was lasted updated. - UpdatedAt *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 DataSourceSummary) 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 DataSourceSummary) GoString() string { - return s.String() -} - -// SetCreatedAt sets the CreatedAt field's value. -func (s *DataSourceSummary) SetCreatedAt(v time.Time) *DataSourceSummary { - s.CreatedAt = &v - return s -} - -// SetId sets the Id field's value. -func (s *DataSourceSummary) SetId(v string) *DataSourceSummary { - s.Id = &v - return s -} - -// SetLanguageCode sets the LanguageCode field's value. -func (s *DataSourceSummary) SetLanguageCode(v string) *DataSourceSummary { - s.LanguageCode = &v - return s -} - -// SetName sets the Name field's value. -func (s *DataSourceSummary) SetName(v string) *DataSourceSummary { - s.Name = &v - return s -} - -// SetStatus sets the Status field's value. -func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary { - s.Status = &v - return s -} - -// SetType sets the Type field's value. -func (s *DataSourceSummary) SetType(v string) *DataSourceSummary { - s.Type = &v - return s -} - -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary { - s.UpdatedAt = &v +// SetIndexId sets the IndexId field's value. +func (s *DescribePrincipalMappingInput) SetIndexId(v string) *DescribePrincipalMappingInput { + s.IndexId = &v return s } -// Provides information about a synchronization job. -type DataSourceSyncJob struct { - _ struct{} `type:"structure"` - - // If the reason that the synchronization failed is due to an error with the - // underlying data source, this field contains a code that identifies the error. - DataSourceErrorCode *string `min:"1" type:"string"` - - // The UNIX datetime that the synchronization job was completed. - EndTime *time.Time `type:"timestamp"` - - // If the Status field is set to FAILED, the ErrorCode field contains a the - // reason that the synchronization failed. - ErrorCode *string `type:"string" enum:"ErrorCode"` - - // If the Status field is set to ERROR, the ErrorMessage field contains a description - // of the error that caused the synchronization to fail. - ErrorMessage *string `min:"1" type:"string"` +type DescribePrincipalMappingOutput struct { + _ struct{} `type:"structure"` - // A unique identifier for the synchronization job. - ExecutionId *string `min:"1" type:"string"` + // Shows the identifier of the data source to see information on the processing + // of PUT and DELETE actions for mapping users to their groups. + DataSourceId *string `min:"1" type:"string"` - // Maps a batch delete document request to a specific data source sync job. - // This is optional and should only be supplied when documents are deleted by - // a data source connector. - Metrics *DataSourceSyncJobMetrics `type:"structure"` + // Shows the identifier of the group to see information on the processing of + // PUT and DELETE actions for mapping users to their groups. + GroupId *string `min:"1" type:"string"` - // The UNIX datetime that the synchronization job was started. - StartTime *time.Time `type:"timestamp"` + // Shows the following information on the processing of PUT and DELETE actions + // for mapping users to their groups: + // + // * Status – the status can be either PROCESSING, SUCCEEDED, DELETING, + // DELETED, or FAILED. + // + // * Last updated – the last date-time an action was updated. + // + // * Received – the last date-time an action was received or submitted. + // + // * Ordering ID – the latest action that should process and apply after + // other actions. + // + // * Failure reason – the reason an action could not be processed. + GroupOrderingIdSummaries []*GroupOrderingIdSummary `type:"list"` - // The execution status of the synchronization job. When the Status field is - // set to SUCCEEDED, the synchronization job is done. If the status code is - // set to FAILED, the ErrorCode and ErrorMessage fields give you the reason - // for the failure. - Status *string `type:"string" enum:"DataSourceSyncJobStatus"` + // Shows the identifier of the index to see information on the processing of + // PUT and DELETE actions for mapping users to their groups. + IndexId *string `min:"36" type:"string"` } // String returns the string representation. @@ -7981,7 +11969,7 @@ type DataSourceSyncJob 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 DataSourceSyncJob) String() string { +func (s DescribePrincipalMappingOutput) String() string { return awsutil.Prettify(s) } @@ -7990,77 +11978,46 @@ func (s DataSourceSyncJob) 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 DataSourceSyncJob) GoString() string { +func (s DescribePrincipalMappingOutput) GoString() string { return s.String() } -// SetDataSourceErrorCode sets the DataSourceErrorCode field's value. -func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob { - s.DataSourceErrorCode = &v - return s -} - -// SetEndTime sets the EndTime field's value. -func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob { - s.EndTime = &v - return s -} - -// SetErrorCode sets the ErrorCode field's value. -func (s *DataSourceSyncJob) SetErrorCode(v string) *DataSourceSyncJob { - s.ErrorCode = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DataSourceSyncJob) SetErrorMessage(v string) *DataSourceSyncJob { - s.ErrorMessage = &v - return s -} - -// SetExecutionId sets the ExecutionId field's value. -func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob { - s.ExecutionId = &v +// SetDataSourceId sets the DataSourceId field's value. +func (s *DescribePrincipalMappingOutput) SetDataSourceId(v string) *DescribePrincipalMappingOutput { + s.DataSourceId = &v return s } -// SetMetrics sets the Metrics field's value. -func (s *DataSourceSyncJob) SetMetrics(v *DataSourceSyncJobMetrics) *DataSourceSyncJob { - s.Metrics = v +// SetGroupId sets the GroupId field's value. +func (s *DescribePrincipalMappingOutput) SetGroupId(v string) *DescribePrincipalMappingOutput { + s.GroupId = &v return s } -// SetStartTime sets the StartTime field's value. -func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob { - s.StartTime = &v +// SetGroupOrderingIdSummaries sets the GroupOrderingIdSummaries field's value. +func (s *DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries(v []*GroupOrderingIdSummary) *DescribePrincipalMappingOutput { + s.GroupOrderingIdSummaries = v return s } -// SetStatus sets the Status field's value. -func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob { - s.Status = &v +// SetIndexId sets the IndexId field's value. +func (s *DescribePrincipalMappingOutput) SetIndexId(v string) *DescribePrincipalMappingOutput { + s.IndexId = &v return s } -// Maps a particular data source sync job to a particular data source. -type DataSourceSyncJobMetricTarget struct { +type DescribeQuerySuggestionsBlockListInput struct { _ struct{} `type:"structure"` - // The ID of the data source that is running the sync job. + // The unique identifier of the block list. // - // DataSourceId is a required field - DataSourceId *string `min:"1" type:"string" required:"true"` + // Id is a required field + Id *string `min:"36" type:"string" required:"true"` - // The ID of the sync job that is running on the data source. - // - // If the ID of a sync job is not provided and there is a sync job running, - // then the ID of this sync job is used and metrics are generated for this sync - // job. + // The identifier of the index for the block list. // - // If the ID of a sync job is not provided and there is no sync job running, - // then no metrics are generated and documents are indexed/deleted at the index - // level without sync job metrics included. - DataSourceSyncJobId *string `min:"1" type:"string"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -8068,7 +12025,7 @@ type DataSourceSyncJobMetricTarget 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 DataSourceSyncJobMetricTarget) String() string { +func (s DescribeQuerySuggestionsBlockListInput) String() string { return awsutil.Prettify(s) } @@ -8077,21 +12034,24 @@ func (s DataSourceSyncJobMetricTarget) 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 DataSourceSyncJobMetricTarget) GoString() string { +func (s DescribeQuerySuggestionsBlockListInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceSyncJobMetricTarget) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceSyncJobMetricTarget"} - if s.DataSourceId == nil { - invalidParams.Add(request.NewErrParamRequired("DataSourceId")) +func (s *DescribeQuerySuggestionsBlockListInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeQuerySuggestionsBlockListInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) } - if s.DataSourceSyncJobId != nil && len(*s.DataSourceSyncJobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSourceSyncJobId", 1)) + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -8100,110 +12060,67 @@ func (s *DataSourceSyncJobMetricTarget) Validate() error { return nil } -// SetDataSourceId sets the DataSourceId field's value. -func (s *DataSourceSyncJobMetricTarget) SetDataSourceId(v string) *DataSourceSyncJobMetricTarget { - s.DataSourceId = &v +// SetId sets the Id field's value. +func (s *DescribeQuerySuggestionsBlockListInput) SetId(v string) *DescribeQuerySuggestionsBlockListInput { + s.Id = &v return s } -// SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value. -func (s *DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId(v string) *DataSourceSyncJobMetricTarget { - s.DataSourceSyncJobId = &v +// SetIndexId sets the IndexId field's value. +func (s *DescribeQuerySuggestionsBlockListInput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListInput { + s.IndexId = &v return s } -// Maps a batch delete document request to a specific data source sync job. -// This is optional and should only be supplied when documents are deleted by -// a data source connector. -type DataSourceSyncJobMetrics struct { +type DescribeQuerySuggestionsBlockListOutput struct { _ struct{} `type:"structure"` - // The number of documents added from the data source up to now in the data - // source sync. - DocumentsAdded *string `type:"string"` - - // The number of documents deleted from the data source up to now in the data - // source sync run. - DocumentsDeleted *string `type:"string"` - - // The number of documents that failed to sync from the data source up to now - // in the data source sync run. - DocumentsFailed *string `type:"string"` - - // The number of documents modified in the data source up to now in the data - // source sync run. - DocumentsModified *string `type:"string"` - - // The current number of documents crawled by the current sync job in the data - // source. - DocumentsScanned *string `type:"string"` -} + // Shows the date-time a block list for query suggestions was created. + CreatedAt *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 DataSourceSyncJobMetrics) String() string { - return awsutil.Prettify(s) -} + // Shows the description for the block list. + Description *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 DataSourceSyncJobMetrics) GoString() string { - return s.String() -} + // Shows the error message with details when there are issues in processing + // the block list. + ErrorMessage *string `min:"1" type:"string"` -// SetDocumentsAdded sets the DocumentsAdded field's value. -func (s *DataSourceSyncJobMetrics) SetDocumentsAdded(v string) *DataSourceSyncJobMetrics { - s.DocumentsAdded = &v - return s -} + // Shows the current size of the block list text file in S3. + FileSizeBytes *int64 `type:"long"` -// SetDocumentsDeleted sets the DocumentsDeleted field's value. -func (s *DataSourceSyncJobMetrics) SetDocumentsDeleted(v string) *DataSourceSyncJobMetrics { - s.DocumentsDeleted = &v - return s -} + // Shows the unique identifier of the block list. + Id *string `min:"36" type:"string"` -// SetDocumentsFailed sets the DocumentsFailed field's value. -func (s *DataSourceSyncJobMetrics) SetDocumentsFailed(v string) *DataSourceSyncJobMetrics { - s.DocumentsFailed = &v - return s -} + // Shows the identifier of the index for the block list. + IndexId *string `min:"36" type:"string"` -// SetDocumentsModified sets the DocumentsModified field's value. -func (s *DataSourceSyncJobMetrics) SetDocumentsModified(v string) *DataSourceSyncJobMetrics { - s.DocumentsModified = &v - return s -} + // Shows the current number of valid, non-empty words or phrases in the block + // list text file. + ItemCount *int64 `type:"integer"` -// SetDocumentsScanned sets the DocumentsScanned field's value. -func (s *DataSourceSyncJobMetrics) SetDocumentsScanned(v string) *DataSourceSyncJobMetrics { - s.DocumentsScanned = &v - return s -} + // Shows the name of the block list. + Name *string `min:"1" type:"string"` -// Maps a column or attribute in the data source to an index field. You must -// first create the fields in the index using the UpdateIndex operation. -type DataSourceToIndexFieldMapping struct { - _ struct{} `type:"structure"` + // Shows the current IAM (Identity and Access Management) role used by Amazon + // Kendra to access the block list text file in S3. + // + // The role needs S3 read permissions to your file in S3 and needs to give STS + // (Security Token Service) assume role permissions to Amazon Kendra. + RoleArn *string `type:"string"` - // The name of the column or attribute in the data source. + // Shows the current S3 path to your block list text file in your S3 bucket. // - // DataSourceFieldName is a required field - DataSourceFieldName *string `min:"1" type:"string" required:"true"` + // Each block word or phrase should be on a separate line in a text file. + // + // For information on the current quota limits for block lists, see Quotas for + // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + SourceS3Path *S3Path `type:"structure"` - // The type of data stored in the column or attribute. - DateFieldFormat *string `min:"4" type:"string"` + // Shows whether the current status of the block list is ACTIVE or INACTIVE. + Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"` - // The name of the field in the index. - // - // IndexFieldName is a required field - IndexFieldName *string `min:"1" type:"string" required:"true"` + // Shows the date-time a block list for query suggestions was last updated. + UpdatedAt *time.Time `type:"timestamp"` } // String returns the string representation. @@ -8211,7 +12128,7 @@ type DataSourceToIndexFieldMapping 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 DataSourceToIndexFieldMapping) String() string { +func (s DescribeQuerySuggestionsBlockListOutput) String() string { return awsutil.Prettify(s) } @@ -8220,69 +12137,90 @@ func (s DataSourceToIndexFieldMapping) 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 DataSourceToIndexFieldMapping) GoString() string { +func (s DescribeQuerySuggestionsBlockListOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceToIndexFieldMapping) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceToIndexFieldMapping"} - if s.DataSourceFieldName == nil { - invalidParams.Add(request.NewErrParamRequired("DataSourceFieldName")) - } - if s.DataSourceFieldName != nil && len(*s.DataSourceFieldName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSourceFieldName", 1)) - } - if s.DateFieldFormat != nil && len(*s.DateFieldFormat) < 4 { - invalidParams.Add(request.NewErrParamMinLen("DateFieldFormat", 4)) - } - if s.IndexFieldName == nil { - invalidParams.Add(request.NewErrParamRequired("IndexFieldName")) - } - if s.IndexFieldName != nil && len(*s.IndexFieldName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IndexFieldName", 1)) - } +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetCreatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput { + s.CreatedAt = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDescription sets the Description field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetDescription(v string) *DescribeQuerySuggestionsBlockListOutput { + s.Description = &v + return s } -// SetDataSourceFieldName sets the DataSourceFieldName field's value. -func (s *DataSourceToIndexFieldMapping) SetDataSourceFieldName(v string) *DataSourceToIndexFieldMapping { - s.DataSourceFieldName = &v +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetErrorMessage(v string) *DescribeQuerySuggestionsBlockListOutput { + s.ErrorMessage = &v return s } -// SetDateFieldFormat sets the DateFieldFormat field's value. -func (s *DataSourceToIndexFieldMapping) SetDateFieldFormat(v string) *DataSourceToIndexFieldMapping { - s.DateFieldFormat = &v +// SetFileSizeBytes sets the FileSizeBytes field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes(v int64) *DescribeQuerySuggestionsBlockListOutput { + s.FileSizeBytes = &v return s } -// SetIndexFieldName sets the IndexFieldName field's value. -func (s *DataSourceToIndexFieldMapping) SetIndexFieldName(v string) *DataSourceToIndexFieldMapping { - s.IndexFieldName = &v +// SetId sets the Id field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetId(v string) *DescribeQuerySuggestionsBlockListOutput { + s.Id = &v return s } -// Provides information for connecting to an Amazon VPC. -type DataSourceVpcConfiguration struct { - _ struct{} `type:"structure"` +// SetIndexId sets the IndexId field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListOutput { + s.IndexId = &v + return s +} - // A list of identifiers of security groups within your Amazon VPC. The security - // groups should enable Amazon Kendra to connect to the data source. - // - // SecurityGroupIds is a required field - SecurityGroupIds []*string `min:"1" type:"list" required:"true"` +// SetItemCount sets the ItemCount field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetItemCount(v int64) *DescribeQuerySuggestionsBlockListOutput { + s.ItemCount = &v + return s +} - // A list of identifiers for subnets within your Amazon VPC. The subnets should - // be able to connect to each other in the VPC, and they should have outgoing - // access to the Internet through a NAT device. +// SetName sets the Name field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetName(v string) *DescribeQuerySuggestionsBlockListOutput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetRoleArn(v string) *DescribeQuerySuggestionsBlockListOutput { + s.RoleArn = &v + return s +} + +// SetSourceS3Path sets the SourceS3Path field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path(v *S3Path) *DescribeQuerySuggestionsBlockListOutput { + s.SourceS3Path = v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetStatus(v string) *DescribeQuerySuggestionsBlockListOutput { + s.Status = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput { + s.UpdatedAt = &v + return s +} + +type DescribeQuerySuggestionsConfigInput struct { + _ struct{} `type:"structure"` + + // The identifier of the index you want to describe query suggestions settings + // for. // - // SubnetIds is a required field - SubnetIds []*string `min:"1" type:"list" required:"true"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -8290,7 +12228,7 @@ type DataSourceVpcConfiguration 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 DataSourceVpcConfiguration) String() string { +func (s DescribeQuerySuggestionsConfigInput) String() string { return awsutil.Prettify(s) } @@ -8299,24 +12237,18 @@ func (s DataSourceVpcConfiguration) 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 DataSourceVpcConfiguration) GoString() string { +func (s DescribeQuerySuggestionsConfigInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceVpcConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceVpcConfiguration"} - if s.SecurityGroupIds == nil { - invalidParams.Add(request.NewErrParamRequired("SecurityGroupIds")) - } - if s.SecurityGroupIds != nil && len(s.SecurityGroupIds) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecurityGroupIds", 1)) - } - if s.SubnetIds == nil { - invalidParams.Add(request.NewErrParamRequired("SubnetIds")) +func (s *DescribeQuerySuggestionsConfigInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeQuerySuggestionsConfigInput"} + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.SubnetIds != nil && len(s.SubnetIds) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SubnetIds", 1)) + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -8325,48 +12257,63 @@ func (s *DataSourceVpcConfiguration) Validate() error { return nil } -// SetSecurityGroupIds sets the SecurityGroupIds field's value. -func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration { - s.SecurityGroupIds = v - return s -} - -// SetSubnetIds sets the SubnetIds field's value. -func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration { - s.SubnetIds = v +// SetIndexId sets the IndexId field's value. +func (s *DescribeQuerySuggestionsConfigInput) SetIndexId(v string) *DescribeQuerySuggestionsConfigInput { + s.IndexId = &v return s } -// Provides the information necessary to connect a database to an index. -type DatabaseConfiguration struct { +type DescribeQuerySuggestionsConfigOutput struct { _ struct{} `type:"structure"` - // Information about the database column that provides information for user - // context filtering. - AclConfiguration *AclConfiguration `type:"structure"` + // Shows whether Amazon Kendra uses all queries or only uses queries that include + // user information to generate query suggestions. + IncludeQueriesWithoutUserInformation *bool `type:"boolean"` - // Information about where the index should get the document information from - // the database. + // Shows the date-time query suggestions for an index was last cleared. // - // ColumnConfiguration is a required field - ColumnConfiguration *ColumnConfiguration `type:"structure" required:"true"` + // After you clear suggestions, Amazon Kendra learns new suggestions based on + // new queries added to the query log from the time you cleared suggestions. + // Amazon Kendra only considers re-occurences of a query from the time you cleared + // suggestions. + LastClearTime *time.Time `type:"timestamp"` - // The information necessary to connect to a database. - // - // ConnectionConfiguration is a required field - ConnectionConfiguration *ConnectionConfiguration `type:"structure" required:"true"` + // Shows the date-time query suggestions for an index was last updated. + LastSuggestionsBuildTime *time.Time `type:"timestamp"` - // The type of database engine that runs the database. + // Shows the minimum number of unique users who must search a query in order + // for the query to be eligible to suggest to your users. + MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"` + + // Shows the minimum number of times a query must be searched in order for the + // query to be eligible to suggest to your users. + MinimumQueryCount *int64 `min:"1" type:"integer"` + + // Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY + // mode. // - // DatabaseEngineType is a required field - DatabaseEngineType *string `type:"string" required:"true" enum:"DatabaseEngineType"` + // By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off + // query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig + // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) + // operation. + Mode *string `type:"string" enum:"Mode"` - // Provides information about how Amazon Kendra uses quote marks around SQL - // identifiers when querying a database data source. - SqlConfiguration *SqlConfiguration `type:"structure"` + // Shows how recent your queries are in your query log time window (in days). + QueryLogLookBackWindowInDays *int64 `type:"integer"` - // Provides information for connecting to an Amazon VPC. - VpcConfiguration *DataSourceVpcConfiguration `type:"structure"` + // Shows whether the status of query suggestions settings is currently Active + // or Updating. + // + // Active means the current settings apply and Updating means your changed settings + // are in the process of applying. + Status *string `type:"string" enum:"QuerySuggestionsStatus"` + + // Shows the current total count of query suggestions for an index. + // + // This count can change when you update your query suggestions settings, if + // you filter out certain queries from suggestions using a block list, and as + // the query log accumulates more queries for Amazon Kendra to learn from. + TotalSuggestionsCount *int64 `type:"integer"` } // String returns the string representation. @@ -8374,103 +12321,82 @@ type DatabaseConfiguration 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 DatabaseConfiguration) String() string { +func (s DescribeQuerySuggestionsConfigOutput) 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 DatabaseConfiguration) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DatabaseConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DatabaseConfiguration"} - if s.ColumnConfiguration == nil { - invalidParams.Add(request.NewErrParamRequired("ColumnConfiguration")) - } - if s.ConnectionConfiguration == nil { - invalidParams.Add(request.NewErrParamRequired("ConnectionConfiguration")) - } - if s.DatabaseEngineType == nil { - invalidParams.Add(request.NewErrParamRequired("DatabaseEngineType")) - } - if s.AclConfiguration != nil { - if err := s.AclConfiguration.Validate(); err != nil { - invalidParams.AddNested("AclConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.ColumnConfiguration != nil { - if err := s.ColumnConfiguration.Validate(); err != nil { - invalidParams.AddNested("ColumnConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.ConnectionConfiguration != nil { - if err := s.ConnectionConfiguration.Validate(); err != nil { - invalidParams.AddNested("ConnectionConfiguration", err.(request.ErrInvalidParams)) - } - } - if s.VpcConfiguration != nil { - if err := s.VpcConfiguration.Validate(); err != nil { - invalidParams.AddNested("VpcConfiguration", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// 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 DescribeQuerySuggestionsConfigOutput) GoString() string { + return s.String() } -// SetAclConfiguration sets the AclConfiguration field's value. -func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration { - s.AclConfiguration = v +// SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation(v bool) *DescribeQuerySuggestionsConfigOutput { + s.IncludeQueriesWithoutUserInformation = &v return s } -// SetColumnConfiguration sets the ColumnConfiguration field's value. -func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration { - s.ColumnConfiguration = v +// SetLastClearTime sets the LastClearTime field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetLastClearTime(v time.Time) *DescribeQuerySuggestionsConfigOutput { + s.LastClearTime = &v return s } -// SetConnectionConfiguration sets the ConnectionConfiguration field's value. -func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration { - s.ConnectionConfiguration = v +// SetLastSuggestionsBuildTime sets the LastSuggestionsBuildTime field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime(v time.Time) *DescribeQuerySuggestionsConfigOutput { + s.LastSuggestionsBuildTime = &v return s } -// SetDatabaseEngineType sets the DatabaseEngineType field's value. -func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration { - s.DatabaseEngineType = &v +// SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers(v int64) *DescribeQuerySuggestionsConfigOutput { + s.MinimumNumberOfQueryingUsers = &v return s } -// SetSqlConfiguration sets the SqlConfiguration field's value. -func (s *DatabaseConfiguration) SetSqlConfiguration(v *SqlConfiguration) *DatabaseConfiguration { - s.SqlConfiguration = v +// SetMinimumQueryCount sets the MinimumQueryCount field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount(v int64) *DescribeQuerySuggestionsConfigOutput { + s.MinimumQueryCount = &v return s } -// SetVpcConfiguration sets the VpcConfiguration field's value. -func (s *DatabaseConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DatabaseConfiguration { - s.VpcConfiguration = v +// SetMode sets the Mode field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetMode(v string) *DescribeQuerySuggestionsConfigOutput { + s.Mode = &v return s } -type DeleteDataSourceInput struct { +// SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays(v int64) *DescribeQuerySuggestionsConfigOutput { + s.QueryLogLookBackWindowInDays = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetStatus(v string) *DescribeQuerySuggestionsConfigOutput { + s.Status = &v + return s +} + +// SetTotalSuggestionsCount sets the TotalSuggestionsCount field's value. +func (s *DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount(v int64) *DescribeQuerySuggestionsConfigOutput { + s.TotalSuggestionsCount = &v + return s +} + +type DescribeThesaurusInput struct { _ struct{} `type:"structure"` - // The unique identifier of the data source to delete. + // The identifier of the thesaurus to describe. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The unique identifier of the index associated with the data source. + // The identifier of the index associated with the thesaurus to describe. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -8481,7 +12407,7 @@ type DeleteDataSourceInput 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 DeleteDataSourceInput) String() string { +func (s DescribeThesaurusInput) String() string { return awsutil.Prettify(s) } @@ -8490,13 +12416,13 @@ func (s DeleteDataSourceInput) 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 DeleteDataSourceInput) GoString() string { +func (s DescribeThesaurusInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDataSourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDataSourceInput"} +func (s *DescribeThesaurusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeThesaurusInput"} if s.Id == nil { invalidParams.Add(request.NewErrParamRequired("Id")) } @@ -8517,19 +12443,66 @@ func (s *DeleteDataSourceInput) Validate() error { } // SetId sets the Id field's value. -func (s *DeleteDataSourceInput) SetId(v string) *DeleteDataSourceInput { +func (s *DescribeThesaurusInput) SetId(v string) *DescribeThesaurusInput { s.Id = &v return s } // SetIndexId sets the IndexId field's value. -func (s *DeleteDataSourceInput) SetIndexId(v string) *DeleteDataSourceInput { +func (s *DescribeThesaurusInput) SetIndexId(v string) *DescribeThesaurusInput { s.IndexId = &v return s } -type DeleteDataSourceOutput struct { +type DescribeThesaurusOutput struct { _ struct{} `type:"structure"` + + // The Unix datetime that the thesaurus was created. + CreatedAt *time.Time `type:"timestamp"` + + // The thesaurus description. + Description *string `type:"string"` + + // When the Status field value is FAILED, the ErrorMessage field provides more + // information. + ErrorMessage *string `min:"1" type:"string"` + + // The size of the thesaurus file in bytes. + FileSizeBytes *int64 `type:"long"` + + // The identifier of the thesaurus. + Id *string `min:"1" type:"string"` + + // The identifier of the index associated with the thesaurus to describe. + IndexId *string `min:"36" type:"string"` + + // The thesaurus name. + Name *string `min:"1" type:"string"` + + // An IAM role that gives Amazon Kendra permissions to access thesaurus file + // specified in SourceS3Path. + RoleArn *string `type:"string"` + + // Information required to find a specific file in an Amazon S3 bucket. + SourceS3Path *S3Path `type:"structure"` + + // The current status of the thesaurus. When the value is ACTIVE, queries are + // able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage + // field provides more information. + // + // If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could + // not ingest the new thesaurus file. The old thesaurus file is still active. + Status *string `type:"string" enum:"ThesaurusStatus"` + + // The number of synonym rules in the thesaurus file. + SynonymRuleCount *int64 `type:"long"` + + // The number of unique terms in the thesaurus file. For example, the synonyms + // a,b,c and a=>d, the term count would be 4. + TermCount *int64 `type:"long"` + + // The Unix datetime that the thesaurus was last updated. + UpdatedAt *time.Time `type:"timestamp"` } // String returns the string representation. @@ -8537,7 +12510,7 @@ type DeleteDataSourceOutput 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 DeleteDataSourceOutput) String() string { +func (s DescribeThesaurusOutput) String() string { return awsutil.Prettify(s) } @@ -8546,19 +12519,102 @@ func (s DeleteDataSourceOutput) 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 DeleteDataSourceOutput) GoString() string { +func (s DescribeThesaurusOutput) GoString() string { return s.String() } -type DeleteFaqInput struct { +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeThesaurusOutput) SetCreatedAt(v time.Time) *DescribeThesaurusOutput { + s.CreatedAt = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeThesaurusOutput) SetDescription(v string) *DescribeThesaurusOutput { + s.Description = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeThesaurusOutput) SetErrorMessage(v string) *DescribeThesaurusOutput { + s.ErrorMessage = &v + return s +} + +// SetFileSizeBytes sets the FileSizeBytes field's value. +func (s *DescribeThesaurusOutput) SetFileSizeBytes(v int64) *DescribeThesaurusOutput { + s.FileSizeBytes = &v + return s +} + +// SetId sets the Id field's value. +func (s *DescribeThesaurusOutput) SetId(v string) *DescribeThesaurusOutput { + s.Id = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *DescribeThesaurusOutput) SetIndexId(v string) *DescribeThesaurusOutput { + s.IndexId = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeThesaurusOutput) SetName(v string) *DescribeThesaurusOutput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeThesaurusOutput) SetRoleArn(v string) *DescribeThesaurusOutput { + s.RoleArn = &v + return s +} + +// SetSourceS3Path sets the SourceS3Path field's value. +func (s *DescribeThesaurusOutput) SetSourceS3Path(v *S3Path) *DescribeThesaurusOutput { + s.SourceS3Path = v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeThesaurusOutput) SetStatus(v string) *DescribeThesaurusOutput { + s.Status = &v + return s +} + +// SetSynonymRuleCount sets the SynonymRuleCount field's value. +func (s *DescribeThesaurusOutput) SetSynonymRuleCount(v int64) *DescribeThesaurusOutput { + s.SynonymRuleCount = &v + return s +} + +// SetTermCount sets the TermCount field's value. +func (s *DescribeThesaurusOutput) SetTermCount(v int64) *DescribeThesaurusOutput { + s.TermCount = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeThesaurusOutput) SetUpdatedAt(v time.Time) *DescribeThesaurusOutput { + s.UpdatedAt = &v + return s +} + +type DisassociateEntitiesFromExperienceInput struct { _ struct{} `type:"structure"` - // The identifier of the FAQ to remove. + // Lists users or groups in your Amazon Web Services SSO identity source. + // + // EntityList is a required field + EntityList []*EntityConfiguration `min:"1" type:"list" required:"true"` + + // The identifier of your Amazon Kendra experience. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The index to remove the FAQ from. + // The identifier of the index for your Amazon Kendra experience. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -8569,7 +12625,7 @@ type DeleteFaqInput 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 DeleteFaqInput) String() string { +func (s DisassociateEntitiesFromExperienceInput) String() string { return awsutil.Prettify(s) } @@ -8578,13 +12634,19 @@ func (s DeleteFaqInput) 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 DeleteFaqInput) GoString() string { +func (s DisassociateEntitiesFromExperienceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteFaqInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteFaqInput"} +func (s *DisassociateEntitiesFromExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociateEntitiesFromExperienceInput"} + if s.EntityList == nil { + invalidParams.Add(request.NewErrParamRequired("EntityList")) + } + if s.EntityList != nil && len(s.EntityList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityList", 1)) + } if s.Id == nil { invalidParams.Add(request.NewErrParamRequired("Id")) } @@ -8597,6 +12659,16 @@ func (s *DeleteFaqInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } + if s.EntityList != nil { + for i, v := range s.EntityList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "EntityList", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8604,20 +12676,30 @@ func (s *DeleteFaqInput) Validate() error { return nil } +// SetEntityList sets the EntityList field's value. +func (s *DisassociateEntitiesFromExperienceInput) SetEntityList(v []*EntityConfiguration) *DisassociateEntitiesFromExperienceInput { + s.EntityList = v + return s +} + // SetId sets the Id field's value. -func (s *DeleteFaqInput) SetId(v string) *DeleteFaqInput { +func (s *DisassociateEntitiesFromExperienceInput) SetId(v string) *DisassociateEntitiesFromExperienceInput { s.Id = &v return s } // SetIndexId sets the IndexId field's value. -func (s *DeleteFaqInput) SetIndexId(v string) *DeleteFaqInput { +func (s *DisassociateEntitiesFromExperienceInput) SetIndexId(v string) *DisassociateEntitiesFromExperienceInput { s.IndexId = &v return s } -type DeleteFaqOutput struct { +type DisassociateEntitiesFromExperienceOutput struct { _ struct{} `type:"structure"` + + // Lists the users or groups in your Amazon Web Services SSO identity source + // that failed to properly remove access to your Amazon Kendra experience. + FailedEntityList []*FailedEntity `min:"1" type:"list"` } // String returns the string representation. @@ -8625,7 +12707,7 @@ type DeleteFaqOutput 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 DeleteFaqOutput) String() string { +func (s DisassociateEntitiesFromExperienceOutput) String() string { return awsutil.Prettify(s) } @@ -8634,17 +12716,34 @@ func (s DeleteFaqOutput) 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 DeleteFaqOutput) GoString() string { +func (s DisassociateEntitiesFromExperienceOutput) GoString() string { return s.String() } -type DeleteIndexInput struct { +// SetFailedEntityList sets the FailedEntityList field's value. +func (s *DisassociateEntitiesFromExperienceOutput) SetFailedEntityList(v []*FailedEntity) *DisassociateEntitiesFromExperienceOutput { + s.FailedEntityList = v + return s +} + +type DisassociatePersonasFromEntitiesInput struct { _ struct{} `type:"structure"` - // The identifier of the index to delete. + // The identifiers of users or groups in your Amazon Web Services SSO identity + // source. For example, user IDs could be user emails. + // + // EntityIds is a required field + EntityIds []*string `min:"1" type:"list" required:"true"` + + // The identifier of your Amazon Kendra experience. // // Id is a required field - Id *string `min:"36" type:"string" required:"true"` + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index for your Amazon Kendra experience. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -8652,7 +12751,7 @@ type DeleteIndexInput 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 DeleteIndexInput) String() string { +func (s DisassociatePersonasFromEntitiesInput) String() string { return awsutil.Prettify(s) } @@ -8661,18 +12760,30 @@ func (s DeleteIndexInput) 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 DeleteIndexInput) GoString() string { +func (s DisassociatePersonasFromEntitiesInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteIndexInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteIndexInput"} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisassociatePersonasFromEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociatePersonasFromEntitiesInput"} + if s.EntityIds == nil { + invalidParams.Add(request.NewErrParamRequired("EntityIds")) + } + if s.EntityIds != nil && len(s.EntityIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityIds", 1)) + } if s.Id == nil { invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.Id != nil && len(*s.Id) < 36 { - invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } if invalidParams.Len() > 0 { @@ -8681,14 +12792,30 @@ func (s *DeleteIndexInput) Validate() error { return nil } +// SetEntityIds sets the EntityIds field's value. +func (s *DisassociatePersonasFromEntitiesInput) SetEntityIds(v []*string) *DisassociatePersonasFromEntitiesInput { + s.EntityIds = v + return s +} + // SetId sets the Id field's value. -func (s *DeleteIndexInput) SetId(v string) *DeleteIndexInput { +func (s *DisassociatePersonasFromEntitiesInput) SetId(v string) *DisassociatePersonasFromEntitiesInput { s.Id = &v return s } -type DeleteIndexOutput struct { +// SetIndexId sets the IndexId field's value. +func (s *DisassociatePersonasFromEntitiesInput) SetIndexId(v string) *DisassociatePersonasFromEntitiesInput { + s.IndexId = &v + return s +} + +type DisassociatePersonasFromEntitiesOutput struct { _ struct{} `type:"structure"` + + // Lists the users or groups in your Amazon Web Services SSO identity source + // that failed to properly remove access to your Amazon Kendra experience. + FailedEntityList []*FailedEntity `min:"1" type:"list"` } // String returns the string representation. @@ -8696,7 +12823,7 @@ type DeleteIndexOutput 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 DeleteIndexOutput) String() string { +func (s DisassociatePersonasFromEntitiesOutput) String() string { return awsutil.Prettify(s) } @@ -8705,50 +12832,57 @@ func (s DeleteIndexOutput) 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 DeleteIndexOutput) GoString() string { +func (s DisassociatePersonasFromEntitiesOutput) GoString() string { return s.String() } -type DeletePrincipalMappingInput struct { +// SetFailedEntityList sets the FailedEntityList field's value. +func (s *DisassociatePersonasFromEntitiesOutput) SetFailedEntityList(v []*FailedEntity) *DisassociatePersonasFromEntitiesOutput { + s.FailedEntityList = v + return s +} + +// A document in an index. +type Document struct { _ struct{} `type:"structure"` - // The identifier of the data source you want to delete a group from. - // - // This is useful if a group is tied to multiple data sources and you want to - // delete a group from accessing documents in a certain data source. For example, - // the groups "Research", "Engineering", and "Sales and Marketing" are all tied - // to the company's documents stored in the data sources Confluence and Salesforce. - // You want to delete "Research" and "Engineering" groups from Salesforce, so - // that these groups cannot access customer-related documents stored in Salesforce. - // Only "Sales and Marketing" should access documents in the Salesforce data - // source. - DataSourceId *string `min:"1" type:"string"` + // Information on user and group access rights, which is used for user context + // filtering. + AccessControlList []*Principal `type:"list"` - // The identifier of the group you want to delete. - // - // GroupId is a required field - GroupId *string `min:"1" type:"string" required:"true"` + // Custom attributes to apply to the document. Use the custom attributes to + // provide additional information for searching, to provide facets for refining + // searches, and to provide additional information in the query response. + Attributes []*DocumentAttribute `type:"list"` - // The identifier of the index you want to delete a group from. + // The contents of the document. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // Documents passed to the Blob parameter must be base64 encoded. Your code + // might not need to encode the document file bytes if you're using an Amazon + // Web Services SDK to call Amazon Kendra operations. If you are calling the + // Amazon Kendra endpoint directly using REST, you must base64 encode the contents + // before sending. + // Blob is automatically base64 encoded/decoded by the SDK. + Blob []byte `type:"blob"` - // The timestamp identifier you specify to ensure Amazon Kendra does not override - // the latest DELETE action with previous actions. The highest number ID, which - // is the ordering ID, is the latest action you want to process and apply on - // top of other actions with lower number IDs. This prevents previous actions - // with lower number IDs from possibly overriding the latest action. - // - // The ordering ID can be the UNIX time of the last update you made to a group - // members list. You would then provide this list when calling PutPrincipalMapping. - // This ensures your DELETE action for that updated group with the latest members - // list doesn't get overwritten by earlier DELETE actions for the same group - // which are yet to be processed. + // The file type of the document in the Blob field. + ContentType *string `type:"string" enum:"ContentType"` + + // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access + // to. + HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"` + + // A unique identifier of the document in the index. // - // The default ordering ID is the current UNIX time in milliseconds that the - // action was received by Amazon Kendra. - OrderingId *int64 `type:"long"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // Information required to find a specific file in an Amazon S3 bucket. + S3Path *S3Path `type:"structure"` + + // The title of the document. + Title *string `type:"string"` } // String returns the string representation. @@ -8756,7 +12890,7 @@ type DeletePrincipalMappingInput 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 DeletePrincipalMappingInput) String() string { +func (s Document) String() string { return awsutil.Prettify(s) } @@ -8765,27 +12899,56 @@ func (s DeletePrincipalMappingInput) 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 DeletePrincipalMappingInput) GoString() string { +func (s Document) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeletePrincipalMappingInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeletePrincipalMappingInput"} - if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) +func (s *Document) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Document"} + if s.HierarchicalAccessControlList != nil && len(s.HierarchicalAccessControlList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("HierarchicalAccessControlList", 1)) } - if s.GroupId == nil { - invalidParams.Add(request.NewErrParamRequired("GroupId")) + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.GroupId != nil && len(*s.GroupId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GroupId", 1)) + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) + if s.AccessControlList != nil { + for i, v := range s.AccessControlList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AccessControlList", i), err.(request.ErrInvalidParams)) + } + } } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + 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 s.HierarchicalAccessControlList != nil { + for i, v := range s.HierarchicalAccessControlList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "HierarchicalAccessControlList", i), err.(request.ErrInvalidParams)) + } + } + } + if s.S3Path != nil { + if err := s.S3Path.Validate(); err != nil { + invalidParams.AddNested("S3Path", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -8794,32 +12957,67 @@ func (s *DeletePrincipalMappingInput) Validate() error { return nil } -// SetDataSourceId sets the DataSourceId field's value. -func (s *DeletePrincipalMappingInput) SetDataSourceId(v string) *DeletePrincipalMappingInput { - s.DataSourceId = &v +// SetAccessControlList sets the AccessControlList field's value. +func (s *Document) SetAccessControlList(v []*Principal) *Document { + s.AccessControlList = v return s } -// SetGroupId sets the GroupId field's value. -func (s *DeletePrincipalMappingInput) SetGroupId(v string) *DeletePrincipalMappingInput { - s.GroupId = &v +// SetAttributes sets the Attributes field's value. +func (s *Document) SetAttributes(v []*DocumentAttribute) *Document { + s.Attributes = v return s } -// SetIndexId sets the IndexId field's value. -func (s *DeletePrincipalMappingInput) SetIndexId(v string) *DeletePrincipalMappingInput { - s.IndexId = &v +// SetBlob sets the Blob field's value. +func (s *Document) SetBlob(v []byte) *Document { + s.Blob = v return s } -// SetOrderingId sets the OrderingId field's value. -func (s *DeletePrincipalMappingInput) SetOrderingId(v int64) *DeletePrincipalMappingInput { - s.OrderingId = &v +// SetContentType sets the ContentType field's value. +func (s *Document) SetContentType(v string) *Document { + s.ContentType = &v return s } -type DeletePrincipalMappingOutput struct { +// SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value. +func (s *Document) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *Document { + s.HierarchicalAccessControlList = v + return s +} + +// SetId sets the Id field's value. +func (s *Document) SetId(v string) *Document { + s.Id = &v + return s +} + +// SetS3Path sets the S3Path field's value. +func (s *Document) SetS3Path(v *S3Path) *Document { + s.S3Path = v + return s +} + +// SetTitle sets the Title field's value. +func (s *Document) SetTitle(v string) *Document { + s.Title = &v + return s +} + +// A custom attribute value assigned to a document. +type DocumentAttribute struct { _ struct{} `type:"structure"` + + // The identifier for the attribute. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // The value of the attribute. + // + // Value is a required field + Value *DocumentAttributeValue `type:"structure" required:"true"` } // String returns the string representation. @@ -8827,7 +13025,7 @@ type DeletePrincipalMappingOutput 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 DeletePrincipalMappingOutput) String() string { +func (s DocumentAttribute) String() string { return awsutil.Prettify(s) } @@ -8836,22 +13034,86 @@ func (s DeletePrincipalMappingOutput) 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 DeletePrincipalMappingOutput) GoString() string { +func (s DocumentAttribute) GoString() string { return s.String() } -type DeleteQuerySuggestionsBlockListInput struct { +// Validate inspects the fields of the type to determine if they are valid. +func (s *DocumentAttribute) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentAttribute"} + 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 s.Value != nil { + if err := s.Value.Validate(); err != nil { + invalidParams.AddNested("Value", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *DocumentAttribute) SetKey(v string) *DocumentAttribute { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute { + s.Value = v + return s +} + +// The condition used for the target document attribute or metadata field when +// ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget +// to apply the condition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html). +// +// For example, you can create the 'Department' target field and have it prefill +// department names associated with the documents based on information in the +// 'Source_URI' field. Set the condition that if the 'Source_URI' field contains +// 'financial' in its URI value, then prefill the target field 'Department' +// with the target value 'Finance' for the document. +// +// Amazon Kendra cannot create a target field if it has not already been created +// as an index field. After you create your index field, you can create a document +// metadata field using DocumentAttributeTarget. Amazon Kendra then will map +// your newly created metadata field to your index field. +type DocumentAttributeCondition struct { _ struct{} `type:"structure"` - // The unique identifier of the block list that needs to be deleted. + // The identifier of the document attribute used for the condition. // - // Id is a required field - Id *string `min:"36" type:"string" required:"true"` + // For example, 'Source_URI' could be an identifier for the attribute or metadata + // field that contains source URIs associated with the documents. + // + // Amazon Kendra currently does not support _document_body as an attribute key + // used for the condition. + // + // ConditionDocumentAttributeKey is a required field + ConditionDocumentAttributeKey *string `min:"1" type:"string" required:"true"` - // The identifier of the you want to delete a block list from. + // The value used by the operator. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // For example, you can specify the value 'financial' for strings in the 'Source_URI' + // field that partially match or contain this value. + ConditionOnValue *DocumentAttributeValue `type:"structure"` + + // The condition operator. + // + // For example, you can use 'Contains' to partially match a string. + // + // Operator is a required field + Operator *string `type:"string" required:"true" enum:"ConditionOperator"` } // String returns the string representation. @@ -8859,7 +13121,7 @@ type DeleteQuerySuggestionsBlockListInput 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 DeleteQuerySuggestionsBlockListInput) String() string { +func (s DocumentAttributeCondition) String() string { return awsutil.Prettify(s) } @@ -8868,24 +13130,26 @@ func (s DeleteQuerySuggestionsBlockListInput) 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 DeleteQuerySuggestionsBlockListInput) GoString() string { +func (s DocumentAttributeCondition) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteQuerySuggestionsBlockListInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteQuerySuggestionsBlockListInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) +func (s *DocumentAttributeCondition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentAttributeCondition"} + if s.ConditionDocumentAttributeKey == nil { + invalidParams.Add(request.NewErrParamRequired("ConditionDocumentAttributeKey")) } - if s.Id != nil && len(*s.Id) < 36 { - invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + if s.ConditionDocumentAttributeKey != nil && len(*s.ConditionDocumentAttributeKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConditionDocumentAttributeKey", 1)) } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) + if s.Operator == nil { + invalidParams.Add(request.NewErrParamRequired("Operator")) } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + if s.ConditionOnValue != nil { + if err := s.ConditionOnValue.Validate(); err != nil { + invalidParams.AddNested("ConditionOnValue", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -8894,52 +13158,59 @@ func (s *DeleteQuerySuggestionsBlockListInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DeleteQuerySuggestionsBlockListInput) SetId(v string) *DeleteQuerySuggestionsBlockListInput { - s.Id = &v +// SetConditionDocumentAttributeKey sets the ConditionDocumentAttributeKey field's value. +func (s *DocumentAttributeCondition) SetConditionDocumentAttributeKey(v string) *DocumentAttributeCondition { + s.ConditionDocumentAttributeKey = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DeleteQuerySuggestionsBlockListInput) SetIndexId(v string) *DeleteQuerySuggestionsBlockListInput { - s.IndexId = &v +// SetConditionOnValue sets the ConditionOnValue field's value. +func (s *DocumentAttributeCondition) SetConditionOnValue(v *DocumentAttributeValue) *DocumentAttributeCondition { + s.ConditionOnValue = v return s } -type DeleteQuerySuggestionsBlockListOutput struct { - _ struct{} `type:"structure"` +// SetOperator sets the Operator field's value. +func (s *DocumentAttributeCondition) SetOperator(v string) *DocumentAttributeCondition { + s.Operator = &v + return s } -// String returns the string representation. +// The target document attribute or metadata field you want to alter when ingesting +// documents into Amazon Kendra. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteQuerySuggestionsBlockListOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. +// For example, you can delete customer identification numbers associated with +// the documents, stored in the document metadata field called 'Customer_ID'. +// You set the target key as 'Customer_ID' and the deletion flag to TRUE. This +// removes all customer ID values in the field 'Customer_ID'. This would scrub +// personally identifiable information from each document's metadata. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteQuerySuggestionsBlockListOutput) GoString() string { - return s.String() -} - -type DeleteThesaurusInput struct { +// Amazon Kendra cannot create a target field if it has not already been created +// as an index field. After you create your index field, you can create a document +// metadata field using DocumentAttributeTarget. Amazon Kendra then will map +// your newly created metadata field to your index field. +// +// You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html). +type DocumentAttributeTarget struct { _ struct{} `type:"structure"` - // The identifier of the thesaurus to delete. + // The identifier of the target document attribute or metadata field. // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` + // For example, 'Department' could be an identifier for the target attribute + // or metadata field that includes the department names associated with the + // documents. + TargetDocumentAttributeKey *string `min:"1" type:"string"` - // The identifier of the index associated with the thesaurus to delete. + // The target value you want to create for the target attribute. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // For example, 'Finance' could be the target value for the target attribute + // key 'Department'. + TargetDocumentAttributeValue *DocumentAttributeValue `type:"structure"` + + // TRUE to delete the existing target value for your specified target attribute + // key. You cannot create a target value and set this to TRUE. To create a target + // value (TargetDocumentAttributeValue), set this to FALSE. + TargetDocumentAttributeValueDeletion *bool `type:"boolean"` } // String returns the string representation. @@ -8947,7 +13218,7 @@ type DeleteThesaurusInput 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 DeleteThesaurusInput) String() string { +func (s DocumentAttributeTarget) String() string { return awsutil.Prettify(s) } @@ -8956,24 +13227,20 @@ func (s DeleteThesaurusInput) 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 DeleteThesaurusInput) GoString() string { +func (s DocumentAttributeTarget) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteThesaurusInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteThesaurusInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) - } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) +func (s *DocumentAttributeTarget) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentAttributeTarget"} + if s.TargetDocumentAttributeKey != nil && len(*s.TargetDocumentAttributeKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TargetDocumentAttributeKey", 1)) + } + if s.TargetDocumentAttributeValue != nil { + if err := s.TargetDocumentAttributeValue.Validate(); err != nil { + invalidParams.AddNested("TargetDocumentAttributeValue", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -8982,52 +13249,44 @@ func (s *DeleteThesaurusInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DeleteThesaurusInput) SetId(v string) *DeleteThesaurusInput { - s.Id = &v +// SetTargetDocumentAttributeKey sets the TargetDocumentAttributeKey field's value. +func (s *DocumentAttributeTarget) SetTargetDocumentAttributeKey(v string) *DocumentAttributeTarget { + s.TargetDocumentAttributeKey = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DeleteThesaurusInput) SetIndexId(v string) *DeleteThesaurusInput { - s.IndexId = &v +// SetTargetDocumentAttributeValue sets the TargetDocumentAttributeValue field's value. +func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeTarget { + s.TargetDocumentAttributeValue = v return s } -type DeleteThesaurusOutput 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 DeleteThesaurusOutput) 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 DeleteThesaurusOutput) GoString() string { - return s.String() +// SetTargetDocumentAttributeValueDeletion sets the TargetDocumentAttributeValueDeletion field's value. +func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValueDeletion(v bool) *DocumentAttributeTarget { + s.TargetDocumentAttributeValueDeletion = &v + return s } -type DescribeDataSourceInput struct { +// The value of a custom document attribute. You can only provide one value +// for a custom attribute. +type DocumentAttributeValue struct { _ struct{} `type:"structure"` - // The unique identifier of the data source to describe. + // A date expressed as an ISO 8601 string. // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` + // It is important for the time zone to be included in the ISO 8601 date-time + // format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format + // for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. + DateValue *time.Time `type:"timestamp"` - // The identifier of the index that contains the data source. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // A long integer value. + LongValue *int64 `type:"long"` + + // A list of strings. + StringListValue []*string `type:"list"` + + // A string, such as "department". + StringValue *string `min:"1" type:"string"` } // String returns the string representation. @@ -9035,7 +13294,7 @@ type DescribeDataSourceInput 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 DescribeDataSourceInput) String() string { +func (s DocumentAttributeValue) String() string { return awsutil.Prettify(s) } @@ -9044,24 +13303,15 @@ func (s DescribeDataSourceInput) 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 DescribeDataSourceInput) GoString() string { +func (s DocumentAttributeValue) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDataSourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDataSourceInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) - } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) +func (s *DocumentAttributeValue) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentAttributeValue"} + if s.StringValue != nil && len(*s.StringValue) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StringValue", 1)) } if invalidParams.Len() > 0 { @@ -9070,68 +13320,101 @@ func (s *DescribeDataSourceInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput { - s.Id = &v +// SetDateValue sets the DateValue field's value. +func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue { + s.DateValue = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput { - s.IndexId = &v +// SetLongValue sets the LongValue field's value. +func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue { + s.LongValue = &v return s } -type DescribeDataSourceOutput struct { - _ struct{} `type:"structure"` - - // Information that describes where the data source is located and how the data - // source is configured. The specific information in the description depends - // on the data source provider. - Configuration *DataSourceConfiguration `type:"structure"` - - // The Unix timestamp of when the data source was created. - CreatedAt *time.Time `type:"timestamp"` +// SetStringListValue sets the StringListValue field's value. +func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue { + s.StringListValue = v + return s +} - // The description of the data source. - Description *string `type:"string"` +// SetStringValue sets the StringValue field's value. +func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue { + s.StringValue = &v + return s +} - // When the Status field value is FAILED, the ErrorMessage field contains a - // description of the error that caused the data source to fail. - ErrorMessage *string `min:"1" type:"string"` +// Provides the count of documents that match a particular attribute when doing +// a faceted search. +type DocumentAttributeValueCountPair struct { + _ struct{} `type:"structure"` - // The identifier of the data source. - Id *string `min:"1" type:"string"` + // The number of documents in the response that have the attribute value for + // the key. + Count *int64 `type:"integer"` - // The identifier of the index that contains the data source. - IndexId *string `min:"36" type:"string"` + // The value of the attribute. For example, "HR." + DocumentAttributeValue *DocumentAttributeValue `type:"structure"` +} - // The code for a language. This shows a supported language for all documents - // in the data source. English is supported by default. For more information - // on supported languages, including their codes, see Adding documents in languages - // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" 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 DocumentAttributeValueCountPair) String() string { + return awsutil.Prettify(s) +} - // The name that you gave the data source when it was created. - Name *string `min:"1" 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 DocumentAttributeValueCountPair) GoString() string { + return s.String() +} - // The Amazon Resource Name (ARN) of the role that enables the data source to - // access its resources. - RoleArn *string `min:"1" type:"string"` +// SetCount sets the Count field's value. +func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair { + s.Count = &v + return s +} - // The schedule that Amazon Kendra will update the data source. - Schedule *string `type:"string"` +// SetDocumentAttributeValue sets the DocumentAttributeValue field's value. +func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair { + s.DocumentAttributeValue = v + return s +} - // The current status of the data source. When the status is ACTIVE the data - // source is ready to use. When the status is FAILED, the ErrorMessage field - // contains the reason that the data source failed. - Status *string `type:"string" enum:"DataSourceStatus"` +// Identifies a document for which to retrieve status information +type DocumentInfo struct { + _ struct{} `type:"structure"` - // The type of the data source. - Type *string `type:"string" enum:"DataSourceType"` + // Attributes that identify a specific version of a document to check. + // + // The only valid attributes are: + // + // * version + // + // * datasourceId + // + // * jobExecutionId + // + // The attributes follow these rules: + // + // * dataSourceId and jobExecutionId must be used together. + // + // * version is ignored if dataSourceId and jobExecutionId are not provided. + // + // * If dataSourceId and jobExecutionId are provided, but version is not, + // the version defaults to "0". + Attributes []*DocumentAttribute `type:"list"` - // The Unix timestamp of when the data source was last updated. - UpdatedAt *time.Time `type:"timestamp"` + // The unique identifier of the document. + // + // DocumentId is a required field + DocumentId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -9139,7 +13422,7 @@ type DescribeDataSourceOutput 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 DescribeDataSourceOutput) String() string { +func (s DocumentInfo) String() string { return awsutil.Prettify(s) } @@ -9148,100 +13431,152 @@ func (s DescribeDataSourceOutput) 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 DescribeDataSourceOutput) GoString() string { +func (s DocumentInfo) GoString() string { return s.String() } -// SetConfiguration sets the Configuration field's value. -func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput { - s.Configuration = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DocumentInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentInfo"} + if s.DocumentId == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentId")) + } + if s.DocumentId != nil && len(*s.DocumentId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentId", 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 } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput { - s.CreatedAt = &v +// SetAttributes sets the Attributes field's value. +func (s *DocumentInfo) SetAttributes(v []*DocumentAttribute) *DocumentInfo { + s.Attributes = v return s } -// SetDescription sets the Description field's value. -func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput { - s.Description = &v +// SetDocumentId sets the DocumentId field's value. +func (s *DocumentInfo) SetDocumentId(v string) *DocumentInfo { + s.DocumentId = &v return s } -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput { - s.ErrorMessage = &v - return s +// Specifies the properties of a custom index field. +type DocumentMetadataConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the index field. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // Provides manual tuning parameters to determine how the field affects the + // search results. + Relevance *Relevance `type:"structure"` + + // Provides information about how the field is used during a search. + Search *Search `type:"structure"` + + // The data type of the index field. + // + // Type is a required field + Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"` } -// SetId sets the Id field's value. -func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput { - s.Id = &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 DocumentMetadataConfiguration) String() string { + return awsutil.Prettify(s) } -// SetIndexId sets the IndexId field's value. -func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput { - s.IndexId = &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 DocumentMetadataConfiguration) GoString() string { + return s.String() } -// SetLanguageCode sets the LanguageCode field's value. -func (s *DescribeDataSourceOutput) SetLanguageCode(v string) *DescribeDataSourceOutput { - s.LanguageCode = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DocumentMetadataConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentMetadataConfiguration"} + 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.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Relevance != nil { + if err := s.Relevance.Validate(); err != nil { + invalidParams.AddNested("Relevance", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } // SetName sets the Name field's value. -func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput { +func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration { s.Name = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput { - s.RoleArn = &v - return s -} - -// SetSchedule sets the Schedule field's value. -func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput { - s.Schedule = &v +// SetRelevance sets the Relevance field's value. +func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration { + s.Relevance = v return s } -// SetStatus sets the Status field's value. -func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput { - s.Status = &v +// SetSearch sets the Search field's value. +func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration { + s.Search = v return s } // SetType sets the Type field's value. -func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput { +func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration { s.Type = &v return s } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput { - s.UpdatedAt = &v - return s -} - -type DescribeFaqInput struct { +// Overrides the document relevance properties of a custom index field. +type DocumentRelevanceConfiguration struct { _ struct{} `type:"structure"` - // The unique identifier of the FAQ. + // The name of the tuning configuration to override document relevance at the + // index level. // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The identifier of the index that contains the FAQ. + // Provides information for manually tuning the relevance of a field in a search. + // When a query includes terms that match the field, the results are given a + // boost in the response based on these tuning parameters. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // Relevance is a required field + Relevance *Relevance `type:"structure" required:"true"` } // String returns the string representation. @@ -9249,7 +13584,7 @@ type DescribeFaqInput 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 DescribeFaqInput) String() string { +func (s DocumentRelevanceConfiguration) String() string { return awsutil.Prettify(s) } @@ -9258,24 +13593,26 @@ func (s DescribeFaqInput) 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 DescribeFaqInput) GoString() string { +func (s DocumentRelevanceConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeFaqInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeFaqInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) +func (s *DocumentRelevanceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentRelevanceConfiguration"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) + if s.Relevance == nil { + invalidParams.Add(request.NewErrParamRequired("Relevance")) } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + if s.Relevance != nil { + if err := s.Relevance.Validate(); err != nil { + invalidParams.AddNested("Relevance", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -9284,61 +13621,28 @@ func (s *DescribeFaqInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DescribeFaqInput) SetId(v string) *DescribeFaqInput { - s.Id = &v +// SetName sets the Name field's value. +func (s *DocumentRelevanceConfiguration) SetName(v string) *DocumentRelevanceConfiguration { + s.Name = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribeFaqInput) SetIndexId(v string) *DescribeFaqInput { - s.IndexId = &v +// SetRelevance sets the Relevance field's value. +func (s *DocumentRelevanceConfiguration) SetRelevance(v *Relevance) *DocumentRelevanceConfiguration { + s.Relevance = v return s } -type DescribeFaqOutput struct { - _ struct{} `type:"structure"` - - // The date and time that the FAQ was created. - CreatedAt *time.Time `type:"timestamp"` - - // The description of the FAQ that you provided when it was created. - Description *string `type:"string"` - - // If the Status field is FAILED, the ErrorMessage field contains the reason - // why the FAQ failed. - ErrorMessage *string `min:"1" type:"string"` - - // The file format used by the input files for the FAQ. - FileFormat *string `type:"string" enum:"FaqFileFormat"` - - // The identifier of the FAQ. - Id *string `min:"1" type:"string"` - - // The identifier of the index that contains the FAQ. - IndexId *string `min:"36" type:"string"` - - // The code for a language. This shows a supported language for the FAQ document. - // English is supported by default. For more information on supported languages, - // including their codes, see Adding documents in languages other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" type:"string"` - - // The name that you gave the FAQ when it was created. - Name *string `min:"1" type:"string"` - - // The Amazon Resource Name (ARN) of the role that provides access to the S3 - // bucket containing the input files for the FAQ. - RoleArn *string `min:"1" type:"string"` - - // Information required to find a specific file in an Amazon S3 bucket. - S3Path *S3Path `type:"structure"` - - // The status of the FAQ. It is ready to use when the status is ACTIVE. - Status *string `type:"string" enum:"FaqStatus"` +// Document metadata files that contain information such as the document access +// control information, source URI, document author, and custom attributes. +// Each metadata file contains metadata about a single document. +type DocumentsMetadataConfiguration struct { + _ struct{} `type:"structure"` - // The date and time that the FAQ was last updated. - UpdatedAt *time.Time `type:"timestamp"` + // A prefix used to filter metadata configuration files in the Amazon Web Services + // S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix + // to include only the desired metadata files. + S3Prefix *string `min:"1" type:"string"` } // String returns the string representation. @@ -9346,7 +13650,7 @@ type DescribeFaqOutput 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 DescribeFaqOutput) String() string { +func (s DocumentsMetadataConfiguration) String() string { return awsutil.Prettify(s) } @@ -9355,89 +13659,44 @@ func (s DescribeFaqOutput) 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 DescribeFaqOutput) GoString() string { +func (s DocumentsMetadataConfiguration) GoString() string { return s.String() } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput { - s.CreatedAt = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *DescribeFaqOutput) SetDescription(v string) *DescribeFaqOutput { - s.Description = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput { - s.ErrorMessage = &v - return s -} - -// SetFileFormat sets the FileFormat field's value. -func (s *DescribeFaqOutput) SetFileFormat(v string) *DescribeFaqOutput { - s.FileFormat = &v - return s -} - -// SetId sets the Id field's value. -func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput { - s.Id = &v - return s -} - -// SetIndexId sets the IndexId field's value. -func (s *DescribeFaqOutput) SetIndexId(v string) *DescribeFaqOutput { - s.IndexId = &v - return s -} - -// SetLanguageCode sets the LanguageCode field's value. -func (s *DescribeFaqOutput) SetLanguageCode(v string) *DescribeFaqOutput { - s.LanguageCode = &v - return s -} - -// SetName sets the Name field's value. -func (s *DescribeFaqOutput) SetName(v string) *DescribeFaqOutput { - s.Name = &v - return s -} - -// SetRoleArn sets the RoleArn field's value. -func (s *DescribeFaqOutput) SetRoleArn(v string) *DescribeFaqOutput { - s.RoleArn = &v - return s -} - -// SetS3Path sets the S3Path field's value. -func (s *DescribeFaqOutput) SetS3Path(v *S3Path) *DescribeFaqOutput { - s.S3Path = v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DocumentsMetadataConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentsMetadataConfiguration"} + if s.S3Prefix != nil && len(*s.S3Prefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3Prefix", 1)) + } -// SetStatus sets the Status field's value. -func (s *DescribeFaqOutput) SetStatus(v string) *DescribeFaqOutput { - s.Status = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput { - s.UpdatedAt = &v +// SetS3Prefix sets the S3Prefix field's value. +func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration { + s.S3Prefix = &v return s } -type DescribeIndexInput struct { +// Provides the configuration information of users or groups in your Amazon +// Web Services SSO identity source to grant access your Amazon Kendra experience. +type EntityConfiguration struct { _ struct{} `type:"structure"` - // The name of the index to describe. + // The identifier of a user or group in your Amazon Web Services SSO identity + // source. For example, a user ID could be an email. // - // Id is a required field - Id *string `min:"36" type:"string" required:"true"` + // EntityId is a required field + EntityId *string `min:"1" type:"string" required:"true"` + + // Specifies whether you are configuring a User or a Group. + // + // EntityType is a required field + EntityType *string `type:"string" required:"true" enum:"EntityType"` } // String returns the string representation. @@ -9445,7 +13704,7 @@ type DescribeIndexInput 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 DescribeIndexInput) String() string { +func (s EntityConfiguration) String() string { return awsutil.Prettify(s) } @@ -9454,18 +13713,21 @@ func (s DescribeIndexInput) 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 DescribeIndexInput) GoString() string { +func (s EntityConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeIndexInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeIndexInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) +func (s *EntityConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EntityConfiguration"} + if s.EntityId == nil { + invalidParams.Add(request.NewErrParamRequired("EntityId")) } - if s.Id != nil && len(*s.Id) < 36 { - invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + if s.EntityId != nil && len(*s.EntityId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityId", 1)) + } + if s.EntityType == nil { + invalidParams.Add(request.NewErrParamRequired("EntityType")) } if invalidParams.Len() > 0 { @@ -9474,73 +13736,56 @@ func (s *DescribeIndexInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *DescribeIndexInput) SetId(v string) *DescribeIndexInput { - s.Id = &v +// SetEntityId sets the EntityId field's value. +func (s *EntityConfiguration) SetEntityId(v string) *EntityConfiguration { + s.EntityId = &v return s } -type DescribeIndexOutput struct { - _ struct{} `type:"structure"` - - // For Enterprise edition indexes, you can choose to use additional capacity - // to meet the needs of your application. This contains the capacity units used - // for the index. A 0 for the query capacity or the storage capacity indicates - // that the index is using the default capacity for the index. - CapacityUnits *CapacityUnitsConfiguration `type:"structure"` - - // The Unix datetime that the index was created. - CreatedAt *time.Time `type:"timestamp"` - - // The description of the index. - Description *string `type:"string"` - - // Configuration settings for any metadata applied to the documents in the index. - DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"` - - // The Amazon Kendra edition used for the index. You decide the edition when - // you create the index. - Edition *string `type:"string" enum:"IndexEdition"` - - // When th eStatus field value is FAILED, the ErrorMessage field contains a - // message that explains why. - ErrorMessage *string `min:"1" type:"string"` - - // The name of the index. - Id *string `min:"36" type:"string"` - - // Provides information about the number of FAQ questions and answers and the - // number of text documents indexed. - IndexStatistics *IndexStatistics `type:"structure"` - - // The name of the index. - Name *string `min:"1" type:"string"` - - // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission - // to write to your Amazon Cloudwatch logs. - RoleArn *string `min:"1" type:"string"` +// SetEntityType sets the EntityType field's value. +func (s *EntityConfiguration) SetEntityType(v string) *EntityConfiguration { + s.EntityType = &v + return s +} - // The identifier of the KMScustomer master key (CMK) used to encrypt your data. - // Amazon Kendra doesn't support asymmetric CMKs. - ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` +// Information about the user entity. +type EntityDisplayData struct { + _ struct{} `type:"structure"` - // The current status of the index. When the value is ACTIVE, the index is ready - // for use. If the Status field value is FAILED, the ErrorMessage field contains - // a message that explains why. - Status *string `type:"string" enum:"IndexStatus"` + // The first name of the user. + // + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EntityDisplayData's + // String and GoString methods. + FirstName *string `min:"1" type:"string" sensitive:"true"` - // The Unix datetime that the index was last updated. - UpdatedAt *time.Time `type:"timestamp"` + // The name of the group. + // + // GroupName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EntityDisplayData's + // String and GoString methods. + GroupName *string `min:"1" type:"string" sensitive:"true"` - // The user context policy for the Amazon Kendra index. - UserContextPolicy *string `type:"string" enum:"UserContextPolicy"` + // The user name of the user. + // + // IdentifiedUserName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EntityDisplayData's + // String and GoString methods. + IdentifiedUserName *string `min:"1" type:"string" sensitive:"true"` - // Shows whether you have enabled the configuration for fetching access levels - // of groups and users from an AWS Single Sign-On identity source. - UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"` + // The last name of the user. + // + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EntityDisplayData's + // String and GoString methods. + LastName *string `min:"1" type:"string" sensitive:"true"` - // The user token configuration for the Amazon Kendra index. - UserTokenConfigurations []*UserTokenConfiguration `type:"list"` + // The name of the user. + // + // UserName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EntityDisplayData's + // String and GoString methods. + UserName *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -9548,7 +13793,7 @@ type DescribeIndexOutput 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 DescribeIndexOutput) String() string { +func (s EntityDisplayData) String() string { return awsutil.Prettify(s) } @@ -9557,124 +13802,125 @@ func (s DescribeIndexOutput) 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 DescribeIndexOutput) GoString() string { +func (s EntityDisplayData) GoString() string { return s.String() } -// SetCapacityUnits sets the CapacityUnits field's value. -func (s *DescribeIndexOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeIndexOutput { - s.CapacityUnits = v - return s -} - -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput { - s.CreatedAt = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *DescribeIndexOutput) SetDescription(v string) *DescribeIndexOutput { - s.Description = &v +// SetFirstName sets the FirstName field's value. +func (s *EntityDisplayData) SetFirstName(v string) *EntityDisplayData { + s.FirstName = &v return s } -// SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value. -func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput { - s.DocumentMetadataConfigurations = v +// SetGroupName sets the GroupName field's value. +func (s *EntityDisplayData) SetGroupName(v string) *EntityDisplayData { + s.GroupName = &v return s } -// SetEdition sets the Edition field's value. -func (s *DescribeIndexOutput) SetEdition(v string) *DescribeIndexOutput { - s.Edition = &v +// SetIdentifiedUserName sets the IdentifiedUserName field's value. +func (s *EntityDisplayData) SetIdentifiedUserName(v string) *EntityDisplayData { + s.IdentifiedUserName = &v return s } -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DescribeIndexOutput) SetErrorMessage(v string) *DescribeIndexOutput { - s.ErrorMessage = &v +// SetLastName sets the LastName field's value. +func (s *EntityDisplayData) SetLastName(v string) *EntityDisplayData { + s.LastName = &v return s } -// SetId sets the Id field's value. -func (s *DescribeIndexOutput) SetId(v string) *DescribeIndexOutput { - s.Id = &v +// SetUserName sets the UserName field's value. +func (s *EntityDisplayData) SetUserName(v string) *EntityDisplayData { + s.UserName = &v return s } -// SetIndexStatistics sets the IndexStatistics field's value. -func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput { - s.IndexStatistics = v - return s -} +// Provides the configuration information of users or groups in your Amazon +// Web Services SSO identity source for access to your Amazon Kendra experience. +// Specific permissions are defined for each user or group once they are granted +// access to your Amazon Kendra experience. +type EntityPersonaConfiguration struct { + _ struct{} `type:"structure"` -// SetName sets the Name field's value. -func (s *DescribeIndexOutput) SetName(v string) *DescribeIndexOutput { - s.Name = &v - return s -} + // The identifier of a user or group in your Amazon Web Services SSO identity + // source. For example, a user ID could be an email. + // + // EntityId is a required field + EntityId *string `min:"1" type:"string" required:"true"` -// SetRoleArn sets the RoleArn field's value. -func (s *DescribeIndexOutput) SetRoleArn(v string) *DescribeIndexOutput { - s.RoleArn = &v - return s + // The persona that defines the specific permissions of the user or group in + // your Amazon Web Services SSO identity source. The available personas or access + // roles are Owner and Viewer. For more information on these personas, see Providing + // access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + // + // Persona is a required field + Persona *string `type:"string" required:"true" enum:"Persona"` } -// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. -func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput { - s.ServerSideEncryptionConfiguration = 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 EntityPersonaConfiguration) String() string { + return awsutil.Prettify(s) } -// SetStatus sets the Status field's value. -func (s *DescribeIndexOutput) SetStatus(v string) *DescribeIndexOutput { - 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 EntityPersonaConfiguration) GoString() string { + return s.String() } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput { - s.UpdatedAt = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *EntityPersonaConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EntityPersonaConfiguration"} + if s.EntityId == nil { + invalidParams.Add(request.NewErrParamRequired("EntityId")) + } + if s.EntityId != nil && len(*s.EntityId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityId", 1)) + } + if s.Persona == nil { + invalidParams.Add(request.NewErrParamRequired("Persona")) + } -// SetUserContextPolicy sets the UserContextPolicy field's value. -func (s *DescribeIndexOutput) SetUserContextPolicy(v string) *DescribeIndexOutput { - s.UserContextPolicy = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value. -func (s *DescribeIndexOutput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *DescribeIndexOutput { - s.UserGroupResolutionConfiguration = v +// SetEntityId sets the EntityId field's value. +func (s *EntityPersonaConfiguration) SetEntityId(v string) *EntityPersonaConfiguration { + s.EntityId = &v return s } -// SetUserTokenConfigurations sets the UserTokenConfigurations field's value. -func (s *DescribeIndexOutput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *DescribeIndexOutput { - s.UserTokenConfigurations = v +// SetPersona sets the Persona field's value. +func (s *EntityPersonaConfiguration) SetPersona(v string) *EntityPersonaConfiguration { + s.Persona = &v return s } -type DescribePrincipalMappingInput struct { +// Specifies the configuration information for your Amazon Kendra experience. +// This includes the data source IDs and/or FAQ IDs, and user or group information +// to grant access to your Amazon Kendra experience. +type ExperienceConfiguration struct { _ struct{} `type:"structure"` - // The identifier of the data source to check the processing of PUT and DELETE - // actions for mapping users to their groups. - DataSourceId *string `min:"1" type:"string"` - - // The identifier of the group required to check the processing of PUT and DELETE - // actions for mapping users to their groups. - // - // GroupId is a required field - GroupId *string `min:"1" type:"string" required:"true"` + // The identifiers of your data sources and FAQs. Or, you can specify that you + // want to use documents indexed via the BatchPutDocument operation. This is + // the content you want to use for your Amazon Kendra experience. + ContentSourceConfiguration *ContentSourceConfiguration `type:"structure"` - // The identifier of the index required to check the processing of PUT and DELETE - // actions for mapping users to their groups. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // The Amazon Web Services SSO field name that contains the identifiers of your + // users, such as their emails. + UserIdentityConfiguration *UserIdentityConfiguration `type:"structure"` } // String returns the string representation. @@ -9682,7 +13928,7 @@ type DescribePrincipalMappingInput 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 DescribePrincipalMappingInput) String() string { +func (s ExperienceConfiguration) String() string { return awsutil.Prettify(s) } @@ -9691,27 +13937,22 @@ func (s DescribePrincipalMappingInput) 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 DescribePrincipalMappingInput) GoString() string { +func (s ExperienceConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribePrincipalMappingInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribePrincipalMappingInput"} - if s.DataSourceId != nil && len(*s.DataSourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSourceId", 1)) - } - if s.GroupId == nil { - invalidParams.Add(request.NewErrParamRequired("GroupId")) - } - if s.GroupId != nil && len(*s.GroupId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GroupId", 1)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) +func (s *ExperienceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ExperienceConfiguration"} + if s.ContentSourceConfiguration != nil { + if err := s.ContentSourceConfiguration.Validate(); err != nil { + invalidParams.AddNested("ContentSourceConfiguration", err.(request.ErrInvalidParams)) + } } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + if s.UserIdentityConfiguration != nil { + if err := s.UserIdentityConfiguration.Validate(); err != nil { + invalidParams.AddNested("UserIdentityConfiguration", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -9720,54 +13961,30 @@ func (s *DescribePrincipalMappingInput) Validate() error { return nil } -// SetDataSourceId sets the DataSourceId field's value. -func (s *DescribePrincipalMappingInput) SetDataSourceId(v string) *DescribePrincipalMappingInput { - s.DataSourceId = &v - return s -} - -// SetGroupId sets the GroupId field's value. -func (s *DescribePrincipalMappingInput) SetGroupId(v string) *DescribePrincipalMappingInput { - s.GroupId = &v +// SetContentSourceConfiguration sets the ContentSourceConfiguration field's value. +func (s *ExperienceConfiguration) SetContentSourceConfiguration(v *ContentSourceConfiguration) *ExperienceConfiguration { + s.ContentSourceConfiguration = v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribePrincipalMappingInput) SetIndexId(v string) *DescribePrincipalMappingInput { - s.IndexId = &v +// SetUserIdentityConfiguration sets the UserIdentityConfiguration field's value. +func (s *ExperienceConfiguration) SetUserIdentityConfiguration(v *UserIdentityConfiguration) *ExperienceConfiguration { + s.UserIdentityConfiguration = v return s } -type DescribePrincipalMappingOutput struct { +// Provides the configuration information of the endpoint for your Amazon Kendra +// experience. +type ExperienceEndpoint struct { _ struct{} `type:"structure"` - // Shows the identifier of the data source to see information on the processing - // of PUT and DELETE actions for mapping users to their groups. - DataSourceId *string `min:"1" type:"string"` - - // Shows the identifier of the group to see information on the processing of - // PUT and DELETE actions for mapping users to their groups. - GroupId *string `min:"1" type:"string"` - - // Shows the following information on the processing of PUT and DELETE actions - // for mapping users to their groups: - // - // * Status – the status can be either PROCESSING, SUCCEEDED, DELETING, - // DELETED, or FAILED. - // - // * Last updated – the last date-time an action was updated. - // - // * Received – the last date-time an action was received or submitted. - // - // * Ordering ID – the latest action that should process and apply after - // other actions. - // - // * Failure reason – the reason an action could not be processed. - GroupOrderingIdSummaries []*GroupOrderingIdSummary `type:"list"` + // The endpoint of your Amazon Kendra experience. + Endpoint *string `min:"1" type:"string"` - // Shows the identifier of the index to see information on the processing of - // PUT and DELETE actions for mapping users to their groups. - IndexId *string `min:"36" type:"string"` + // The type of endpoint for your Amazon Kendra experience. The type currently + // available is HOME, which is a unique and fully hosted URL to the home page + // of your Amazon Kendra experience. + EndpointType *string `type:"string" enum:"EndpointType"` } // String returns the string representation. @@ -9775,7 +13992,7 @@ type DescribePrincipalMappingOutput 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 DescribePrincipalMappingOutput) String() string { +func (s ExperienceEndpoint) String() string { return awsutil.Prettify(s) } @@ -9784,46 +14001,39 @@ func (s DescribePrincipalMappingOutput) 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 DescribePrincipalMappingOutput) GoString() string { +func (s ExperienceEndpoint) GoString() string { return s.String() } -// SetDataSourceId sets the DataSourceId field's value. -func (s *DescribePrincipalMappingOutput) SetDataSourceId(v string) *DescribePrincipalMappingOutput { - s.DataSourceId = &v - return s -} - -// SetGroupId sets the GroupId field's value. -func (s *DescribePrincipalMappingOutput) SetGroupId(v string) *DescribePrincipalMappingOutput { - s.GroupId = &v - return s -} - -// SetGroupOrderingIdSummaries sets the GroupOrderingIdSummaries field's value. -func (s *DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries(v []*GroupOrderingIdSummary) *DescribePrincipalMappingOutput { - s.GroupOrderingIdSummaries = v +// SetEndpoint sets the Endpoint field's value. +func (s *ExperienceEndpoint) SetEndpoint(v string) *ExperienceEndpoint { + s.Endpoint = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribePrincipalMappingOutput) SetIndexId(v string) *DescribePrincipalMappingOutput { - s.IndexId = &v +// SetEndpointType sets the EndpointType field's value. +func (s *ExperienceEndpoint) SetEndpointType(v string) *ExperienceEndpoint { + s.EndpointType = &v return s } -type DescribeQuerySuggestionsBlockListInput struct { +// Summary information for users or groups in your Amazon Web Services SSO identity +// source with granted access to your Amazon Kendra experience. You can create +// an Amazon Kendra experience such as a search application. For more information +// on creating a search application experience, see Building a search experience +// with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +type ExperienceEntitiesSummary struct { _ struct{} `type:"structure"` - // The unique identifier of the block list. - // - // Id is a required field - Id *string `min:"36" type:"string" required:"true"` + // Information about the user entity. + DisplayData *EntityDisplayData `type:"structure"` - // The identifier of the index for the block list. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // The identifier of a user or group in your Amazon Web Services SSO identity + // source. For example, a user ID could be an email. + EntityId *string `min:"1" type:"string"` + + // Shows the type as User or Group. + EntityType *string `type:"string" enum:"EntityType"` } // String returns the string representation. @@ -9831,7 +14041,7 @@ type DescribeQuerySuggestionsBlockListInput 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 DescribeQuerySuggestionsBlockListInput) String() string { +func (s ExperienceEntitiesSummary) String() string { return awsutil.Prettify(s) } @@ -9840,93 +14050,50 @@ func (s DescribeQuerySuggestionsBlockListInput) 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 DescribeQuerySuggestionsBlockListInput) GoString() string { +func (s ExperienceEntitiesSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeQuerySuggestionsBlockListInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeQuerySuggestionsBlockListInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) - } - if s.Id != nil && len(*s.Id) < 36 { - invalidParams.Add(request.NewErrParamMinLen("Id", 36)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDisplayData sets the DisplayData field's value. +func (s *ExperienceEntitiesSummary) SetDisplayData(v *EntityDisplayData) *ExperienceEntitiesSummary { + s.DisplayData = v + return s } -// SetId sets the Id field's value. -func (s *DescribeQuerySuggestionsBlockListInput) SetId(v string) *DescribeQuerySuggestionsBlockListInput { - s.Id = &v +// SetEntityId sets the EntityId field's value. +func (s *ExperienceEntitiesSummary) SetEntityId(v string) *ExperienceEntitiesSummary { + s.EntityId = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribeQuerySuggestionsBlockListInput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListInput { - s.IndexId = &v +// SetEntityType sets the EntityType field's value. +func (s *ExperienceEntitiesSummary) SetEntityType(v string) *ExperienceEntitiesSummary { + s.EntityType = &v return s } -type DescribeQuerySuggestionsBlockListOutput struct { +// Summary information for your Amazon Kendra experience. You can create an +// Amazon Kendra experience such as a search application. For more information +// on creating a search application experience, see Building a search experience +// with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +type ExperiencesSummary struct { _ struct{} `type:"structure"` - // Shows the date-time a block list for query suggestions was created. + // The date-time your Amazon Kendra experience was created. CreatedAt *time.Time `type:"timestamp"` - // Shows the description for the block list. - Description *string `type:"string"` - - // Shows the error message with details when there are issues in processing - // the block list. - ErrorMessage *string `min:"1" type:"string"` - - // Shows the current size of the block list text file in S3. - FileSizeBytes *int64 `type:"long"` - - // Shows the unique identifier of the block list. - Id *string `min:"36" type:"string"` - - // Shows the identifier of the index for the block list. - IndexId *string `min:"36" type:"string"` + // The endpoint URLs for your Amazon Kendra experiences. The URLs are unique + // and fully hosted by Amazon Web Services. + Endpoints []*ExperienceEndpoint `min:"1" type:"list"` - // Shows the current number of valid, non-empty words or phrases in the block - // list text file. - ItemCount *int64 `type:"integer"` + // The identifier of your Amazon Kendra experience. + Id *string `min:"1" type:"string"` - // Shows the name of the block list. + // The name of your Amazon Kendra experience. Name *string `min:"1" type:"string"` - // Shows the current IAM (Identity and Access Management) role used by Amazon - // Kendra to access the block list text file in S3. - // - // The role needs S3 read permissions to your file in S3 and needs to give STS - // (Security Token Service) assume role permissions to Amazon Kendra. - RoleArn *string `min:"1" type:"string"` - - // Shows the current S3 path to your block list text file in your S3 bucket. - // - // Each block word or phrase should be on a separate line in a text file. - // - // For information on the current quota limits for block lists, see Quotas for - // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). - SourceS3Path *S3Path `type:"structure"` - - // Shows whether the current status of the block list is ACTIVE or INACTIVE. - Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"` - - // Shows the date-time a block list for query suggestions was last updated. - UpdatedAt *time.Time `type:"timestamp"` + // The processing status of your Amazon Kendra experience. + Status *string `type:"string" enum:"ExperienceStatus"` } // String returns the string representation. @@ -9934,7 +14101,7 @@ type DescribeQuerySuggestionsBlockListOutput 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 DescribeQuerySuggestionsBlockListOutput) String() string { +func (s ExperiencesSummary) String() string { return awsutil.Prettify(s) } @@ -9943,90 +14110,46 @@ func (s DescribeQuerySuggestionsBlockListOutput) 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 DescribeQuerySuggestionsBlockListOutput) GoString() string { +func (s ExperiencesSummary) GoString() string { return s.String() } // SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetCreatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput { +func (s *ExperiencesSummary) SetCreatedAt(v time.Time) *ExperiencesSummary { s.CreatedAt = &v return s } -// SetDescription sets the Description field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetDescription(v string) *DescribeQuerySuggestionsBlockListOutput { - s.Description = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetErrorMessage(v string) *DescribeQuerySuggestionsBlockListOutput { - s.ErrorMessage = &v - return s -} - -// SetFileSizeBytes sets the FileSizeBytes field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes(v int64) *DescribeQuerySuggestionsBlockListOutput { - s.FileSizeBytes = &v +// SetEndpoints sets the Endpoints field's value. +func (s *ExperiencesSummary) SetEndpoints(v []*ExperienceEndpoint) *ExperiencesSummary { + s.Endpoints = v return s } // SetId sets the Id field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetId(v string) *DescribeQuerySuggestionsBlockListOutput { +func (s *ExperiencesSummary) SetId(v string) *ExperiencesSummary { s.Id = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListOutput { - s.IndexId = &v - return s -} - -// SetItemCount sets the ItemCount field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetItemCount(v int64) *DescribeQuerySuggestionsBlockListOutput { - s.ItemCount = &v - return s -} - // SetName sets the Name field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetName(v string) *DescribeQuerySuggestionsBlockListOutput { +func (s *ExperiencesSummary) SetName(v string) *ExperiencesSummary { s.Name = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetRoleArn(v string) *DescribeQuerySuggestionsBlockListOutput { - s.RoleArn = &v - return s -} - -// SetSourceS3Path sets the SourceS3Path field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path(v *S3Path) *DescribeQuerySuggestionsBlockListOutput { - s.SourceS3Path = v - return s -} - // SetStatus sets the Status field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetStatus(v string) *DescribeQuerySuggestionsBlockListOutput { +func (s *ExperiencesSummary) SetStatus(v string) *ExperiencesSummary { s.Status = &v return s } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput { - s.UpdatedAt = &v - return s -} - -type DescribeQuerySuggestionsConfigInput struct { +// Information about a document attribute +type Facet struct { _ struct{} `type:"structure"` - // The identifier of the index you want to describe query suggestions settings - // for. - // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // The unique key for the document attribute. + DocumentAttributeKey *string `min:"1" type:"string"` } // String returns the string representation. @@ -10034,7 +14157,7 @@ type DescribeQuerySuggestionsConfigInput 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 DescribeQuerySuggestionsConfigInput) String() string { +func (s Facet) String() string { return awsutil.Prettify(s) } @@ -10042,19 +14165,16 @@ func (s DescribeQuerySuggestionsConfigInput) 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 DescribeQuerySuggestionsConfigInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeQuerySuggestionsConfigInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeQuerySuggestionsConfigInput"} - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) +// value will be replaced with "sensitive". +func (s Facet) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Facet) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Facet"} + if s.DocumentAttributeKey != nil && len(*s.DocumentAttributeKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentAttributeKey", 1)) } if invalidParams.Len() > 0 { @@ -10063,63 +14183,27 @@ func (s *DescribeQuerySuggestionsConfigInput) Validate() error { return nil } -// SetIndexId sets the IndexId field's value. -func (s *DescribeQuerySuggestionsConfigInput) SetIndexId(v string) *DescribeQuerySuggestionsConfigInput { - s.IndexId = &v +// SetDocumentAttributeKey sets the DocumentAttributeKey field's value. +func (s *Facet) SetDocumentAttributeKey(v string) *Facet { + s.DocumentAttributeKey = &v return s } -type DescribeQuerySuggestionsConfigOutput struct { +// The facet values for the documents in the response. +type FacetResult struct { _ struct{} `type:"structure"` - // Shows whether Amazon Kendra uses all queries or only uses queries that include - // user information to generate query suggestions. - IncludeQueriesWithoutUserInformation *bool `type:"boolean"` - - // Shows the date-time query suggestions for an index was last cleared. - // - // After you clear suggestions, Amazon Kendra learns new suggestions based on - // new queries added to the query log from the time you cleared suggestions. - // Amazon Kendra only considers re-occurences of a query from the time you cleared - // suggestions. - LastClearTime *time.Time `type:"timestamp"` - - // Shows the date-time query suggestions for an index was last updated. - LastSuggestionsBuildTime *time.Time `type:"timestamp"` - - // Shows the minimum number of unique users who must search a query in order - // for the query to be eligible to suggest to your users. - MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"` - - // Shows the minimum number of times a query must be searched in order for the - // query to be eligible to suggest to your users. - MinimumQueryCount *int64 `min:"1" type:"integer"` - - // Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY - // mode. - // - // By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off - // query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) - // operation. - Mode *string `type:"string" enum:"Mode"` - - // Shows how recent your queries are in your query log time window (in days). - QueryLogLookBackWindowInDays *int64 `type:"integer"` + // The key for the facet values. This is the same as the DocumentAttributeKey + // provided in the query. + DocumentAttributeKey *string `min:"1" type:"string"` - // Shows whether the status of query suggestions settings is currently Active - // or Updating. - // - // Active means the current settings apply and Updating means your changed settings - // are in the process of applying. - Status *string `type:"string" enum:"QuerySuggestionsStatus"` + // An array of key/value pairs, where the key is the value of the attribute + // and the count is the number of documents that share the key value. + DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"` - // Shows the current total count of query suggestions for an index. - // - // This count can change when you update your query suggestions settings, if - // you filter out certain queries from suggestions using a block list, and as - // the query log accumulates more queries for Amazon Kendra to learn from. - TotalSuggestionsCount *int64 `type:"integer"` + // The data type of the facet value. This is the same as the type defined for + // the index field when it was created. + DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"` } // String returns the string representation. @@ -10127,7 +14211,7 @@ type DescribeQuerySuggestionsConfigOutput 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 DescribeQuerySuggestionsConfigOutput) String() string { +func (s FacetResult) String() string { return awsutil.Prettify(s) } @@ -10136,76 +14220,81 @@ func (s DescribeQuerySuggestionsConfigOutput) 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 DescribeQuerySuggestionsConfigOutput) GoString() string { +func (s FacetResult) GoString() string { return s.String() } -// SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation(v bool) *DescribeQuerySuggestionsConfigOutput { - s.IncludeQueriesWithoutUserInformation = &v +// SetDocumentAttributeKey sets the DocumentAttributeKey field's value. +func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult { + s.DocumentAttributeKey = &v return s } -// SetLastClearTime sets the LastClearTime field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetLastClearTime(v time.Time) *DescribeQuerySuggestionsConfigOutput { - s.LastClearTime = &v +// SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value. +func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult { + s.DocumentAttributeValueCountPairs = v return s } -// SetLastSuggestionsBuildTime sets the LastSuggestionsBuildTime field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime(v time.Time) *DescribeQuerySuggestionsConfigOutput { - s.LastSuggestionsBuildTime = &v +// SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value. +func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult { + s.DocumentAttributeValueType = &v return s } -// SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers(v int64) *DescribeQuerySuggestionsConfigOutput { - s.MinimumNumberOfQueryingUsers = &v - return s -} +// Information on the users or groups in your Amazon Web Services SSO identity +// source that failed to properly configure with your Amazon Kendra experience. +type FailedEntity struct { + _ struct{} `type:"structure"` -// SetMinimumQueryCount sets the MinimumQueryCount field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount(v int64) *DescribeQuerySuggestionsConfigOutput { - s.MinimumQueryCount = &v - return s + // The identifier of the user or group in your Amazon Web Services SSO identity + // source. For example, a user ID could be an email. + EntityId *string `min:"1" type:"string"` + + // The reason the user or group in your Amazon Web Services SSO identity source + // failed to properly configure with your Amazon Kendra experience. + ErrorMessage *string `min:"1" type:"string"` } -// SetMode sets the Mode field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetMode(v string) *DescribeQuerySuggestionsConfigOutput { - s.Mode = &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 FailedEntity) String() string { + return awsutil.Prettify(s) } -// SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays(v int64) *DescribeQuerySuggestionsConfigOutput { - s.QueryLogLookBackWindowInDays = &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 FailedEntity) GoString() string { + return s.String() } -// SetStatus sets the Status field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetStatus(v string) *DescribeQuerySuggestionsConfigOutput { - s.Status = &v +// SetEntityId sets the EntityId field's value. +func (s *FailedEntity) SetEntityId(v string) *FailedEntity { + s.EntityId = &v return s } -// SetTotalSuggestionsCount sets the TotalSuggestionsCount field's value. -func (s *DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount(v int64) *DescribeQuerySuggestionsConfigOutput { - s.TotalSuggestionsCount = &v +// SetErrorMessage sets the ErrorMessage field's value. +func (s *FailedEntity) SetErrorMessage(v string) *FailedEntity { + s.ErrorMessage = &v return s } -type DescribeThesaurusInput struct { +// Provides statistical information about the FAQ questions and answers contained +// in an index. +type FaqStatistics struct { _ struct{} `type:"structure"` - // The identifier of the thesaurus to describe. - // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` - - // The identifier of the index associated with the thesaurus to describe. + // The total number of FAQ questions and answers contained in the index. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // IndexedQuestionAnswersCount is a required field + IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"` } // String returns the string representation. @@ -10213,7 +14302,7 @@ type DescribeThesaurusInput 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 DescribeThesaurusInput) String() string { +func (s FaqStatistics) String() string { return awsutil.Prettify(s) } @@ -10222,92 +14311,44 @@ func (s DescribeThesaurusInput) 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 DescribeThesaurusInput) GoString() string { +func (s FaqStatistics) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeThesaurusInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeThesaurusInput"} - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) - } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) - } - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetId sets the Id field's value. -func (s *DescribeThesaurusInput) SetId(v string) *DescribeThesaurusInput { - s.Id = &v - return s -} - -// SetIndexId sets the IndexId field's value. -func (s *DescribeThesaurusInput) SetIndexId(v string) *DescribeThesaurusInput { - s.IndexId = &v +// SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value. +func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics { + s.IndexedQuestionAnswersCount = &v return s } -type DescribeThesaurusOutput struct { +// Provides information about a frequently asked questions and answer contained +// in an index. +type FaqSummary struct { _ struct{} `type:"structure"` - // The Unix datetime that the thesaurus was created. + // The UNIX datetime that the FAQ was added to the index. CreatedAt *time.Time `type:"timestamp"` - // The thesaurus description. - Description *string `type:"string"` - - // When the Status field value is FAILED, the ErrorMessage field provides more - // information. - ErrorMessage *string `min:"1" type:"string"` - - // The size of the thesaurus file in bytes. - FileSizeBytes *int64 `type:"long"` + // The file type used to create the FAQ. + FileFormat *string `type:"string" enum:"FaqFileFormat"` - // The identifier of the thesaurus. + // The unique identifier of the FAQ. Id *string `min:"1" type:"string"` - // The identifier of the index associated with the thesaurus to describe. - IndexId *string `min:"36" type:"string"` + // The code for a language. This shows a supported language for the FAQ document + // as part of the summary information for FAQs. English is supported by default. + // For more information on supported languages, including their codes, see Adding + // documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + LanguageCode *string `min:"2" type:"string"` - // The thesaurus name. + // The name that you assigned the FAQ when you created or updated the FAQ. Name *string `min:"1" type:"string"` - // An AWS Identity and Access Management (IAM) role that gives Amazon Kendra - // permissions to access thesaurus file specified in SourceS3Path. - RoleArn *string `min:"1" type:"string"` - - // Information required to find a specific file in an Amazon S3 bucket. - SourceS3Path *S3Path `type:"structure"` - - // The current status of the thesaurus. When the value is ACTIVE, queries are - // able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage - // field provides more information. - // - // If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could - // not ingest the new thesaurus file. The old thesaurus file is still active. - Status *string `type:"string" enum:"ThesaurusStatus"` - - // The number of synonym rules in the thesaurus file. - SynonymRuleCount *int64 `type:"long"` - - // The number of unique terms in the thesaurus file. For example, the synonyms - // a,b,c and a=>d, the term count would be 4. - TermCount *int64 `type:"long"` + // The current status of the FAQ. When the status is ACTIVE the FAQ is ready + // for use. + Status *string `type:"string" enum:"FaqStatus"` - // The Unix datetime that the thesaurus was last updated. + // The UNIX datetime that the FAQ was last updated. UpdatedAt *time.Time `type:"timestamp"` } @@ -10316,7 +14357,7 @@ type DescribeThesaurusOutput 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 DescribeThesaurusOutput) String() string { +func (s FaqSummary) String() string { return awsutil.Prettify(s) } @@ -10325,129 +14366,74 @@ func (s DescribeThesaurusOutput) 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 DescribeThesaurusOutput) GoString() string { +func (s FaqSummary) GoString() string { return s.String() } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeThesaurusOutput) SetCreatedAt(v time.Time) *DescribeThesaurusOutput { - s.CreatedAt = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *DescribeThesaurusOutput) SetDescription(v string) *DescribeThesaurusOutput { - s.Description = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DescribeThesaurusOutput) SetErrorMessage(v string) *DescribeThesaurusOutput { - s.ErrorMessage = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary { + s.CreatedAt = &v return s } -// SetFileSizeBytes sets the FileSizeBytes field's value. -func (s *DescribeThesaurusOutput) SetFileSizeBytes(v int64) *DescribeThesaurusOutput { - s.FileSizeBytes = &v +// SetFileFormat sets the FileFormat field's value. +func (s *FaqSummary) SetFileFormat(v string) *FaqSummary { + s.FileFormat = &v return s } // SetId sets the Id field's value. -func (s *DescribeThesaurusOutput) SetId(v string) *DescribeThesaurusOutput { +func (s *FaqSummary) SetId(v string) *FaqSummary { s.Id = &v return s } -// SetIndexId sets the IndexId field's value. -func (s *DescribeThesaurusOutput) SetIndexId(v string) *DescribeThesaurusOutput { - s.IndexId = &v +// SetLanguageCode sets the LanguageCode field's value. +func (s *FaqSummary) SetLanguageCode(v string) *FaqSummary { + s.LanguageCode = &v return s } // SetName sets the Name field's value. -func (s *DescribeThesaurusOutput) SetName(v string) *DescribeThesaurusOutput { +func (s *FaqSummary) SetName(v string) *FaqSummary { s.Name = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *DescribeThesaurusOutput) SetRoleArn(v string) *DescribeThesaurusOutput { - s.RoleArn = &v - return s -} - -// SetSourceS3Path sets the SourceS3Path field's value. -func (s *DescribeThesaurusOutput) SetSourceS3Path(v *S3Path) *DescribeThesaurusOutput { - s.SourceS3Path = v - return s -} - // SetStatus sets the Status field's value. -func (s *DescribeThesaurusOutput) SetStatus(v string) *DescribeThesaurusOutput { +func (s *FaqSummary) SetStatus(v string) *FaqSummary { s.Status = &v return s } -// SetSynonymRuleCount sets the SynonymRuleCount field's value. -func (s *DescribeThesaurusOutput) SetSynonymRuleCount(v int64) *DescribeThesaurusOutput { - s.SynonymRuleCount = &v - return s -} - -// SetTermCount sets the TermCount field's value. -func (s *DescribeThesaurusOutput) SetTermCount(v int64) *DescribeThesaurusOutput { - s.TermCount = &v - return s -} - // SetUpdatedAt sets the UpdatedAt field's value. -func (s *DescribeThesaurusOutput) SetUpdatedAt(v time.Time) *DescribeThesaurusOutput { +func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary { s.UpdatedAt = &v return s } -// A document in an index. -type Document struct { +type GetQuerySuggestionsInput struct { _ struct{} `type:"structure"` - // Information on user and group access rights, which is used for user context - // filtering. - AccessControlList []*Principal `type:"list"` - - // Custom attributes to apply to the document. Use the custom attributes to - // provide additional information for searching, to provide facets for refining - // searches, and to provide additional information in the query response. - Attributes []*DocumentAttribute `type:"list"` - - // The contents of the document. + // The identifier of the index you want to get query suggestions from. // - // Documents passed to the Blob parameter must be base64 encoded. Your code - // might not need to encode the document file bytes if you're using an Amazon - // Web Services SDK to call Amazon Kendra operations. If you are calling the - // Amazon Kendra endpoint directly using REST, you must base64 encode the contents - // before sending. - // Blob is automatically base64 encoded/decoded by the SDK. - Blob []byte `type:"blob"` - - // The file type of the document in the Blob field. - ContentType *string `type:"string" enum:"ContentType"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) - // lists that define the hierarchy for which documents users should have access - // to. - HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"` + // The maximum number of query suggestions you want to show to your users. + MaxSuggestionsCount *int64 `type:"integer"` - // A unique identifier of the document in the index. + // The text of a user's query to generate query suggestions. // - // Id is a required field - Id *string `min:"1" type:"string" required:"true"` - - // Information required to find a specific file in an Amazon S3 bucket. - S3Path *S3Path `type:"structure"` - - // The title of the document. - Title *string `type:"string"` + // A query is suggested if the query prefix matches what a user starts to type + // as their query. + // + // Amazon Kendra does not show any suggestions if a user types fewer than two + // characters or more than 60 characters. A query must also have at least one + // search result and contain at least one word of more than four characters. + // + // QueryText is a required field + QueryText *string `type:"string" required:"true"` } // String returns the string representation. @@ -10455,7 +14441,7 @@ type Document 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 Document) String() string { +func (s GetQuerySuggestionsInput) String() string { return awsutil.Prettify(s) } @@ -10464,56 +14450,21 @@ func (s Document) 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 Document) GoString() string { +func (s GetQuerySuggestionsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *Document) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Document"} - if s.HierarchicalAccessControlList != nil && len(s.HierarchicalAccessControlList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("HierarchicalAccessControlList", 1)) - } - if s.Id == nil { - invalidParams.Add(request.NewErrParamRequired("Id")) - } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) - } - if s.AccessControlList != nil { - for i, v := range s.AccessControlList { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AccessControlList", i), err.(request.ErrInvalidParams)) - } - } - } - 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)) - } - } +func (s *GetQuerySuggestionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetQuerySuggestionsInput"} + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.HierarchicalAccessControlList != nil { - for i, v := range s.HierarchicalAccessControlList { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "HierarchicalAccessControlList", i), err.(request.ErrInvalidParams)) - } - } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.S3Path != nil { - if err := s.S3Path.Validate(); err != nil { - invalidParams.AddNested("S3Path", err.(request.ErrInvalidParams)) - } + if s.QueryText == nil { + invalidParams.Add(request.NewErrParamRequired("QueryText")) } if invalidParams.Len() > 0 { @@ -10522,67 +14473,32 @@ func (s *Document) Validate() error { return nil } -// SetAccessControlList sets the AccessControlList field's value. -func (s *Document) SetAccessControlList(v []*Principal) *Document { - s.AccessControlList = v - return s -} - -// SetAttributes sets the Attributes field's value. -func (s *Document) SetAttributes(v []*DocumentAttribute) *Document { - s.Attributes = v - return s -} - -// SetBlob sets the Blob field's value. -func (s *Document) SetBlob(v []byte) *Document { - s.Blob = v - return s -} - -// SetContentType sets the ContentType field's value. -func (s *Document) SetContentType(v string) *Document { - s.ContentType = &v - return s -} - -// SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value. -func (s *Document) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *Document { - s.HierarchicalAccessControlList = v - return s -} - -// SetId sets the Id field's value. -func (s *Document) SetId(v string) *Document { - s.Id = &v +// SetIndexId sets the IndexId field's value. +func (s *GetQuerySuggestionsInput) SetIndexId(v string) *GetQuerySuggestionsInput { + s.IndexId = &v return s } -// SetS3Path sets the S3Path field's value. -func (s *Document) SetS3Path(v *S3Path) *Document { - s.S3Path = v +// SetMaxSuggestionsCount sets the MaxSuggestionsCount field's value. +func (s *GetQuerySuggestionsInput) SetMaxSuggestionsCount(v int64) *GetQuerySuggestionsInput { + s.MaxSuggestionsCount = &v return s } -// SetTitle sets the Title field's value. -func (s *Document) SetTitle(v string) *Document { - s.Title = &v +// SetQueryText sets the QueryText field's value. +func (s *GetQuerySuggestionsInput) SetQueryText(v string) *GetQuerySuggestionsInput { + s.QueryText = &v return s } -// A custom attribute value assigned to a document. -type DocumentAttribute struct { +type GetQuerySuggestionsOutput struct { _ struct{} `type:"structure"` - // The identifier for the attribute. - // - // Key is a required field - Key *string `min:"1" type:"string" required:"true"` + // The unique identifier for a list of query suggestions for an index. + QuerySuggestionsId *string `min:"1" type:"string"` - // The value of the attribute. - // - // Value is a required field - Value *DocumentAttributeValue `type:"structure" required:"true"` + // A list of query suggestions for an index. + Suggestions []*Suggestion `type:"list"` } // String returns the string representation. @@ -10590,7 +14506,7 @@ type DocumentAttribute 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 DocumentAttribute) String() string { +func (s GetQuerySuggestionsOutput) String() string { return awsutil.Prettify(s) } @@ -10599,66 +14515,70 @@ func (s DocumentAttribute) 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 DocumentAttribute) GoString() string { +func (s GetQuerySuggestionsOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentAttribute) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentAttribute"} - 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 s.Value != nil { - if err := s.Value.Validate(); err != nil { - invalidParams.AddNested("Value", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetKey sets the Key field's value. -func (s *DocumentAttribute) SetKey(v string) *DocumentAttribute { - s.Key = &v +// SetQuerySuggestionsId sets the QuerySuggestionsId field's value. +func (s *GetQuerySuggestionsOutput) SetQuerySuggestionsId(v string) *GetQuerySuggestionsOutput { + s.QuerySuggestionsId = &v return s } -// SetValue sets the Value field's value. -func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute { - s.Value = v +// SetSuggestions sets the Suggestions field's value. +func (s *GetQuerySuggestionsOutput) SetSuggestions(v []*Suggestion) *GetQuerySuggestionsOutput { + s.Suggestions = v return s } -// The value of a custom document attribute. You can only provide one value -// for a custom attribute. -type DocumentAttributeValue struct { +type GetSnapshotsInput struct { _ struct{} `type:"structure"` - // A date expressed as an ISO 8601 string. + // The identifier of the index to get search metrics data. // - // It is important for the time zone to be included in the ISO 8601 date-time - // format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format - // for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. - DateValue *time.Time `type:"timestamp"` + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // A long integer value. - LongValue *int64 `type:"long"` + // The time interval or time window to get search metrics data. The time interval + // uses the time zone of your index. You can view data in the following time + // windows: + // + // * THIS_WEEK: The current week, starting on the Sunday and ending on the + // day before the current date. + // + // * ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on + // the following Saturday. + // + // * TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday + // and ending on the following Saturday. + // + // * THIS_MONTH: The current month, starting on the first day of the month + // and ending on the day before the current date. + // + // * ONE_MONTH_AGO: The previous month, starting on the first day of the + // month and ending on the last day of the month. + // + // * TWO_MONTHS_AGO: The month before the previous month, starting on the + // first day of the month and ending on last day of the month. + // + // Interval is a required field + Interval *string `type:"string" required:"true" enum:"Interval"` - // A list of strings. - StringListValue []*string `type:"list"` + // The maximum number of returned data for the metric. + MaxResults *int64 `type:"integer"` - // A string, such as "department". - StringValue *string `min:"1" type:"string"` + // The metric you want to retrieve. You can specify only one metric per call. + // + // For more information about the metrics you can view, see Gaining insights + // with search analytics (https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html). + // + // MetricType is a required field + MetricType *string `type:"string" required:"true" enum:"MetricType"` + + // If the previous response was incomplete (because there is more data to retrieve), + // Amazon Kendra returns a pagination token in the response. You can use this + // pagination token to retrieve the next set of search metrics data. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -10666,7 +14586,7 @@ type DocumentAttributeValue 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 DocumentAttributeValue) String() string { +func (s GetSnapshotsInput) String() string { return awsutil.Prettify(s) } @@ -10675,15 +14595,27 @@ func (s DocumentAttributeValue) 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 DocumentAttributeValue) GoString() string { +func (s GetSnapshotsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentAttributeValue) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentAttributeValue"} - if s.StringValue != nil && len(*s.StringValue) < 1 { - invalidParams.Add(request.NewErrParamMinLen("StringValue", 1)) +func (s *GetSnapshotsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSnapshotsInput"} + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.Interval == nil { + invalidParams.Add(request.NewErrParamRequired("Interval")) + } + if s.MetricType == nil { + invalidParams.Add(request.NewErrParamRequired("MetricType")) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -10692,41 +14624,53 @@ func (s *DocumentAttributeValue) Validate() error { return nil } -// SetDateValue sets the DateValue field's value. -func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue { - s.DateValue = &v +// SetIndexId sets the IndexId field's value. +func (s *GetSnapshotsInput) SetIndexId(v string) *GetSnapshotsInput { + s.IndexId = &v return s } -// SetLongValue sets the LongValue field's value. -func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue { - s.LongValue = &v +// SetInterval sets the Interval field's value. +func (s *GetSnapshotsInput) SetInterval(v string) *GetSnapshotsInput { + s.Interval = &v return s } -// SetStringListValue sets the StringListValue field's value. -func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue { - s.StringListValue = v +// SetMaxResults sets the MaxResults field's value. +func (s *GetSnapshotsInput) SetMaxResults(v int64) *GetSnapshotsInput { + s.MaxResults = &v return s } -// SetStringValue sets the StringValue field's value. -func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue { - s.StringValue = &v +// SetMetricType sets the MetricType field's value. +func (s *GetSnapshotsInput) SetMetricType(v string) *GetSnapshotsInput { + s.MetricType = &v return s } -// Provides the count of documents that match a particular attribute when doing -// a faceted search. -type DocumentAttributeValueCountPair struct { +// SetNextToken sets the NextToken field's value. +func (s *GetSnapshotsInput) SetNextToken(v string) *GetSnapshotsInput { + s.NextToken = &v + return s +} + +type GetSnapshotsOutput struct { _ struct{} `type:"structure"` - // The number of documents in the response that have the attribute value for - // the key. - Count *int64 `type:"integer"` + // If the response is truncated, Amazon Kendra returns this token, which you + // can use in a later request to retrieve the next set of search metrics data. + NextToken *string `min:"1" type:"string"` - // The value of the attribute. For example, "HR." - DocumentAttributeValue *DocumentAttributeValue `type:"structure"` + // The date-time for the beginning and end of the time window for the search + // metrics data. + SnapShotTimeFilter *TimeRange `type:"structure"` + + // The search metrics data. The data returned depends on the metric type you + // requested. + SnapshotsData [][]*string `type:"list"` + + // The column headers for the search metrics data. + SnapshotsDataHeader []*string `type:"list"` } // String returns the string representation. @@ -10734,7 +14678,7 @@ type DocumentAttributeValueCountPair 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 DocumentAttributeValueCountPair) String() string { +func (s GetSnapshotsOutput) String() string { return awsutil.Prettify(s) } @@ -10743,50 +14687,83 @@ func (s DocumentAttributeValueCountPair) 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 DocumentAttributeValueCountPair) GoString() string { +func (s GetSnapshotsOutput) GoString() string { return s.String() } -// SetCount sets the Count field's value. -func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair { - s.Count = &v +// SetNextToken sets the NextToken field's value. +func (s *GetSnapshotsOutput) SetNextToken(v string) *GetSnapshotsOutput { + s.NextToken = &v return s } -// SetDocumentAttributeValue sets the DocumentAttributeValue field's value. -func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair { - s.DocumentAttributeValue = v +// SetSnapShotTimeFilter sets the SnapShotTimeFilter field's value. +func (s *GetSnapshotsOutput) SetSnapShotTimeFilter(v *TimeRange) *GetSnapshotsOutput { + s.SnapShotTimeFilter = v return s } -// Identifies a document for which to retrieve status information -type DocumentInfo struct { +// SetSnapshotsData sets the SnapshotsData field's value. +func (s *GetSnapshotsOutput) SetSnapshotsData(v [][]*string) *GetSnapshotsOutput { + s.SnapshotsData = v + return s +} + +// SetSnapshotsDataHeader sets the SnapshotsDataHeader field's value. +func (s *GetSnapshotsOutput) SetSnapshotsDataHeader(v []*string) *GetSnapshotsOutput { + s.SnapshotsDataHeader = v + return s +} + +// Provides configuration information for data sources that connect to Google +// Drive. +type GoogleDriveConfiguration struct { _ struct{} `type:"structure"` - // Attributes that identify a specific version of a document to check. - // - // The only valid attributes are: - // - // * version - // - // * datasourceId - // - // * jobExecutionId - // - // The attributes follow these rules: - // - // * dataSourceId and jobExecutionId must be used together. + // A list of MIME types to exclude from the index. All documents matching the + // specified MIME type are excluded. // - // * version is ignored if dataSourceId and jobExecutionId are not provided. + // For a list of MIME types, see Using a Google Workspace Drive data source + // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). + ExcludeMimeTypes []*string `type:"list"` + + // A list of identifiers or shared drives to exclude from the index. All files + // and folders stored on the shared drive are excluded. + ExcludeSharedDrives []*string `type:"list"` + + // A list of email addresses of the users. Documents owned by these users are + // excluded from the index. Documents shared with excluded users are indexed + // unless they are excluded in another way. + ExcludeUserAccounts []*string `type:"list"` + + // A list of regular expression patterns that apply to the path on Google Drive. + // Items that match the pattern are excluded from the index from both shared + // drives and users' My Drives. Items that don't match the pattern are included + // in the index. If an item matches both an exclusion pattern and an inclusion + // pattern, it is excluded from the index. + ExclusionPatterns []*string `type:"list"` + + // Defines mapping between a field in the Google Drive and a Amazon Kendra index + // field. // - // * If dataSourceId and jobExecutionId are provided, but version is not, - // the version defaults to "0". - Attributes []*DocumentAttribute `type:"list"` + // If you are using the console, you can define index fields when creating the + // mapping. If you are using the API, you must first create the field using + // the UpdateIndex operation. + FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"` - // The unique identifier of the document. + // A list of regular expression patterns that apply to path on Google Drive. + // Items that match the pattern are included in the index from both shared drives + // and users' My Drives. Items that don't match the pattern are excluded from + // the index. If an item matches both an inclusion pattern and an exclusion + // pattern, it is excluded from the index. + InclusionPatterns []*string `type:"list"` + + // The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the + // credentials required to connect to Google Drive. For more information, see + // Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). // - // DocumentId is a required field - DocumentId *string `min:"1" type:"string" required:"true"` + // SecretArn is a required field + SecretArn *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -10794,7 +14771,7 @@ type DocumentInfo 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 DocumentInfo) String() string { +func (s GoogleDriveConfiguration) String() string { return awsutil.Prettify(s) } @@ -10803,26 +14780,29 @@ func (s DocumentInfo) 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 DocumentInfo) GoString() string { +func (s GoogleDriveConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentInfo) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentInfo"} - if s.DocumentId == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentId")) +func (s *GoogleDriveConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GoogleDriveConfiguration"} + if s.FieldMappings != nil && len(s.FieldMappings) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FieldMappings", 1)) } - if s.DocumentId != nil && len(*s.DocumentId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentId", 1)) + if s.SecretArn == nil { + invalidParams.Add(request.NewErrParamRequired("SecretArn")) } - if s.Attributes != nil { - for i, v := range s.Attributes { + if s.SecretArn != nil && len(*s.SecretArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) + } + if s.FieldMappings != nil { + for i, v := range s.FieldMappings { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FieldMappings", i), err.(request.ErrInvalidParams)) } } } @@ -10833,122 +14813,74 @@ func (s *DocumentInfo) Validate() error { return nil } -// SetAttributes sets the Attributes field's value. -func (s *DocumentInfo) SetAttributes(v []*DocumentAttribute) *DocumentInfo { - s.Attributes = v +// SetExcludeMimeTypes sets the ExcludeMimeTypes field's value. +func (s *GoogleDriveConfiguration) SetExcludeMimeTypes(v []*string) *GoogleDriveConfiguration { + s.ExcludeMimeTypes = v return s } -// SetDocumentId sets the DocumentId field's value. -func (s *DocumentInfo) SetDocumentId(v string) *DocumentInfo { - s.DocumentId = &v +// SetExcludeSharedDrives sets the ExcludeSharedDrives field's value. +func (s *GoogleDriveConfiguration) SetExcludeSharedDrives(v []*string) *GoogleDriveConfiguration { + s.ExcludeSharedDrives = v return s } -// Specifies the properties of a custom index field. -type DocumentMetadataConfiguration struct { - _ struct{} `type:"structure"` - - // The name of the index field. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // Provides manual tuning parameters to determine how the field affects the - // search results. - Relevance *Relevance `type:"structure"` - - // Provides information about how the field is used during a search. - Search *Search `type:"structure"` - - // The data type of the index field. - // - // Type is a required field - Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"` -} - -// 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 DocumentMetadataConfiguration) 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 DocumentMetadataConfiguration) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentMetadataConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentMetadataConfiguration"} - 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.Type == nil { - invalidParams.Add(request.NewErrParamRequired("Type")) - } - if s.Relevance != nil { - if err := s.Relevance.Validate(); err != nil { - invalidParams.AddNested("Relevance", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetExcludeUserAccounts sets the ExcludeUserAccounts field's value. +func (s *GoogleDriveConfiguration) SetExcludeUserAccounts(v []*string) *GoogleDriveConfiguration { + s.ExcludeUserAccounts = v + return s } -// SetName sets the Name field's value. -func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration { - s.Name = &v +// SetExclusionPatterns sets the ExclusionPatterns field's value. +func (s *GoogleDriveConfiguration) SetExclusionPatterns(v []*string) *GoogleDriveConfiguration { + s.ExclusionPatterns = v return s } -// SetRelevance sets the Relevance field's value. -func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration { - s.Relevance = v +// SetFieldMappings sets the FieldMappings field's value. +func (s *GoogleDriveConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *GoogleDriveConfiguration { + s.FieldMappings = v return s } -// SetSearch sets the Search field's value. -func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration { - s.Search = v +// SetInclusionPatterns sets the InclusionPatterns field's value. +func (s *GoogleDriveConfiguration) SetInclusionPatterns(v []*string) *GoogleDriveConfiguration { + s.InclusionPatterns = v return s } -// SetType sets the Type field's value. -func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration { - s.Type = &v +// SetSecretArn sets the SecretArn field's value. +func (s *GoogleDriveConfiguration) SetSecretArn(v string) *GoogleDriveConfiguration { + s.SecretArn = &v return s } -// Overrides the document relevance properties of a custom index field. -type DocumentRelevanceConfiguration struct { +// A list of users or sub groups that belong to a group. Users and groups are +// useful for filtering search results to different users based on their group's +// access to documents. +type GroupMembers struct { _ struct{} `type:"structure"` - // The name of the tuning configuration to override document relevance at the - // index level. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // A list of sub groups that belong to a group. For example, the sub groups + // "Research", "Engineering", and "Sales and Marketing" all belong to the group + // "Company". + MemberGroups []*MemberGroup `min:"1" type:"list"` - // Provides information for manually tuning the relevance of a field in a search. - // When a query includes terms that match the field, the results are given a - // boost in the response based on these tuning parameters. + // A list of users that belong to a group. For example, a list of interns all + // belong to the "Interns" group. + MemberUsers []*MemberUser `min:"1" type:"list"` + + // If you have more than 1000 users and/or sub groups for a single group, you + // need to provide the path to the S3 file that lists your users and sub groups + // for a group. Your sub groups can contain more than 1000 users, but the list + // of sub groups that belong to a group (and/or users) must be no more than + // 1000. // - // Relevance is a required field - Relevance *Relevance `type:"structure" required:"true"` + // You can download this example S3 file (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) + // that uses the correct format for listing group members. Note, dataSourceId + // is optional. The value of type for a group is always GROUP and for a user + // it is always USER. + S3PathforGroupMembers *S3Path `type:"structure"` } // String returns the string representation. @@ -10956,7 +14888,7 @@ type DocumentRelevanceConfiguration 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 DocumentRelevanceConfiguration) String() string { +func (s GroupMembers) String() string { return awsutil.Prettify(s) } @@ -10965,25 +14897,42 @@ func (s DocumentRelevanceConfiguration) 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 DocumentRelevanceConfiguration) GoString() string { +func (s GroupMembers) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentRelevanceConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentRelevanceConfiguration"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) +func (s *GroupMembers) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GroupMembers"} + if s.MemberGroups != nil && len(s.MemberGroups) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberGroups", 1)) } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + if s.MemberUsers != nil && len(s.MemberUsers) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberUsers", 1)) } - if s.Relevance == nil { - invalidParams.Add(request.NewErrParamRequired("Relevance")) + if s.MemberGroups != nil { + for i, v := range s.MemberGroups { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MemberGroups", i), err.(request.ErrInvalidParams)) + } + } } - if s.Relevance != nil { - if err := s.Relevance.Validate(); err != nil { - invalidParams.AddNested("Relevance", err.(request.ErrInvalidParams)) + if s.MemberUsers != nil { + for i, v := range s.MemberUsers { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MemberUsers", i), err.(request.ErrInvalidParams)) + } + } + } + if s.S3PathforGroupMembers != nil { + if err := s.S3PathforGroupMembers.Validate(); err != nil { + invalidParams.AddNested("S3PathforGroupMembers", err.(request.ErrInvalidParams)) } } @@ -10993,28 +14942,48 @@ func (s *DocumentRelevanceConfiguration) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *DocumentRelevanceConfiguration) SetName(v string) *DocumentRelevanceConfiguration { - s.Name = &v +// SetMemberGroups sets the MemberGroups field's value. +func (s *GroupMembers) SetMemberGroups(v []*MemberGroup) *GroupMembers { + s.MemberGroups = v return s } -// SetRelevance sets the Relevance field's value. -func (s *DocumentRelevanceConfiguration) SetRelevance(v *Relevance) *DocumentRelevanceConfiguration { - s.Relevance = v +// SetMemberUsers sets the MemberUsers field's value. +func (s *GroupMembers) SetMemberUsers(v []*MemberUser) *GroupMembers { + s.MemberUsers = v return s } -// Document metadata files that contain information such as the document access -// control information, source URI, document author, and custom attributes. -// Each metadata file contains metadata about a single document. -type DocumentsMetadataConfiguration struct { +// SetS3PathforGroupMembers sets the S3PathforGroupMembers field's value. +func (s *GroupMembers) SetS3PathforGroupMembers(v *S3Path) *GroupMembers { + s.S3PathforGroupMembers = v + return s +} + +// Information on the processing of PUT and DELETE actions for mapping users +// to their groups. +type GroupOrderingIdSummary struct { _ struct{} `type:"structure"` - // A prefix used to filter metadata configuration files in the Amazon Web Services - // S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix - // to include only the desired metadata files. - S3Prefix *string `min:"1" type:"string"` + // The reason an action could not be processed. An action can be a PUT or DELETE + // action for mapping users to their groups. + FailureReason *string `min:"1" type:"string"` + + // The last date-time an action was updated. An action can be a PUT or DELETE + // action for mapping users to their groups. + LastUpdatedAt *time.Time `type:"timestamp"` + + // The order in which actions should complete processing. An action can be a + // PUT or DELETE action for mapping users to their groups. + OrderingId *int64 `type:"long"` + + // The date-time an action was received by Amazon Kendra. An action can be a + // PUT or DELETE action for mapping users to their groups. + ReceivedAt *time.Time `type:"timestamp"` + + // The current processing status of actions for mapping users to their groups. + // The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED. + Status *string `type:"string" enum:"PrincipalMappingStatus"` } // String returns the string representation. @@ -11022,7 +14991,7 @@ type DocumentsMetadataConfiguration 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 DocumentsMetadataConfiguration) String() string { +func (s GroupOrderingIdSummary) String() string { return awsutil.Prettify(s) } @@ -11031,35 +15000,49 @@ func (s DocumentsMetadataConfiguration) 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 DocumentsMetadataConfiguration) GoString() string { +func (s GroupOrderingIdSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DocumentsMetadataConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DocumentsMetadataConfiguration"} - if s.S3Prefix != nil && len(*s.S3Prefix) < 1 { - invalidParams.Add(request.NewErrParamMinLen("S3Prefix", 1)) - } +// SetFailureReason sets the FailureReason field's value. +func (s *GroupOrderingIdSummary) SetFailureReason(v string) *GroupOrderingIdSummary { + s.FailureReason = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *GroupOrderingIdSummary) SetLastUpdatedAt(v time.Time) *GroupOrderingIdSummary { + s.LastUpdatedAt = &v + return s } -// SetS3Prefix sets the S3Prefix field's value. -func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration { - s.S3Prefix = &v +// SetOrderingId sets the OrderingId field's value. +func (s *GroupOrderingIdSummary) SetOrderingId(v int64) *GroupOrderingIdSummary { + s.OrderingId = &v return s } -// Information about a document attribute -type Facet struct { +// SetReceivedAt sets the ReceivedAt field's value. +func (s *GroupOrderingIdSummary) SetReceivedAt(v time.Time) *GroupOrderingIdSummary { + s.ReceivedAt = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *GroupOrderingIdSummary) SetStatus(v string) *GroupOrderingIdSummary { + s.Status = &v + return s +} + +// Group summary information. +type GroupSummary struct { _ struct{} `type:"structure"` - // The unique key for the document attribute. - DocumentAttributeKey *string `min:"1" type:"string"` + // The identifier of the group you want group summary information on. + GroupId *string `min:"1" type:"string"` + + // The timestamp identifier used for the latest PUT or DELETE action. + OrderingId *int64 `type:"long"` } // String returns the string representation. @@ -11067,7 +15050,7 @@ type Facet 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 Facet) String() string { +func (s GroupSummary) String() string { return awsutil.Prettify(s) } @@ -11076,44 +15059,34 @@ func (s Facet) 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 Facet) GoString() string { +func (s GroupSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *Facet) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Facet"} - if s.DocumentAttributeKey != nil && len(*s.DocumentAttributeKey) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DocumentAttributeKey", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetGroupId sets the GroupId field's value. +func (s *GroupSummary) SetGroupId(v string) *GroupSummary { + s.GroupId = &v + return s } -// SetDocumentAttributeKey sets the DocumentAttributeKey field's value. -func (s *Facet) SetDocumentAttributeKey(v string) *Facet { - s.DocumentAttributeKey = &v +// SetOrderingId sets the OrderingId field's value. +func (s *GroupSummary) SetOrderingId(v int64) *GroupSummary { + s.OrderingId = &v return s } -// The facet values for the documents in the response. -type FacetResult struct { +// Information to define the hierarchy for which documents users should have +// access to. +type HierarchicalPrincipal struct { _ struct{} `type:"structure"` - // The key for the facet values. This is the same as the DocumentAttributeKey - // provided in the query. - DocumentAttributeKey *string `min:"1" type:"string"` - - // An array of key/value pairs, where the key is the value of the attribute - // and the count is the number of documents that share the key value. - DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"` - - // The data type of the facet value. This is the same as the type defined for - // the index field when it was created. - DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"` + // A list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access + // to. Each hierarchical list specifies which user or group has allow or deny + // access for each document. + // + // PrincipalList is a required field + PrincipalList []*Principal `type:"list" required:"true"` } // String returns the string representation. @@ -11121,7 +15094,7 @@ type FacetResult 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 FacetResult) String() string { +func (s HierarchicalPrincipal) String() string { return awsutil.Prettify(s) } @@ -11130,37 +15103,60 @@ func (s FacetResult) 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 FacetResult) GoString() string { +func (s HierarchicalPrincipal) GoString() string { return s.String() } -// SetDocumentAttributeKey sets the DocumentAttributeKey field's value. -func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult { - s.DocumentAttributeKey = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *HierarchicalPrincipal) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "HierarchicalPrincipal"} + if s.PrincipalList == nil { + invalidParams.Add(request.NewErrParamRequired("PrincipalList")) + } + if s.PrincipalList != nil { + for i, v := range s.PrincipalList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PrincipalList", i), err.(request.ErrInvalidParams)) + } + } + } -// SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value. -func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult { - s.DocumentAttributeValueCountPairs = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value. -func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult { - s.DocumentAttributeValueType = &v +// SetPrincipalList sets the PrincipalList field's value. +func (s *HierarchicalPrincipal) SetPrincipalList(v []*Principal) *HierarchicalPrincipal { + s.PrincipalList = v return s } -// Provides statistical information about the FAQ questions and answers contained -// in an index. -type FaqStatistics struct { +// Provides information that you can use to highlight a search result so that +// your users can quickly identify terms in the response. +type Highlight struct { _ struct{} `type:"structure"` - // The total number of FAQ questions and answers contained in the index. + // The zero-based location in the response string where the highlight starts. // - // IndexedQuestionAnswersCount is a required field - IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"` + // BeginOffset is a required field + BeginOffset *int64 `type:"integer" required:"true"` + + // The zero-based location in the response string where the highlight ends. + // + // EndOffset is a required field + EndOffset *int64 `type:"integer" required:"true"` + + // Indicates whether the response is the best response. True if this is the + // best response; otherwise, false. + TopAnswer *bool `type:"boolean"` + + // The highlight type. + Type *string `type:"string" enum:"HighlightType"` } // String returns the string representation. @@ -11168,7 +15164,7 @@ type FaqStatistics 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 FaqStatistics) String() string { +func (s Highlight) String() string { return awsutil.Prettify(s) } @@ -11177,45 +15173,70 @@ func (s FaqStatistics) 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 FaqStatistics) GoString() string { +func (s Highlight) GoString() string { return s.String() } -// SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value. -func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics { - s.IndexedQuestionAnswersCount = &v +// SetBeginOffset sets the BeginOffset field's value. +func (s *Highlight) SetBeginOffset(v int64) *Highlight { + s.BeginOffset = &v return s } -// Provides information about a frequently asked questions and answer contained -// in an index. -type FaqSummary struct { - _ struct{} `type:"structure"` - - // The UNIX datetime that the FAQ was added to the index. - CreatedAt *time.Time `type:"timestamp"` +// SetEndOffset sets the EndOffset field's value. +func (s *Highlight) SetEndOffset(v int64) *Highlight { + s.EndOffset = &v + return s +} - // The file type used to create the FAQ. - FileFormat *string `type:"string" enum:"FaqFileFormat"` +// SetTopAnswer sets the TopAnswer field's value. +func (s *Highlight) SetTopAnswer(v bool) *Highlight { + s.TopAnswer = &v + return s +} - // The unique identifier of the FAQ. - Id *string `min:"1" type:"string"` +// SetType sets the Type field's value. +func (s *Highlight) SetType(v string) *Highlight { + s.Type = &v + return s +} - // The code for a language. This shows a supported language for the FAQ document - // as part of the summary information for FAQs. English is supported by default. - // For more information on supported languages, including their codes, see Adding - // documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). - LanguageCode *string `min:"2" type:"string"` +// Provides the configuration information for invoking a Lambda function in +// Lambda to alter document metadata and content when ingesting documents into +// Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration +// (https://docs.aws.amazon.com/kendra/latest/dg/API_PreExtractionHookConfiguration.html) +// if you want to apply advanced alterations on the original or raw documents. +// If you want to apply advanced alterations on the Amazon Kendra structured +// documents, you must configure your Lambda function using PostExtractionHookConfiguration +// (https://docs.aws.amazon.com/kendra/latest/dg/API_PostExtractionHookConfiguration.html). +// You can only invoke one Lambda function. However, this function can invoke +// other functions it requires. +// +// For more information, see Customizing document metadata during the ingestion +// process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +type HookConfiguration struct { + _ struct{} `type:"structure"` - // The name that you assigned the FAQ when you created or updated the FAQ. - Name *string `min:"1" type:"string"` + // The condition used for when a Lambda function should be invoked. + // + // For example, you can specify a condition that if there are empty date-time + // values, then Amazon Kendra should invoke a function that inserts the current + // date-time. + InvocationCondition *DocumentAttributeCondition `type:"structure"` - // The current status of the FAQ. When the status is ACTIVE the FAQ is ready - // for use. - Status *string `type:"string" enum:"FaqStatus"` + // The Amazon Resource Name (ARN) of a role with permission to run a Lambda + // function during ingestion. For more information, see IAM roles for Amazon + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // + // LambdaArn is a required field + LambdaArn *string `min:"1" type:"string" required:"true"` - // The UNIX datetime that the FAQ was last updated. - UpdatedAt *time.Time `type:"timestamp"` + // Stores the original, raw documents or the structured, parsed documents before + // and after altering them. For more information, see Data contracts for Lambda + // functions (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda). + // + // S3Bucket is a required field + S3Bucket *string `min:"3" type:"string" required:"true"` } // String returns the string representation. @@ -11223,7 +15244,7 @@ type FaqSummary 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 FaqSummary) String() string { +func (s HookConfiguration) String() string { return awsutil.Prettify(s) } @@ -11232,74 +15253,85 @@ func (s FaqSummary) 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 FaqSummary) GoString() string { +func (s HookConfiguration) GoString() string { return s.String() } -// SetCreatedAt sets the CreatedAt field's value. -func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary { - s.CreatedAt = &v - return s -} - -// SetFileFormat sets the FileFormat field's value. -func (s *FaqSummary) SetFileFormat(v string) *FaqSummary { - s.FileFormat = &v - return s -} - -// SetId sets the Id field's value. -func (s *FaqSummary) SetId(v string) *FaqSummary { - s.Id = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *HookConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "HookConfiguration"} + if s.LambdaArn == nil { + invalidParams.Add(request.NewErrParamRequired("LambdaArn")) + } + if s.LambdaArn != nil && len(*s.LambdaArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LambdaArn", 1)) + } + if s.S3Bucket == nil { + invalidParams.Add(request.NewErrParamRequired("S3Bucket")) + } + if s.S3Bucket != nil && len(*s.S3Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("S3Bucket", 3)) + } + if s.InvocationCondition != nil { + if err := s.InvocationCondition.Validate(); err != nil { + invalidParams.AddNested("InvocationCondition", err.(request.ErrInvalidParams)) + } + } -// SetLanguageCode sets the LanguageCode field's value. -func (s *FaqSummary) SetLanguageCode(v string) *FaqSummary { - s.LanguageCode = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetName sets the Name field's value. -func (s *FaqSummary) SetName(v string) *FaqSummary { - s.Name = &v +// SetInvocationCondition sets the InvocationCondition field's value. +func (s *HookConfiguration) SetInvocationCondition(v *DocumentAttributeCondition) *HookConfiguration { + s.InvocationCondition = v return s } -// SetStatus sets the Status field's value. -func (s *FaqSummary) SetStatus(v string) *FaqSummary { - s.Status = &v +// SetLambdaArn sets the LambdaArn field's value. +func (s *HookConfiguration) SetLambdaArn(v string) *HookConfiguration { + s.LambdaArn = &v return s } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary { - s.UpdatedAt = &v +// SetS3Bucket sets the S3Bucket field's value. +func (s *HookConfiguration) SetS3Bucket(v string) *HookConfiguration { + s.S3Bucket = &v return s } -type GetQuerySuggestionsInput struct { +// A summary of information about an index. +type IndexConfigurationSummary struct { _ struct{} `type:"structure"` - // The identifier of the index you want to get query suggestions from. + // The Unix timestamp when the index was created. // - // IndexId is a required field - IndexId *string `min:"36" type:"string" required:"true"` + // CreatedAt is a required field + CreatedAt *time.Time `type:"timestamp" required:"true"` - // The maximum number of query suggestions you want to show to your users. - MaxSuggestionsCount *int64 `type:"integer"` + // Indicates whether the index is a enterprise edition index or a developer + // edition index. + Edition *string `type:"string" enum:"IndexEdition"` - // The text of a user's query to generate query suggestions. - // - // A query is suggested if the query prefix matches what a user starts to type - // as their query. + // A unique identifier for the index. Use this to identify the index when you + // are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. + Id *string `min:"36" type:"string"` + + // The name of the index. + Name *string `min:"1" type:"string"` + + // The current status of the index. When the status is ACTIVE, the index is + // ready to search. // - // Amazon Kendra does not show any suggestions if a user types fewer than two - // characters or more than 60 characters. A query must also have at least one - // search result and contain at least one word of more than four characters. + // Status is a required field + Status *string `type:"string" required:"true" enum:"IndexStatus"` + + // The Unix timestamp when the index was last updated by the UpdateIndex operation. // - // QueryText is a required field - QueryText *string `type:"string" required:"true"` + // UpdatedAt is a required field + UpdatedAt *time.Time `type:"timestamp" required:"true"` } // String returns the string representation. @@ -11307,7 +15339,7 @@ type GetQuerySuggestionsInput 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 GetQuerySuggestionsInput) String() string { +func (s IndexConfigurationSummary) String() string { return awsutil.Prettify(s) } @@ -11316,55 +15348,60 @@ func (s GetQuerySuggestionsInput) 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 GetQuerySuggestionsInput) GoString() string { +func (s IndexConfigurationSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *GetQuerySuggestionsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetQuerySuggestionsInput"} - if s.IndexId == nil { - invalidParams.Add(request.NewErrParamRequired("IndexId")) - } - if s.IndexId != nil && len(*s.IndexId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) - } - if s.QueryText == nil { - invalidParams.Add(request.NewErrParamRequired("QueryText")) - } +// SetCreatedAt sets the CreatedAt field's value. +func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary { + s.CreatedAt = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetEdition sets the Edition field's value. +func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary { + s.Edition = &v + return s } -// SetIndexId sets the IndexId field's value. -func (s *GetQuerySuggestionsInput) SetIndexId(v string) *GetQuerySuggestionsInput { - s.IndexId = &v +// SetId sets the Id field's value. +func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary { + s.Id = &v return s } -// SetMaxSuggestionsCount sets the MaxSuggestionsCount field's value. -func (s *GetQuerySuggestionsInput) SetMaxSuggestionsCount(v int64) *GetQuerySuggestionsInput { - s.MaxSuggestionsCount = &v +// SetName sets the Name field's value. +func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary { + s.Name = &v return s } -// SetQueryText sets the QueryText field's value. -func (s *GetQuerySuggestionsInput) SetQueryText(v string) *GetQuerySuggestionsInput { - s.QueryText = &v +// SetStatus sets the Status field's value. +func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary { + s.Status = &v return s } -type GetQuerySuggestionsOutput struct { +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary { + s.UpdatedAt = &v + return s +} + +// Provides information about the number of documents and the number of questions +// and answers in an index. +type IndexStatistics struct { _ struct{} `type:"structure"` - // The unique identifier for a list of query suggestions for an index. - QuerySuggestionsId *string `min:"1" type:"string"` + // The number of question and answer topics in the index. + // + // FaqStatistics is a required field + FaqStatistics *FaqStatistics `type:"structure" required:"true"` - // A list of query suggestions for an index. - Suggestions []*Suggestion `type:"list"` + // The number of text documents indexed. + // + // TextDocumentStatistics is a required field + TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"` } // String returns the string representation. @@ -11372,7 +15409,7 @@ type GetQuerySuggestionsOutput 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 GetQuerySuggestionsOutput) String() string { +func (s IndexStatistics) String() string { return awsutil.Prettify(s) } @@ -11381,71 +15418,43 @@ func (s GetQuerySuggestionsOutput) 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 GetQuerySuggestionsOutput) GoString() string { +func (s IndexStatistics) GoString() string { return s.String() } -// SetQuerySuggestionsId sets the QuerySuggestionsId field's value. -func (s *GetQuerySuggestionsOutput) SetQuerySuggestionsId(v string) *GetQuerySuggestionsOutput { - s.QuerySuggestionsId = &v +// SetFaqStatistics sets the FaqStatistics field's value. +func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics { + s.FaqStatistics = v return s } -// SetSuggestions sets the Suggestions field's value. -func (s *GetQuerySuggestionsOutput) SetSuggestions(v []*Suggestion) *GetQuerySuggestionsOutput { - s.Suggestions = v +// SetTextDocumentStatistics sets the TextDocumentStatistics field's value. +func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics { + s.TextDocumentStatistics = v return s } -// Provides configuration information for data sources that connect to Google -// Drive. -type GoogleDriveConfiguration struct { +// Provides the configuration information for applying basic logic to alter +// document metadata and content when ingesting documents into Amazon Kendra. +// To apply advanced logic, to go beyond what you can do with basic logic, see +// HookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html). +// +// For more information, see Customizing document metadata during the ingestion +// process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +type InlineCustomDocumentEnrichmentConfiguration struct { _ struct{} `type:"structure"` - // A list of MIME types to exclude from the index. All documents matching the - // specified MIME type are excluded. - // - // For a list of MIME types, see Using a Google Workspace Drive data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). - ExcludeMimeTypes []*string `type:"list"` - - // A list of identifiers or shared drives to exclude from the index. All files - // and folders stored on the shared drive are excluded. - ExcludeSharedDrives []*string `type:"list"` - - // A list of email addresses of the users. Documents owned by these users are - // excluded from the index. Documents shared with excluded users are indexed - // unless they are excluded in another way. - ExcludeUserAccounts []*string `type:"list"` - - // A list of regular expression patterns that apply to the path on Google Drive. - // Items that match the pattern are excluded from the index from both shared - // drives and users' My Drives. Items that don't match the pattern are included - // in the index. If an item matches both an exclusion pattern and an inclusion - // pattern, it is excluded from the index. - ExclusionPatterns []*string `type:"list"` - - // Defines mapping between a field in the Google Drive and a Amazon Kendra index - // field. - // - // If you are using the console, you can define index fields when creating the - // mapping. If you are using the API, you must first create the field using - // the UpdateIndex operation. - FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"` + // Configuration of the condition used for the target document attribute or + // metadata field when ingesting documents into Amazon Kendra. + Condition *DocumentAttributeCondition `type:"structure"` - // A list of regular expression patterns that apply to path on Google Drive. - // Items that match the pattern are included in the index from both shared drives - // and users' My Drives. Items that don't match the pattern are excluded from - // the index. If an item matches both an inclusion pattern and an exclusion - // pattern, it is excluded from the index. - InclusionPatterns []*string `type:"list"` + // TRUE to delete content if the condition used for the target attribute is + // met. + DocumentContentDeletion *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the - // credentials required to connect to Google Drive. For more information, see - // Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). - // - // SecretArn is a required field - SecretArn *string `min:"1" type:"string" required:"true"` + // Configuration of the target document attribute or metadata field when ingesting + // documents into Amazon Kendra. You can also include a value. + Target *DocumentAttributeTarget `type:"structure"` } // String returns the string representation. @@ -11453,7 +15462,7 @@ type GoogleDriveConfiguration 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 GoogleDriveConfiguration) String() string { +func (s InlineCustomDocumentEnrichmentConfiguration) String() string { return awsutil.Prettify(s) } @@ -11462,30 +15471,21 @@ func (s GoogleDriveConfiguration) 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 GoogleDriveConfiguration) GoString() string { +func (s InlineCustomDocumentEnrichmentConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GoogleDriveConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GoogleDriveConfiguration"} - if s.FieldMappings != nil && len(s.FieldMappings) < 1 { - invalidParams.Add(request.NewErrParamMinLen("FieldMappings", 1)) - } - if s.SecretArn == nil { - invalidParams.Add(request.NewErrParamRequired("SecretArn")) - } - if s.SecretArn != nil && len(*s.SecretArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecretArn", 1)) +func (s *InlineCustomDocumentEnrichmentConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InlineCustomDocumentEnrichmentConfiguration"} + if s.Condition != nil { + if err := s.Condition.Validate(); err != nil { + invalidParams.AddNested("Condition", err.(request.ErrInvalidParams)) + } } - if s.FieldMappings != nil { - for i, v := range s.FieldMappings { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FieldMappings", i), err.(request.ErrInvalidParams)) - } + if s.Target != nil { + if err := s.Target.Validate(); err != nil { + invalidParams.AddNested("Target", err.(request.ErrInvalidParams)) } } @@ -11495,74 +15495,29 @@ func (s *GoogleDriveConfiguration) Validate() error { return nil } -// SetExcludeMimeTypes sets the ExcludeMimeTypes field's value. -func (s *GoogleDriveConfiguration) SetExcludeMimeTypes(v []*string) *GoogleDriveConfiguration { - s.ExcludeMimeTypes = v - return s -} - -// SetExcludeSharedDrives sets the ExcludeSharedDrives field's value. -func (s *GoogleDriveConfiguration) SetExcludeSharedDrives(v []*string) *GoogleDriveConfiguration { - s.ExcludeSharedDrives = v - return s -} - -// SetExcludeUserAccounts sets the ExcludeUserAccounts field's value. -func (s *GoogleDriveConfiguration) SetExcludeUserAccounts(v []*string) *GoogleDriveConfiguration { - s.ExcludeUserAccounts = v - return s -} - -// SetExclusionPatterns sets the ExclusionPatterns field's value. -func (s *GoogleDriveConfiguration) SetExclusionPatterns(v []*string) *GoogleDriveConfiguration { - s.ExclusionPatterns = v - return s -} - -// SetFieldMappings sets the FieldMappings field's value. -func (s *GoogleDriveConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *GoogleDriveConfiguration { - s.FieldMappings = v +// SetCondition sets the Condition field's value. +func (s *InlineCustomDocumentEnrichmentConfiguration) SetCondition(v *DocumentAttributeCondition) *InlineCustomDocumentEnrichmentConfiguration { + s.Condition = v return s } -// SetInclusionPatterns sets the InclusionPatterns field's value. -func (s *GoogleDriveConfiguration) SetInclusionPatterns(v []*string) *GoogleDriveConfiguration { - s.InclusionPatterns = v +// SetDocumentContentDeletion sets the DocumentContentDeletion field's value. +func (s *InlineCustomDocumentEnrichmentConfiguration) SetDocumentContentDeletion(v bool) *InlineCustomDocumentEnrichmentConfiguration { + s.DocumentContentDeletion = &v return s } -// SetSecretArn sets the SecretArn field's value. -func (s *GoogleDriveConfiguration) SetSecretArn(v string) *GoogleDriveConfiguration { - s.SecretArn = &v +// SetTarget sets the Target field's value. +func (s *InlineCustomDocumentEnrichmentConfiguration) SetTarget(v *DocumentAttributeTarget) *InlineCustomDocumentEnrichmentConfiguration { + s.Target = v return s } -// A list of users or sub groups that belong to a group. Users and groups are -// useful for filtering search results to different users based on their group's -// access to documents. -type GroupMembers struct { - _ struct{} `type:"structure"` - - // A list of sub groups that belong to a group. For example, the sub groups - // "Research", "Engineering", and "Sales and Marketing" all belong to the group - // "Company". - MemberGroups []*MemberGroup `min:"1" type:"list"` - - // A list of users that belong to a group. For example, a list of interns all - // belong to the "Interns" group. - MemberUsers []*MemberUser `min:"1" type:"list"` +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // If you have more than 1000 users and/or sub groups for a single group, you - // need to provide the path to the S3 file that lists your users and sub groups - // for a group. Your sub groups can contain more than 1000 users, but the list - // of sub groups that belong to a group (and/or users) must be no more than - // 1000. - // - // You can download this example S3 file (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) - // that uses the correct format for listing group members. Note, dataSourceId - // is optional. The value of type for a group is always GROUP and for a user - // it is always USER. - S3PathforGroupMembers *S3Path `type:"structure"` + Message_ *string `locationName:"Message" min:"1" type:"string"` } // String returns the string representation. @@ -11570,7 +15525,7 @@ type GroupMembers 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 GroupMembers) String() string { +func (s InternalServerException) String() string { return awsutil.Prettify(s) } @@ -11579,93 +15534,54 @@ func (s GroupMembers) 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 GroupMembers) GoString() string { +func (s InternalServerException) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *GroupMembers) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GroupMembers"} - if s.MemberGroups != nil && len(s.MemberGroups) < 1 { - invalidParams.Add(request.NewErrParamMinLen("MemberGroups", 1)) - } - if s.MemberUsers != nil && len(s.MemberUsers) < 1 { - invalidParams.Add(request.NewErrParamMinLen("MemberUsers", 1)) - } - if s.MemberGroups != nil { - for i, v := range s.MemberGroups { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MemberGroups", i), err.(request.ErrInvalidParams)) - } - } - } - if s.MemberUsers != nil { - for i, v := range s.MemberUsers { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MemberUsers", i), err.(request.ErrInvalidParams)) - } - } - } - if s.S3PathforGroupMembers != nil { - if err := s.S3PathforGroupMembers.Validate(); err != nil { - invalidParams.AddNested("S3PathforGroupMembers", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, } - return nil } -// SetMemberGroups sets the MemberGroups field's value. -func (s *GroupMembers) SetMemberGroups(v []*MemberGroup) *GroupMembers { - s.MemberGroups = v - return s +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" } -// SetMemberUsers sets the MemberUsers field's value. -func (s *GroupMembers) SetMemberUsers(v []*MemberUser) *GroupMembers { - s.MemberUsers = v - return s +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetS3PathforGroupMembers sets the S3PathforGroupMembers field's value. -func (s *GroupMembers) SetS3PathforGroupMembers(v *S3Path) *GroupMembers { - s.S3PathforGroupMembers = v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil } -// Information on the processing of PUT and DELETE actions for mapping users -// to their groups. -type GroupOrderingIdSummary struct { - _ struct{} `type:"structure"` - - // The reason an action could not be processed. An action can be a PUT or DELETE - // action for mapping users to their groups. - FailureReason *string `min:"1" type:"string"` +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} - // The last date-time an action was updated. An action can be a PUT or DELETE - // action for mapping users to their groups. - LastUpdatedAt *time.Time `type:"timestamp"` +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} - // The order in which actions should complete processing. An action can be a - // PUT or DELETE action for mapping users to their groups. - OrderingId *int64 `type:"long"` +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} - // The date-time an action was received by Amazon Kendra. An action can be a - // PUT or DELETE action for mapping users to their groups. - ReceivedAt *time.Time `type:"timestamp"` +// The input to the request is not valid. +type InvalidRequestException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The current processing status of actions for mapping users to their groups. - // The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED. - Status *string `type:"string" enum:"PrincipalMappingStatus"` + Message_ *string `locationName:"Message" min:"1" type:"string"` } // String returns the string representation. @@ -11673,7 +15589,7 @@ type GroupOrderingIdSummary 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 GroupOrderingIdSummary) String() string { +func (s InvalidRequestException) String() string { return awsutil.Prettify(s) } @@ -11682,49 +15598,61 @@ func (s GroupOrderingIdSummary) 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 GroupOrderingIdSummary) GoString() string { +func (s InvalidRequestException) GoString() string { return s.String() } -// SetFailureReason sets the FailureReason field's value. -func (s *GroupOrderingIdSummary) SetFailureReason(v string) *GroupOrderingIdSummary { - s.FailureReason = &v - return s +func newErrorInvalidRequestException(v protocol.ResponseMetadata) error { + return &InvalidRequestException{ + RespMetadata: v, + } } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *GroupOrderingIdSummary) SetLastUpdatedAt(v time.Time) *GroupOrderingIdSummary { - s.LastUpdatedAt = &v - return s +// Code returns the exception type name. +func (s *InvalidRequestException) Code() string { + return "InvalidRequestException" } -// SetOrderingId sets the OrderingId field's value. -func (s *GroupOrderingIdSummary) SetOrderingId(v int64) *GroupOrderingIdSummary { - s.OrderingId = &v - return s +// Message returns the exception's message. +func (s *InvalidRequestException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetReceivedAt sets the ReceivedAt field's value. -func (s *GroupOrderingIdSummary) SetReceivedAt(v time.Time) *GroupOrderingIdSummary { - s.ReceivedAt = &v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidRequestException) OrigErr() error { + return nil } -// SetStatus sets the Status field's value. -func (s *GroupOrderingIdSummary) SetStatus(v string) *GroupOrderingIdSummary { - s.Status = &v - return s +func (s *InvalidRequestException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } -// Group summary information. -type GroupSummary struct { +// Status code returns the HTTP status code for the request's response error. +func (s *InvalidRequestException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InvalidRequestException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Configuration information for the JSON token type. +type JsonTokenTypeConfiguration struct { _ struct{} `type:"structure"` - // The identifier of the group you want group summary information on. - GroupId *string `min:"1" type:"string"` + // The group attribute field. + // + // GroupAttributeField is a required field + GroupAttributeField *string `min:"1" type:"string" required:"true"` - // The timestamp identifier used for the latest PUT or DELETE action. - OrderingId *int64 `type:"long"` + // The user name attribute field. + // + // UserNameAttributeField is a required field + UserNameAttributeField *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -11732,7 +15660,7 @@ type GroupSummary 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 GroupSummary) String() string { +func (s JsonTokenTypeConfiguration) String() string { return awsutil.Prettify(s) } @@ -11741,34 +15669,70 @@ func (s GroupSummary) 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 GroupSummary) GoString() string { +func (s JsonTokenTypeConfiguration) GoString() string { return s.String() } -// SetGroupId sets the GroupId field's value. -func (s *GroupSummary) SetGroupId(v string) *GroupSummary { - s.GroupId = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *JsonTokenTypeConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "JsonTokenTypeConfiguration"} + if s.GroupAttributeField == nil { + invalidParams.Add(request.NewErrParamRequired("GroupAttributeField")) + } + if s.GroupAttributeField != nil && len(*s.GroupAttributeField) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GroupAttributeField", 1)) + } + if s.UserNameAttributeField == nil { + invalidParams.Add(request.NewErrParamRequired("UserNameAttributeField")) + } + if s.UserNameAttributeField != nil && len(*s.UserNameAttributeField) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserNameAttributeField", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetGroupAttributeField sets the GroupAttributeField field's value. +func (s *JsonTokenTypeConfiguration) SetGroupAttributeField(v string) *JsonTokenTypeConfiguration { + s.GroupAttributeField = &v return s } -// SetOrderingId sets the OrderingId field's value. -func (s *GroupSummary) SetOrderingId(v int64) *GroupSummary { - s.OrderingId = &v +// SetUserNameAttributeField sets the UserNameAttributeField field's value. +func (s *JsonTokenTypeConfiguration) SetUserNameAttributeField(v string) *JsonTokenTypeConfiguration { + s.UserNameAttributeField = &v return s } -// Information to define the hierarchy for which documents users should have -// access to. -type HierarchicalPrincipal struct { +// Configuration information for the JWT token type. +type JwtTokenTypeConfiguration struct { _ struct{} `type:"structure"` - // A list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) - // lists that define the hierarchy for which documents users should have access - // to. Each hierarchical list specifies which user or group has allow or deny - // access for each document. + // The regular expression that identifies the claim. + ClaimRegex *string `min:"1" type:"string"` + + // The group attribute field. + GroupAttributeField *string `min:"1" type:"string"` + + // The issuer of the token. + Issuer *string `min:"1" type:"string"` + + // The location of the key. // - // PrincipalList is a required field - PrincipalList []*Principal `type:"list" required:"true"` + // KeyLocation is a required field + KeyLocation *string `type:"string" required:"true" enum:"KeyLocation"` + + // The Amazon Resource Name (arn) of the secret. + SecretManagerArn *string `type:"string"` + + // The signing key URL. + URL *string `min:"1" type:"string"` + + // The user name attribute field. + UserNameAttributeField *string `min:"1" type:"string"` } // String returns the string representation. @@ -11776,7 +15740,7 @@ type HierarchicalPrincipal 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 HierarchicalPrincipal) String() string { +func (s JwtTokenTypeConfiguration) String() string { return awsutil.Prettify(s) } @@ -11785,25 +15749,30 @@ func (s HierarchicalPrincipal) 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 HierarchicalPrincipal) GoString() string { +func (s JwtTokenTypeConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *HierarchicalPrincipal) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "HierarchicalPrincipal"} - if s.PrincipalList == nil { - invalidParams.Add(request.NewErrParamRequired("PrincipalList")) +func (s *JwtTokenTypeConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "JwtTokenTypeConfiguration"} + if s.ClaimRegex != nil && len(*s.ClaimRegex) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClaimRegex", 1)) } - if s.PrincipalList != nil { - for i, v := range s.PrincipalList { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PrincipalList", i), err.(request.ErrInvalidParams)) - } - } + if s.GroupAttributeField != nil && len(*s.GroupAttributeField) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GroupAttributeField", 1)) + } + if s.Issuer != nil && len(*s.Issuer) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Issuer", 1)) + } + if s.KeyLocation == nil { + invalidParams.Add(request.NewErrParamRequired("KeyLocation")) + } + if s.URL != nil && len(*s.URL) < 1 { + invalidParams.Add(request.NewErrParamMinLen("URL", 1)) + } + if s.UserNameAttributeField != nil && len(*s.UserNameAttributeField) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserNameAttributeField", 1)) } if invalidParams.Len() > 0 { @@ -11812,107 +15781,78 @@ func (s *HierarchicalPrincipal) Validate() error { return nil } -// SetPrincipalList sets the PrincipalList field's value. -func (s *HierarchicalPrincipal) SetPrincipalList(v []*Principal) *HierarchicalPrincipal { - s.PrincipalList = v +// SetClaimRegex sets the ClaimRegex field's value. +func (s *JwtTokenTypeConfiguration) SetClaimRegex(v string) *JwtTokenTypeConfiguration { + s.ClaimRegex = &v return s } -// Provides information that you can use to highlight a search result so that -// your users can quickly identify terms in the response. -type Highlight struct { - _ struct{} `type:"structure"` - - // The zero-based location in the response string where the highlight starts. - // - // BeginOffset is a required field - BeginOffset *int64 `type:"integer" required:"true"` - - // The zero-based location in the response string where the highlight ends. - // - // EndOffset is a required field - EndOffset *int64 `type:"integer" required:"true"` - - // Indicates whether the response is the best response. True if this is the - // best response; otherwise, false. - TopAnswer *bool `type:"boolean"` - - // The highlight type. - Type *string `type:"string" enum:"HighlightType"` -} - -// 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 Highlight) String() string { - return awsutil.Prettify(s) +// SetGroupAttributeField sets the GroupAttributeField field's value. +func (s *JwtTokenTypeConfiguration) SetGroupAttributeField(v string) *JwtTokenTypeConfiguration { + s.GroupAttributeField = &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 Highlight) GoString() string { - return s.String() +// SetIssuer sets the Issuer field's value. +func (s *JwtTokenTypeConfiguration) SetIssuer(v string) *JwtTokenTypeConfiguration { + s.Issuer = &v + return s } -// SetBeginOffset sets the BeginOffset field's value. -func (s *Highlight) SetBeginOffset(v int64) *Highlight { - s.BeginOffset = &v +// SetKeyLocation sets the KeyLocation field's value. +func (s *JwtTokenTypeConfiguration) SetKeyLocation(v string) *JwtTokenTypeConfiguration { + s.KeyLocation = &v return s } -// SetEndOffset sets the EndOffset field's value. -func (s *Highlight) SetEndOffset(v int64) *Highlight { - s.EndOffset = &v +// SetSecretManagerArn sets the SecretManagerArn field's value. +func (s *JwtTokenTypeConfiguration) SetSecretManagerArn(v string) *JwtTokenTypeConfiguration { + s.SecretManagerArn = &v return s } -// SetTopAnswer sets the TopAnswer field's value. -func (s *Highlight) SetTopAnswer(v bool) *Highlight { - s.TopAnswer = &v +// SetURL sets the URL field's value. +func (s *JwtTokenTypeConfiguration) SetURL(v string) *JwtTokenTypeConfiguration { + s.URL = &v return s } -// SetType sets the Type field's value. -func (s *Highlight) SetType(v string) *Highlight { - s.Type = &v +// SetUserNameAttributeField sets the UserNameAttributeField field's value. +func (s *JwtTokenTypeConfiguration) SetUserNameAttributeField(v string) *JwtTokenTypeConfiguration { + s.UserNameAttributeField = &v return s } -// A summary of information about an index. -type IndexConfigurationSummary struct { +type ListDataSourceSyncJobsInput struct { _ struct{} `type:"structure"` - // The Unix timestamp when the index was created. + // The identifier of the data source. // - // CreatedAt is a required field - CreatedAt *time.Time `type:"timestamp" required:"true"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // Indicates whether the index is a enterprise edition index or a developer - // edition index. - Edition *string `type:"string" enum:"IndexEdition"` + // The identifier of the index that contains the data source. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // A unique identifier for the index. Use this to identify the index when you - // are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. - Id *string `min:"36" type:"string"` + // The maximum number of synchronization jobs to return in the response. If + // there are fewer results in the list, this response contains only the actual + // results. + MaxResults *int64 `min:"1" type:"integer"` - // The name of the index. - Name *string `min:"1" type:"string"` + // If the previous response was incomplete (because there is more data to retrieve), + // Amazon Kendra returns a pagination token in the response. You can use this + // pagination token to retrieve the next set of jobs. + NextToken *string `min:"1" type:"string"` - // The current status of the index. When the status is ACTIVE, the index is - // ready to search. - // - // Status is a required field - Status *string `type:"string" required:"true" enum:"IndexStatus"` + // When specified, the synchronization jobs returned in the list are limited + // to jobs between the specified dates. + StartTimeFilter *TimeRange `type:"structure"` - // The Unix timestamp when the index was last updated by the UpdateIndex operation. - // - // UpdatedAt is a required field - UpdatedAt *time.Time `type:"timestamp" required:"true"` + // When specified, only returns synchronization jobs with the Status field equal + // to the specified status. + StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"` } // String returns the string representation. @@ -11920,7 +15860,7 @@ type IndexConfigurationSummary 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 IndexConfigurationSummary) String() string { +func (s ListDataSourceSyncJobsInput) String() string { return awsutil.Prettify(s) } @@ -11929,60 +15869,83 @@ func (s IndexConfigurationSummary) 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 IndexConfigurationSummary) GoString() string { +func (s ListDataSourceSyncJobsInput) GoString() string { return s.String() } -// SetCreatedAt sets the CreatedAt field's value. -func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary { - s.CreatedAt = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDataSourceSyncJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDataSourceSyncJobsInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput { + s.Id = &v return s } -// SetEdition sets the Edition field's value. -func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary { - s.Edition = &v +// SetIndexId sets the IndexId field's value. +func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput { + s.IndexId = &v return s } -// SetId sets the Id field's value. -func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary { - s.Id = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput { + s.MaxResults = &v return s } -// SetName sets the Name field's value. -func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary { - s.Name = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput { + s.NextToken = &v return s } -// SetStatus sets the Status field's value. -func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary { - s.Status = &v +// SetStartTimeFilter sets the StartTimeFilter field's value. +func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput { + s.StartTimeFilter = v return s } -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary { - s.UpdatedAt = &v +// SetStatusFilter sets the StatusFilter field's value. +func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput { + s.StatusFilter = &v return s } -// Provides information about the number of documents and the number of questions -// and answers in an index. -type IndexStatistics struct { +type ListDataSourceSyncJobsOutput struct { _ struct{} `type:"structure"` - // The number of question and answer topics in the index. - // - // FaqStatistics is a required field - FaqStatistics *FaqStatistics `type:"structure" required:"true"` + // A history of synchronization jobs for the data source. + History []*DataSourceSyncJob `type:"list"` - // The number of text documents indexed. - // - // TextDocumentStatistics is a required field - TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"` + // If the response is truncated, Amazon Kendra returns this token that you can + // use in the subsequent request to retrieve the next set of jobs. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -11990,7 +15953,7 @@ type IndexStatistics 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 IndexStatistics) String() string { +func (s ListDataSourceSyncJobsOutput) String() string { return awsutil.Prettify(s) } @@ -11999,27 +15962,37 @@ func (s IndexStatistics) 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 IndexStatistics) GoString() string { +func (s ListDataSourceSyncJobsOutput) GoString() string { return s.String() } -// SetFaqStatistics sets the FaqStatistics field's value. -func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics { - s.FaqStatistics = v +// SetHistory sets the History field's value. +func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput { + s.History = v return s } -// SetTextDocumentStatistics sets the TextDocumentStatistics field's value. -func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics { - s.TextDocumentStatistics = v +// SetNextToken sets the NextToken field's value. +func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput { + s.NextToken = &v return s } -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type ListDataSourcesInput struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"Message" min:"1" type:"string"` + // The identifier of the index that contains the data source. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The maximum number of data sources to return. + MaxResults *int64 `min:"1" type:"integer"` + + // If the previous response was incomplete (because there is more data to retrieve), + // Amazon Kendra returns a pagination token in the response. You can use this + // pagination token to retrieve the next set of data sources (DataSourceSummaryItems). + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -12027,7 +16000,7 @@ type InternalServerException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) String() string { +func (s ListDataSourcesInput) String() string { return awsutil.Prettify(s) } @@ -12036,61 +16009,59 @@ func (s InternalServerException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) GoString() string { +func (s ListDataSourcesInput) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDataSourcesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDataSourcesInput"} + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } -} - -// 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_ + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetIndexId sets the IndexId field's value. +func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput { + s.IndexId = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetMaxResults sets the MaxResults field's value. +func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput { + s.MaxResults = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { - return s.RespMetadata.RequestID +// SetNextToken sets the NextToken field's value. +func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput { + s.NextToken = &v + return s } -// Configuration information for the JSON token type. -type JsonTokenTypeConfiguration struct { +type ListDataSourcesOutput struct { _ struct{} `type:"structure"` - // The group attribute field. - // - // GroupAttributeField is a required field - GroupAttributeField *string `min:"1" type:"string" required:"true"` + // If the response is truncated, Amazon Kendra returns this token that you can + // use in the subsequent request to retrieve the next set of data sources. + NextToken *string `min:"1" type:"string"` - // The user name attribute field. - // - // UserNameAttributeField is a required field - UserNameAttributeField *string `min:"1" type:"string" required:"true"` + // An array of summary information for one or more data sources. + SummaryItems []*DataSourceSummary `type:"list"` } // String returns the string representation. @@ -12098,7 +16069,7 @@ type JsonTokenTypeConfiguration 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 JsonTokenTypeConfiguration) String() string { +func (s ListDataSourcesOutput) String() string { return awsutil.Prettify(s) } @@ -12107,70 +16078,42 @@ func (s JsonTokenTypeConfiguration) 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 JsonTokenTypeConfiguration) GoString() string { +func (s ListDataSourcesOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *JsonTokenTypeConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "JsonTokenTypeConfiguration"} - if s.GroupAttributeField == nil { - invalidParams.Add(request.NewErrParamRequired("GroupAttributeField")) - } - if s.GroupAttributeField != nil && len(*s.GroupAttributeField) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GroupAttributeField", 1)) - } - if s.UserNameAttributeField == nil { - invalidParams.Add(request.NewErrParamRequired("UserNameAttributeField")) - } - if s.UserNameAttributeField != nil && len(*s.UserNameAttributeField) < 1 { - invalidParams.Add(request.NewErrParamMinLen("UserNameAttributeField", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetGroupAttributeField sets the GroupAttributeField field's value. -func (s *JsonTokenTypeConfiguration) SetGroupAttributeField(v string) *JsonTokenTypeConfiguration { - s.GroupAttributeField = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput { + s.NextToken = &v return s } -// SetUserNameAttributeField sets the UserNameAttributeField field's value. -func (s *JsonTokenTypeConfiguration) SetUserNameAttributeField(v string) *JsonTokenTypeConfiguration { - s.UserNameAttributeField = &v +// SetSummaryItems sets the SummaryItems field's value. +func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput { + s.SummaryItems = v return s } -// Configuration information for the JWT token type. -type JwtTokenTypeConfiguration struct { +type ListEntityPersonasInput struct { _ struct{} `type:"structure"` - // The regular expression that identifies the claim. - ClaimRegex *string `min:"1" type:"string"` - - // The group attribute field. - GroupAttributeField *string `min:"1" type:"string"` - - // The issuer of the token. - Issuer *string `min:"1" type:"string"` - - // The location of the key. + // The identifier of your Amazon Kendra experience. // - // KeyLocation is a required field - KeyLocation *string `type:"string" required:"true" enum:"KeyLocation"` + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` - // The Amazon Resource Name (arn) of the secret. - SecretManagerArn *string `min:"1" type:"string"` + // The identifier of the index for your Amazon Kendra experience. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` - // The signing key URL. - URL *string `min:"1" type:"string"` + // The maximum number of returned users or groups. + MaxResults *int64 `min:"1" type:"integer"` - // The user name attribute field. - UserNameAttributeField *string `min:"1" type:"string"` + // If the previous response was incomplete (because there is more data to retrieve), + // Amazon Kendra returns a pagination token in the response. You can use this + // pagination token to retrieve the next set of users or groups. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -12178,7 +16121,7 @@ type JwtTokenTypeConfiguration 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 JwtTokenTypeConfiguration) String() string { +func (s ListEntityPersonasInput) String() string { return awsutil.Prettify(s) } @@ -12187,33 +16130,30 @@ func (s JwtTokenTypeConfiguration) 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 JwtTokenTypeConfiguration) GoString() string { +func (s ListEntityPersonasInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *JwtTokenTypeConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "JwtTokenTypeConfiguration"} - if s.ClaimRegex != nil && len(*s.ClaimRegex) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClaimRegex", 1)) - } - if s.GroupAttributeField != nil && len(*s.GroupAttributeField) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GroupAttributeField", 1)) +func (s *ListEntityPersonasInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEntityPersonasInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.Issuer != nil && len(*s.Issuer) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Issuer", 1)) + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) } - if s.KeyLocation == nil { - invalidParams.Add(request.NewErrParamRequired("KeyLocation")) + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) } - if s.SecretManagerArn != nil && len(*s.SecretManagerArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecretManagerArn", 1)) + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.URL != nil && len(*s.URL) < 1 { - invalidParams.Add(request.NewErrParamMinLen("URL", 1)) + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.UserNameAttributeField != nil && len(*s.UserNameAttributeField) < 1 { - invalidParams.Add(request.NewErrParamMinLen("UserNameAttributeField", 1)) + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -12222,78 +16162,88 @@ func (s *JwtTokenTypeConfiguration) Validate() error { return nil } -// SetClaimRegex sets the ClaimRegex field's value. -func (s *JwtTokenTypeConfiguration) SetClaimRegex(v string) *JwtTokenTypeConfiguration { - s.ClaimRegex = &v +// SetId sets the Id field's value. +func (s *ListEntityPersonasInput) SetId(v string) *ListEntityPersonasInput { + s.Id = &v return s } -// SetGroupAttributeField sets the GroupAttributeField field's value. -func (s *JwtTokenTypeConfiguration) SetGroupAttributeField(v string) *JwtTokenTypeConfiguration { - s.GroupAttributeField = &v +// SetIndexId sets the IndexId field's value. +func (s *ListEntityPersonasInput) SetIndexId(v string) *ListEntityPersonasInput { + s.IndexId = &v return s } -// SetIssuer sets the Issuer field's value. -func (s *JwtTokenTypeConfiguration) SetIssuer(v string) *JwtTokenTypeConfiguration { - s.Issuer = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListEntityPersonasInput) SetMaxResults(v int64) *ListEntityPersonasInput { + s.MaxResults = &v return s } -// SetKeyLocation sets the KeyLocation field's value. -func (s *JwtTokenTypeConfiguration) SetKeyLocation(v string) *JwtTokenTypeConfiguration { - s.KeyLocation = &v +// SetNextToken sets the NextToken field's value. +func (s *ListEntityPersonasInput) SetNextToken(v string) *ListEntityPersonasInput { + s.NextToken = &v return s } -// SetSecretManagerArn sets the SecretManagerArn field's value. -func (s *JwtTokenTypeConfiguration) SetSecretManagerArn(v string) *JwtTokenTypeConfiguration { - s.SecretManagerArn = &v - return s +type ListEntityPersonasOutput struct { + _ struct{} `type:"structure"` + + // If the response is truncated, Amazon Kendra returns this token, which you + // can use in a later request to retrieve the next set of users or groups. + NextToken *string `min:"1" type:"string"` + + // An array of summary information for one or more users or groups. + SummaryItems []*PersonasSummary `type:"list"` } -// SetURL sets the URL field's value. -func (s *JwtTokenTypeConfiguration) SetURL(v string) *JwtTokenTypeConfiguration { - s.URL = &v +// 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 ListEntityPersonasOutput) 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 ListEntityPersonasOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEntityPersonasOutput) SetNextToken(v string) *ListEntityPersonasOutput { + s.NextToken = &v return s } -// SetUserNameAttributeField sets the UserNameAttributeField field's value. -func (s *JwtTokenTypeConfiguration) SetUserNameAttributeField(v string) *JwtTokenTypeConfiguration { - s.UserNameAttributeField = &v +// SetSummaryItems sets the SummaryItems field's value. +func (s *ListEntityPersonasOutput) SetSummaryItems(v []*PersonasSummary) *ListEntityPersonasOutput { + s.SummaryItems = v return s } -type ListDataSourceSyncJobsInput struct { +type ListExperienceEntitiesInput struct { _ struct{} `type:"structure"` - // The identifier of the data source. + // The identifier of your Amazon Kendra experience. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index that contains the data source. + // The identifier of the index for your Amazon Kendra experience. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` - // The maximum number of synchronization jobs to return in the response. If - // there are fewer results in the list, this response contains only the actual - // results. - MaxResults *int64 `min:"1" type:"integer"` - // If the previous response was incomplete (because there is more data to retrieve), // Amazon Kendra returns a pagination token in the response. You can use this - // pagination token to retrieve the next set of jobs. + // pagination token to retrieve the next set of users or groups. NextToken *string `min:"1" type:"string"` - - // When specified, the synchronization jobs returned in the list are limited - // to jobs between the specified dates. - StartTimeFilter *TimeRange `type:"structure"` - - // When specified, only returns synchronization jobs with the Status field equal - // to the specified status. - StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"` } // String returns the string representation. @@ -12301,7 +16251,7 @@ type ListDataSourceSyncJobsInput 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 ListDataSourceSyncJobsInput) String() string { +func (s ListExperienceEntitiesInput) String() string { return awsutil.Prettify(s) } @@ -12310,13 +16260,13 @@ func (s ListDataSourceSyncJobsInput) 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 ListDataSourceSyncJobsInput) GoString() string { +func (s ListExperienceEntitiesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDataSourceSyncJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDataSourceSyncJobsInput"} +func (s *ListExperienceEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExperienceEntitiesInput"} if s.Id == nil { invalidParams.Add(request.NewErrParamRequired("Id")) } @@ -12329,9 +16279,6 @@ func (s *ListDataSourceSyncJobsInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) - } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } @@ -12343,50 +16290,32 @@ func (s *ListDataSourceSyncJobsInput) Validate() error { } // SetId sets the Id field's value. -func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput { +func (s *ListExperienceEntitiesInput) SetId(v string) *ListExperienceEntitiesInput { s.Id = &v return s } // SetIndexId sets the IndexId field's value. -func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput { +func (s *ListExperienceEntitiesInput) SetIndexId(v string) *ListExperienceEntitiesInput { s.IndexId = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput { - s.MaxResults = &v - return s -} - // SetNextToken sets the NextToken field's value. -func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput { +func (s *ListExperienceEntitiesInput) SetNextToken(v string) *ListExperienceEntitiesInput { s.NextToken = &v return s } -// SetStartTimeFilter sets the StartTimeFilter field's value. -func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput { - s.StartTimeFilter = v - return s -} - -// SetStatusFilter sets the StatusFilter field's value. -func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput { - s.StatusFilter = &v - return s -} - -type ListDataSourceSyncJobsOutput struct { +type ListExperienceEntitiesOutput struct { _ struct{} `type:"structure"` - // A history of synchronization jobs for the data source. - History []*DataSourceSyncJob `type:"list"` - - // If the response is truncated, Amazon Kendra returns this token that you can - // use in the subsequent request to retrieve the next set of jobs. + // If the response is truncated, Amazon Kendra returns this token, which you + // can use in a later request to retrieve the next set of users or groups. NextToken *string `min:"1" type:"string"` + + // An array of summary information for one or more users or groups. + SummaryItems []*ExperienceEntitiesSummary `type:"list"` } // String returns the string representation. @@ -12394,7 +16323,7 @@ type ListDataSourceSyncJobsOutput 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 ListDataSourceSyncJobsOutput) String() string { +func (s ListExperienceEntitiesOutput) String() string { return awsutil.Prettify(s) } @@ -12403,36 +16332,36 @@ func (s ListDataSourceSyncJobsOutput) 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 ListDataSourceSyncJobsOutput) GoString() string { +func (s ListExperienceEntitiesOutput) GoString() string { return s.String() } -// SetHistory sets the History field's value. -func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput { - s.History = v +// SetNextToken sets the NextToken field's value. +func (s *ListExperienceEntitiesOutput) SetNextToken(v string) *ListExperienceEntitiesOutput { + s.NextToken = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput { - s.NextToken = &v +// SetSummaryItems sets the SummaryItems field's value. +func (s *ListExperienceEntitiesOutput) SetSummaryItems(v []*ExperienceEntitiesSummary) *ListExperienceEntitiesOutput { + s.SummaryItems = v return s } -type ListDataSourcesInput struct { +type ListExperiencesInput struct { _ struct{} `type:"structure"` - // The identifier of the index that contains the data source. + // The identifier of the index for your Amazon Kendra experience. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` - // The maximum number of data sources to return. + // The maximum number of returned Amazon Kendra experiences. MaxResults *int64 `min:"1" type:"integer"` // If the previous response was incomplete (because there is more data to retrieve), // Amazon Kendra returns a pagination token in the response. You can use this - // pagination token to retrieve the next set of data sources (DataSourceSummaryItems). + // pagination token to retrieve the next set of Amazon Kendra experiences. NextToken *string `min:"1" type:"string"` } @@ -12441,7 +16370,7 @@ type ListDataSourcesInput 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 ListDataSourcesInput) String() string { +func (s ListExperiencesInput) String() string { return awsutil.Prettify(s) } @@ -12450,13 +16379,13 @@ func (s ListDataSourcesInput) 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 ListDataSourcesInput) GoString() string { +func (s ListExperiencesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDataSourcesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDataSourcesInput"} +func (s *ListExperiencesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExperiencesInput"} if s.IndexId == nil { invalidParams.Add(request.NewErrParamRequired("IndexId")) } @@ -12477,32 +16406,32 @@ func (s *ListDataSourcesInput) Validate() error { } // SetIndexId sets the IndexId field's value. -func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput { +func (s *ListExperiencesInput) SetIndexId(v string) *ListExperiencesInput { s.IndexId = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput { +func (s *ListExperiencesInput) SetMaxResults(v int64) *ListExperiencesInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput { +func (s *ListExperiencesInput) SetNextToken(v string) *ListExperiencesInput { s.NextToken = &v return s } -type ListDataSourcesOutput struct { +type ListExperiencesOutput struct { _ struct{} `type:"structure"` - // If the response is truncated, Amazon Kendra returns this token that you can - // use in the subsequent request to retrieve the next set of data sources. + // If the response is truncated, Amazon Kendra returns this token, which you + // can use in a later request to retrieve the next set of Amazon Kendra experiences. NextToken *string `min:"1" type:"string"` - // An array of summary information for one or more data sources. - SummaryItems []*DataSourceSummary `type:"list"` + // An array of summary information for one or more Amazon Kendra experiences. + SummaryItems []*ExperiencesSummary `type:"list"` } // String returns the string representation. @@ -12510,7 +16439,7 @@ type ListDataSourcesOutput 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 ListDataSourcesOutput) String() string { +func (s ListExperiencesOutput) String() string { return awsutil.Prettify(s) } @@ -12519,18 +16448,18 @@ func (s ListDataSourcesOutput) 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 ListDataSourcesOutput) GoString() string { +func (s ListExperiencesOutput) GoString() string { return s.String() } // SetNextToken sets the NextToken field's value. -func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput { +func (s *ListExperiencesOutput) SetNextToken(v string) *ListExperiencesOutput { s.NextToken = &v return s } // SetSummaryItems sets the SummaryItems field's value. -func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput { +func (s *ListExperiencesOutput) SetSummaryItems(v []*ExperiencesSummary) *ListExperiencesOutput { s.SummaryItems = v return s } @@ -13520,33 +17449,101 @@ func (s OneDriveUsers) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *OneDriveUsers) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "OneDriveUsers"} - if s.OneDriveUserList != nil && len(s.OneDriveUserList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("OneDriveUserList", 1)) - } - if s.OneDriveUserS3Path != nil { - if err := s.OneDriveUserS3Path.Validate(); err != nil { - invalidParams.AddNested("OneDriveUserS3Path", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// Validate inspects the fields of the type to determine if they are valid. +func (s *OneDriveUsers) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OneDriveUsers"} + if s.OneDriveUserList != nil && len(s.OneDriveUserList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OneDriveUserList", 1)) + } + if s.OneDriveUserS3Path != nil { + if err := s.OneDriveUserS3Path.Validate(); err != nil { + invalidParams.AddNested("OneDriveUserS3Path", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOneDriveUserList sets the OneDriveUserList field's value. +func (s *OneDriveUsers) SetOneDriveUserList(v []*string) *OneDriveUsers { + s.OneDriveUserList = v + return s +} + +// SetOneDriveUserS3Path sets the OneDriveUserS3Path field's value. +func (s *OneDriveUsers) SetOneDriveUserS3Path(v *S3Path) *OneDriveUsers { + s.OneDriveUserS3Path = v + return s +} + +// Summary information for users or groups in your Amazon Web Services SSO identity +// source. This applies to users and groups with specific permissions that define +// their level of access to your Amazon Kendra experience. You can create an +// Amazon Kendra experience such as a search application. For more information +// on creating a search application experience, see Building a search experience +// with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +type PersonasSummary struct { + _ struct{} `type:"structure"` + + // The date-time the summary information was created. + CreatedAt *time.Time `type:"timestamp"` + + // The identifier of a user or group in your Amazon Web Services SSO identity + // source. For example, a user ID could be an email. + EntityId *string `min:"1" type:"string"` + + // The persona that defines the specific permissions of the user or group in + // your Amazon Web Services SSO identity source. The available personas or access + // roles are Owner and Viewer. For more information on these personas, see Providing + // access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + Persona *string `type:"string" enum:"Persona"` + + // The date-time the summary information was last updated. + UpdatedAt *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 PersonasSummary) 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 PersonasSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *PersonasSummary) SetCreatedAt(v time.Time) *PersonasSummary { + s.CreatedAt = &v + return s +} + +// SetEntityId sets the EntityId field's value. +func (s *PersonasSummary) SetEntityId(v string) *PersonasSummary { + s.EntityId = &v + return s } -// SetOneDriveUserList sets the OneDriveUserList field's value. -func (s *OneDriveUsers) SetOneDriveUserList(v []*string) *OneDriveUsers { - s.OneDriveUserList = v +// SetPersona sets the Persona field's value. +func (s *PersonasSummary) SetPersona(v string) *PersonasSummary { + s.Persona = &v return s } -// SetOneDriveUserS3Path sets the OneDriveUserS3Path field's value. -func (s *OneDriveUsers) SetOneDriveUserS3Path(v *S3Path) *OneDriveUsers { - s.OneDriveUserS3Path = v +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *PersonasSummary) SetUpdatedAt(v time.Time) *PersonasSummary { + s.UpdatedAt = &v return s } @@ -13645,7 +17642,7 @@ func (s *Principal) SetType(v string) *Principal { type ProxyConfiguration struct { _ struct{} `type:"structure"` - // Your secret ARN, which you can create in AWS Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) // // The credentials are optional. You use a secret if web proxy credentials are // required to connect to a website host. Amazon Kendra currently support basic @@ -13787,7 +17784,7 @@ type PutPrincipalMappingInput struct { // contains your list of users or sub groups that belong to a group. // // For more information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds). - RoleArn *string `min:"1" type:"string"` + RoleArn *string `type:"string"` } // String returns the string representation. @@ -13829,9 +17826,6 @@ func (s *PutPrincipalMappingInput) Validate() error { if s.IndexId != nil && len(*s.IndexId) < 36 { invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } if s.GroupMembers != nil { if err := s.GroupMembers.Validate(); err != nil { invalidParams.AddNested("GroupMembers", err.(request.ErrInvalidParams)) @@ -15899,7 +19893,7 @@ func (s *Search) SetSortable(v bool) *Search { // // When selecting websites to index, you must adhere to the Amazon Acceptable // Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember -// that you must only use the Amazon Kendra web crawler to index your own webpages, +// that you must only use Amazon Kendra Web Crawler to index your own webpages, // or webpages that you have authorization to index. type SeedUrlConfiguration struct { _ struct{} `type:"structure"` @@ -16029,10 +20023,10 @@ type ServiceNowConfiguration struct { // Determines the type of authentication used to connect to the ServiceNow instance. // If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name - // and password provided in the AWS Secrets Manager secret in the SecretArn - // field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth - // token and secret provided in the Secrets Manager secret, and the user name - // and password are used to determine which information Amazon Kendra has access + // and password provided in the Secrets Manager secret in the SecretArn field. + // When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token + // and secret provided in the Secrets Manager secret, and the user name and + // password are used to determine which information Amazon Kendra has access // to. // // When you use OAUTH2 authentication, you must generate a token and a client @@ -16523,7 +20517,7 @@ type SharePointConfiguration struct { // The credentials should be a user/password pair. If you use SharePoint Server, // you also need to provide the sever domain name as part of the credentials. // For more information, see Using a Microsoft SharePoint Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html). - // For more information about Secrets Manager, see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // For more information about Secrets Manager see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) // in the Secrets Manager user guide. // // SecretArn is a required field @@ -16699,7 +20693,7 @@ func (s *SharePointConfiguration) SetVpcConfiguration(v *DataSourceVpcConfigurat // // When selecting websites to index, you must adhere to the Amazon Acceptable // Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember -// that you must only use the Amazon Kendra web crawler to index your own webpages, +// that you must only use Amazon Kendra Web Crawler to index your own webpages, // or webpages that you have authorization to index. type SiteMapsConfiguration struct { _ struct{} `type:"structure"` @@ -17936,9 +21930,17 @@ func (s UntagResourceOutput) GoString() string { type UpdateDataSourceInput struct { _ struct{} `type:"structure"` - // Configuration information for a Amazon Kendra data source. + // Configuration information for an Amazon Kendra data source. Configuration *DataSourceConfiguration `type:"structure"` + // Configuration information for altering document metadata and content during + // the document ingestion process when you update a data source. + // + // For more information on how to create, modify and delete document metadata, + // or make other content alterations when you ingest documents into Amazon Kendra, + // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"` + // The new description for the data source. Description *string `type:"string"` @@ -17965,7 +21967,7 @@ type UpdateDataSourceInput struct { // The Amazon Resource Name (ARN) of the new role to use when the data source // is accessing resources on your behalf. - RoleArn *string `min:"1" type:"string"` + RoleArn *string `type:"string"` // The new update schedule for the data source. Schedule *string `type:"string"` @@ -18010,14 +22012,16 @@ func (s *UpdateDataSourceInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } if s.Configuration != nil { if err := s.Configuration.Validate(); err != nil { invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) } } + if s.CustomDocumentEnrichmentConfiguration != nil { + if err := s.CustomDocumentEnrichmentConfiguration.Validate(); err != nil { + invalidParams.AddNested("CustomDocumentEnrichmentConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -18031,6 +22035,12 @@ func (s *UpdateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *Up return s } +// SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value. +func (s *UpdateDataSourceInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *UpdateDataSourceInput { + s.CustomDocumentEnrichmentConfiguration = v + return s +} + // SetDescription sets the Description field's value. func (s *UpdateDataSourceInput) SetDescription(v string) *UpdateDataSourceInput { s.Description = &v @@ -18095,6 +22105,144 @@ func (s UpdateDataSourceOutput) GoString() string { return s.String() } +type UpdateExperienceInput struct { + _ struct{} `type:"structure"` + + // Provides the user configuration information. This includes the Amazon Web + // Services SSO field name that contains the identifiers of your users, such + // as their emails. + Configuration *ExperienceConfiguration `type:"structure"` + + // The description of your Amazon Kendra experience you want to update. + Description *string `type:"string"` + + // The identifier of your Amazon Kendra experience you want to update. + // + // Id is a required field + Id *string `min:"1" type:"string" required:"true"` + + // The identifier of the index for your Amazon Kendra experience you want to + // update. + // + // IndexId is a required field + IndexId *string `min:"36" type:"string" required:"true"` + + // The name of your Amazon Kendra experience you want to update. + Name *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of a role with permission to access Query + // operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon + // Web Services SSO that stores your user and group information. For more information, + // see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + RoleArn *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 UpdateExperienceInput) 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 UpdateExperienceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateExperienceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateExperienceInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.IndexId == nil { + invalidParams.Add(request.NewErrParamRequired("IndexId")) + } + if s.IndexId != nil && len(*s.IndexId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("IndexId", 36)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Configuration != nil { + if err := s.Configuration.Validate(); err != nil { + invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfiguration sets the Configuration field's value. +func (s *UpdateExperienceInput) SetConfiguration(v *ExperienceConfiguration) *UpdateExperienceInput { + s.Configuration = v + return s +} + +// SetDescription sets the Description field's value. +func (s *UpdateExperienceInput) SetDescription(v string) *UpdateExperienceInput { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *UpdateExperienceInput) SetId(v string) *UpdateExperienceInput { + s.Id = &v + return s +} + +// SetIndexId sets the IndexId field's value. +func (s *UpdateExperienceInput) SetIndexId(v string) *UpdateExperienceInput { + s.IndexId = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateExperienceInput) SetName(v string) *UpdateExperienceInput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *UpdateExperienceInput) SetRoleArn(v string) *UpdateExperienceInput { + s.RoleArn = &v + return s +} + +type UpdateExperienceOutput 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 UpdateExperienceOutput) 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 UpdateExperienceOutput) GoString() string { + return s.String() +} + type UpdateIndexInput struct { _ struct{} `type:"structure"` @@ -18122,13 +22270,13 @@ type UpdateIndexInput struct { // A new IAM role that gives Amazon Kendra permission to access your Amazon // CloudWatch logs. - RoleArn *string `min:"1" type:"string"` + RoleArn *string `type:"string"` // The user context policy. UserContextPolicy *string `type:"string" enum:"UserContextPolicy"` - // Enables fetching access levels of groups and users from an AWS Single Sign-On - // identity source. To configure this, see UserGroupResolutionConfiguration + // Enables fetching access levels of groups and users from an Amazon Web Services + // Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"` @@ -18166,9 +22314,6 @@ func (s *UpdateIndexInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } if s.CapacityUnits != nil { if err := s.CapacityUnits.Validate(); err != nil { invalidParams.AddNested("CapacityUnits", err.(request.ErrInvalidParams)) @@ -18303,7 +22448,7 @@ type UpdateQuerySuggestionsBlockListInput struct { // The IAM (Identity and Access Management) role used to access the block list // text file in S3. - RoleArn *string `min:"1" type:"string"` + RoleArn *string `type:"string"` // The S3 path where your block list text file sits in S3. // @@ -18354,9 +22499,6 @@ func (s *UpdateQuerySuggestionsBlockListInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } if s.SourceS3Path != nil { if err := s.SourceS3Path.Validate(); err != nil { invalidParams.AddNested("SourceS3Path", err.(request.ErrInvalidParams)) @@ -18607,7 +22749,7 @@ type UpdateThesaurusInput struct { Name *string `min:"1" type:"string"` // The updated role ARN of the thesaurus. - RoleArn *string `min:"1" type:"string"` + RoleArn *string `type:"string"` // Information required to find a specific file in an Amazon S3 bucket. SourceS3Path *S3Path `type:"structure"` @@ -18649,9 +22791,6 @@ func (s *UpdateThesaurusInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.RoleArn != nil && len(*s.RoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) - } if s.SourceS3Path != nil { if err := s.SourceS3Path.Validate(); err != nil { invalidParams.AddNested("SourceS3Path", err.(request.ErrInvalidParams)) @@ -18730,7 +22869,7 @@ func (s UpdateThesaurusOutput) GoString() string { // // When selecting websites to index, you must adhere to the Amazon Acceptable // Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember -// that you must only use the Amazon Kendra web crawler to index your own webpages, +// that you must only use Amazon Kendra Web Crawler to index your own webpages, // or webpages that you have authorization to index. type Urls struct { _ struct{} `type:"structure"` @@ -18911,23 +23050,25 @@ func (s *UserContext) SetUserId(v string) *UserContext { } // Provides the configuration information to fetch access levels of groups and -// users from an AWS Single Sign-On identity source. This is useful for setting -// up user context filtering, where Amazon Kendra filters search results for -// different users based on their group's access to documents. You can also -// map your users to their groups for user context filtering using the PutPrincipalMapping -// operation (https://docs.aws.amazon.com/latest/dg/API_PutPrincipalMapping.html). -// -// To set up an AWS SSO identity source in the console to use with Amazon Kendra, -// see Getting started with an AWS SSO identity source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). -// You must also grant the required permissions to use AWS SSO with Amazon Kendra. -// For more information, see IAM roles for AWS Single Sign-On (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso). +// users from an Amazon Web Services Single Sign On identity source. This is +// useful for setting up user context filtering, where Amazon Kendra filters +// search results for different users based on their group's access to documents. +// You can also map your users to their groups for user context filtering using +// the PutPrincipalMapping operation (https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html). +// +// To set up an Amazon Web Services SSO identity source in the console to use +// with Amazon Kendra, see Getting started with an Amazon Web Services SSO identity +// source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). +// You must also grant the required permissions to use Amazon Web Services SSO +// with Amazon Kendra. For more information, see IAM roles for Amazon Web Services +// SSO (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso). type UserGroupResolutionConfiguration struct { _ struct{} `type:"structure"` // The identity store provider (mode) you want to use to fetch access levels - // of groups and users. AWS Single Sign-On is currently the only available mode. - // Your users and groups must exist in an AWS SSO identity source in order to - // use this mode. + // of groups and users. Amazon Web Services Single Sign On is currently the + // only available mode. Your users and groups must exist in an Amazon Web Services + // SSO identity source in order to use this mode. // // UserGroupResolutionMode is a required field UserGroupResolutionMode *string `type:"string" required:"true" enum:"UserGroupResolutionMode"` @@ -18970,6 +23111,57 @@ func (s *UserGroupResolutionConfiguration) SetUserGroupResolutionMode(v string) return s } +// Configuration information for the identifiers of your users. +type UserIdentityConfiguration struct { + _ struct{} `type:"structure"` + + // The Amazon Web Services SSO field name that contains the identifiers of your + // users, such as their emails. This is used for user context filtering (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) + // and for granting access to your Amazon Kendra experience. You must set up + // Amazon Web Services SSO with Amazon Kendra. You must include your users and + // groups in your Access Control List when you ingest documents into your index. + // For more information, see Getting started with an Amazon Web Services SSO + // identity source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). + IdentityAttributeName *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 UserIdentityConfiguration) 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 UserIdentityConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UserIdentityConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UserIdentityConfiguration"} + if s.IdentityAttributeName != nil && len(*s.IdentityAttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IdentityAttributeName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentityAttributeName sets the IdentityAttributeName field's value. +func (s *UserIdentityConfiguration) SetIdentityAttributeName(v string) *UserIdentityConfiguration { + s.IdentityAttributeName = &v + return s +} + // Provides configuration information for a token configuration. type UserTokenConfiguration struct { _ struct{} `type:"structure"` @@ -19094,7 +23286,7 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } -// Provides the configuration information required for Amazon Kendra web crawler. +// Provides the configuration information required for Amazon Kendra Web Crawler. type WebCrawlerConfiguration struct { _ struct{} `type:"structure"` @@ -19105,8 +23297,8 @@ type WebCrawlerConfiguration struct { // // You must provide the website host name and port number. For example, the // host name of https://a.example.com/page1.html is "a.example.com" and the - // port is 443, the standard port for HTTPS. You use a secret in AWS Secrets - // Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // port is 443, the standard port for HTTPS. You use a secret in Secrets Manager + // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) // to store your authentication credentials. AuthenticationConfiguration *AuthenticationConfiguration `type:"structure"` @@ -19154,7 +23346,7 @@ type WebCrawlerConfiguration struct { // // Web proxy credentials are optional and you can use them to connect to a web // proxy server that requires basic authentication. To store web proxy credentials, - // you use a secret in AWS Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). + // you use a secret in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). ProxyConfiguration *ProxyConfiguration `type:"structure"` // The regular expression pattern to exclude certain URLs to crawl. @@ -19181,7 +23373,7 @@ type WebCrawlerConfiguration struct { // // When selecting websites to index, you must adhere to the Amazon Acceptable // Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember - // that you must only use the Amazon Kendra web crawler to index your own webpages, + // that you must only use Amazon Kendra Web Crawler to index your own webpages, // or webpages that you have authorization to index. // // Urls is a required field @@ -19337,10 +23529,10 @@ type WorkDocsConfiguration struct { // The identifier of the directory corresponding to your Amazon WorkDocs site // repository. // - // You can find the organization ID in the AWS Directory Service (https://console.aws.amazon.com/directoryservicev2/) + // You can find the organization ID in the Directory Service (https://console.aws.amazon.com/directoryservicev2/) // by going to Active Directory, then Directories. Your Amazon WorkDocs site // directory has an ID, which is the organization ID. You can also set up a - // new Amazon WorkDocs directory in the AWS Directory Service console and enable + // new Amazon WorkDocs directory in the Directory Service console and enable // a Amazon WorkDocs site for the directory in the Amazon WorkDocs console. // // OrganizationId is a required field @@ -19452,6 +23644,58 @@ func AdditionalResultAttributeValueType_Values() []string { } } +const ( + // ConditionOperatorGreaterThan is a ConditionOperator enum value + ConditionOperatorGreaterThan = "GreaterThan" + + // ConditionOperatorGreaterThanOrEquals is a ConditionOperator enum value + ConditionOperatorGreaterThanOrEquals = "GreaterThanOrEquals" + + // ConditionOperatorLessThan is a ConditionOperator enum value + ConditionOperatorLessThan = "LessThan" + + // ConditionOperatorLessThanOrEquals is a ConditionOperator enum value + ConditionOperatorLessThanOrEquals = "LessThanOrEquals" + + // ConditionOperatorEquals is a ConditionOperator enum value + ConditionOperatorEquals = "Equals" + + // ConditionOperatorNotEquals is a ConditionOperator enum value + ConditionOperatorNotEquals = "NotEquals" + + // ConditionOperatorContains is a ConditionOperator enum value + ConditionOperatorContains = "Contains" + + // ConditionOperatorNotContains is a ConditionOperator enum value + ConditionOperatorNotContains = "NotContains" + + // ConditionOperatorExists is a ConditionOperator enum value + ConditionOperatorExists = "Exists" + + // ConditionOperatorNotExists is a ConditionOperator enum value + ConditionOperatorNotExists = "NotExists" + + // ConditionOperatorBeginsWith is a ConditionOperator enum value + ConditionOperatorBeginsWith = "BeginsWith" +) + +// ConditionOperator_Values returns all elements of the ConditionOperator enum +func ConditionOperator_Values() []string { + return []string{ + ConditionOperatorGreaterThan, + ConditionOperatorGreaterThanOrEquals, + ConditionOperatorLessThan, + ConditionOperatorLessThanOrEquals, + ConditionOperatorEquals, + ConditionOperatorNotEquals, + ConditionOperatorContains, + ConditionOperatorNotContains, + ConditionOperatorExists, + ConditionOperatorNotExists, + ConditionOperatorBeginsWith, + } +} + const ( // ConfluenceAttachmentFieldNameAuthor is a ConfluenceAttachmentFieldName enum value ConfluenceAttachmentFieldNameAuthor = "AUTHOR" @@ -19868,6 +24112,34 @@ func DocumentStatus_Values() []string { } } +const ( + // EndpointTypeHome is a EndpointType enum value + EndpointTypeHome = "HOME" +) + +// EndpointType_Values returns all elements of the EndpointType enum +func EndpointType_Values() []string { + return []string{ + EndpointTypeHome, + } +} + +const ( + // EntityTypeUser is a EntityType enum value + EntityTypeUser = "USER" + + // EntityTypeGroup is a EntityType enum value + EntityTypeGroup = "GROUP" +) + +// EntityType_Values returns all elements of the EntityType enum +func EntityType_Values() []string { + return []string{ + EntityTypeUser, + EntityTypeGroup, + } +} + const ( // ErrorCodeInternalError is a ErrorCode enum value ErrorCodeInternalError = "InternalError" @@ -19884,6 +24156,30 @@ func ErrorCode_Values() []string { } } +const ( + // ExperienceStatusCreating is a ExperienceStatus enum value + ExperienceStatusCreating = "CREATING" + + // ExperienceStatusActive is a ExperienceStatus enum value + ExperienceStatusActive = "ACTIVE" + + // ExperienceStatusDeleting is a ExperienceStatus enum value + ExperienceStatusDeleting = "DELETING" + + // ExperienceStatusFailed is a ExperienceStatus enum value + ExperienceStatusFailed = "FAILED" +) + +// ExperienceStatus_Values returns all elements of the ExperienceStatus enum +func ExperienceStatus_Values() []string { + return []string{ + ExperienceStatusCreating, + ExperienceStatusActive, + ExperienceStatusDeleting, + ExperienceStatusFailed, + } +} + const ( // FaqFileFormatCsv is a FaqFileFormat enum value FaqFileFormatCsv = "CSV" @@ -19996,6 +24292,38 @@ func IndexStatus_Values() []string { } } +const ( + // IntervalThisMonth is a Interval enum value + IntervalThisMonth = "THIS_MONTH" + + // IntervalThisWeek is a Interval enum value + IntervalThisWeek = "THIS_WEEK" + + // IntervalOneWeekAgo is a Interval enum value + IntervalOneWeekAgo = "ONE_WEEK_AGO" + + // IntervalTwoWeeksAgo is a Interval enum value + IntervalTwoWeeksAgo = "TWO_WEEKS_AGO" + + // IntervalOneMonthAgo is a Interval enum value + IntervalOneMonthAgo = "ONE_MONTH_AGO" + + // IntervalTwoMonthsAgo is a Interval enum value + IntervalTwoMonthsAgo = "TWO_MONTHS_AGO" +) + +// Interval_Values returns all elements of the Interval enum +func Interval_Values() []string { + return []string{ + IntervalThisMonth, + IntervalThisWeek, + IntervalOneWeekAgo, + IntervalTwoWeeksAgo, + IntervalOneMonthAgo, + IntervalTwoMonthsAgo, + } +} + const ( // KeyLocationUrl is a KeyLocation enum value KeyLocationUrl = "URL" @@ -20012,6 +24340,38 @@ func KeyLocation_Values() []string { } } +const ( + // MetricTypeQueriesByCount is a MetricType enum value + MetricTypeQueriesByCount = "QUERIES_BY_COUNT" + + // MetricTypeQueriesByZeroClickRate is a MetricType enum value + MetricTypeQueriesByZeroClickRate = "QUERIES_BY_ZERO_CLICK_RATE" + + // MetricTypeQueriesByZeroResultRate is a MetricType enum value + MetricTypeQueriesByZeroResultRate = "QUERIES_BY_ZERO_RESULT_RATE" + + // MetricTypeDocsByClickCount is a MetricType enum value + MetricTypeDocsByClickCount = "DOCS_BY_CLICK_COUNT" + + // MetricTypeAggQueryDocMetrics is a MetricType enum value + MetricTypeAggQueryDocMetrics = "AGG_QUERY_DOC_METRICS" + + // MetricTypeTrendQueryDocMetrics is a MetricType enum value + MetricTypeTrendQueryDocMetrics = "TREND_QUERY_DOC_METRICS" +) + +// MetricType_Values returns all elements of the MetricType enum +func MetricType_Values() []string { + return []string{ + MetricTypeQueriesByCount, + MetricTypeQueriesByZeroClickRate, + MetricTypeQueriesByZeroResultRate, + MetricTypeDocsByClickCount, + MetricTypeAggQueryDocMetrics, + MetricTypeTrendQueryDocMetrics, + } +} + const ( // ModeEnabled is a Mode enum value ModeEnabled = "ENABLED" @@ -20044,6 +24404,22 @@ func Order_Values() []string { } } +const ( + // PersonaOwner is a Persona enum value + PersonaOwner = "OWNER" + + // PersonaViewer is a Persona enum value + PersonaViewer = "VIEWER" +) + +// Persona_Values returns all elements of the Persona enum +func Persona_Values() []string { + return []string{ + PersonaOwner, + PersonaViewer, + } +} + const ( // PrincipalMappingStatusFailed is a PrincipalMappingStatus enum value PrincipalMappingStatusFailed = "FAILED" diff --git a/service/kendra/errors.go b/service/kendra/errors.go index 557930dd539..6c1ddbe2875 100644 --- a/service/kendra/errors.go +++ b/service/kendra/errors.go @@ -20,6 +20,12 @@ const ( // "InternalServerException". ErrCodeInternalServerException = "InternalServerException" + // ErrCodeInvalidRequestException for service response error code + // "InvalidRequestException". + // + // The input to the request is not valid. + ErrCodeInvalidRequestException = "InvalidRequestException" + // ErrCodeResourceAlreadyExistException for service response error code // "ResourceAlreadyExistException". ErrCodeResourceAlreadyExistException = "ResourceAlreadyExistException" @@ -53,6 +59,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "AccessDeniedException": newErrorAccessDeniedException, "ConflictException": newErrorConflictException, "InternalServerException": newErrorInternalServerException, + "InvalidRequestException": newErrorInvalidRequestException, "ResourceAlreadyExistException": newErrorResourceAlreadyExistException, "ResourceInUseException": newErrorResourceInUseException, "ResourceNotFoundException": newErrorResourceNotFoundException, diff --git a/service/kendra/kendraiface/interface.go b/service/kendra/kendraiface/interface.go index 9fb0e2dbdac..3a52d5e0f13 100644 --- a/service/kendra/kendraiface/interface.go +++ b/service/kendra/kendraiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // AWSKendraFrontendService. // func myFunc(svc kendraiface.KendraAPI) bool { -// // Make svc.BatchDeleteDocument request +// // Make svc.AssociateEntitiesToExperience request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockKendraClient struct { // kendraiface.KendraAPI // } -// func (m *mockKendraClient) BatchDeleteDocument(input *kendra.BatchDeleteDocumentInput) (*kendra.BatchDeleteDocumentOutput, error) { +// func (m *mockKendraClient) AssociateEntitiesToExperience(input *kendra.AssociateEntitiesToExperienceInput) (*kendra.AssociateEntitiesToExperienceOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,14 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type KendraAPI interface { + AssociateEntitiesToExperience(*kendra.AssociateEntitiesToExperienceInput) (*kendra.AssociateEntitiesToExperienceOutput, error) + AssociateEntitiesToExperienceWithContext(aws.Context, *kendra.AssociateEntitiesToExperienceInput, ...request.Option) (*kendra.AssociateEntitiesToExperienceOutput, error) + AssociateEntitiesToExperienceRequest(*kendra.AssociateEntitiesToExperienceInput) (*request.Request, *kendra.AssociateEntitiesToExperienceOutput) + + AssociatePersonasToEntities(*kendra.AssociatePersonasToEntitiesInput) (*kendra.AssociatePersonasToEntitiesOutput, error) + AssociatePersonasToEntitiesWithContext(aws.Context, *kendra.AssociatePersonasToEntitiesInput, ...request.Option) (*kendra.AssociatePersonasToEntitiesOutput, error) + AssociatePersonasToEntitiesRequest(*kendra.AssociatePersonasToEntitiesInput) (*request.Request, *kendra.AssociatePersonasToEntitiesOutput) + BatchDeleteDocument(*kendra.BatchDeleteDocumentInput) (*kendra.BatchDeleteDocumentOutput, error) BatchDeleteDocumentWithContext(aws.Context, *kendra.BatchDeleteDocumentInput, ...request.Option) (*kendra.BatchDeleteDocumentOutput, error) BatchDeleteDocumentRequest(*kendra.BatchDeleteDocumentInput) (*request.Request, *kendra.BatchDeleteDocumentOutput) @@ -80,6 +88,10 @@ type KendraAPI interface { CreateDataSourceWithContext(aws.Context, *kendra.CreateDataSourceInput, ...request.Option) (*kendra.CreateDataSourceOutput, error) CreateDataSourceRequest(*kendra.CreateDataSourceInput) (*request.Request, *kendra.CreateDataSourceOutput) + CreateExperience(*kendra.CreateExperienceInput) (*kendra.CreateExperienceOutput, error) + CreateExperienceWithContext(aws.Context, *kendra.CreateExperienceInput, ...request.Option) (*kendra.CreateExperienceOutput, error) + CreateExperienceRequest(*kendra.CreateExperienceInput) (*request.Request, *kendra.CreateExperienceOutput) + CreateFaq(*kendra.CreateFaqInput) (*kendra.CreateFaqOutput, error) CreateFaqWithContext(aws.Context, *kendra.CreateFaqInput, ...request.Option) (*kendra.CreateFaqOutput, error) CreateFaqRequest(*kendra.CreateFaqInput) (*request.Request, *kendra.CreateFaqOutput) @@ -100,6 +112,10 @@ type KendraAPI interface { DeleteDataSourceWithContext(aws.Context, *kendra.DeleteDataSourceInput, ...request.Option) (*kendra.DeleteDataSourceOutput, error) DeleteDataSourceRequest(*kendra.DeleteDataSourceInput) (*request.Request, *kendra.DeleteDataSourceOutput) + DeleteExperience(*kendra.DeleteExperienceInput) (*kendra.DeleteExperienceOutput, error) + DeleteExperienceWithContext(aws.Context, *kendra.DeleteExperienceInput, ...request.Option) (*kendra.DeleteExperienceOutput, error) + DeleteExperienceRequest(*kendra.DeleteExperienceInput) (*request.Request, *kendra.DeleteExperienceOutput) + DeleteFaq(*kendra.DeleteFaqInput) (*kendra.DeleteFaqOutput, error) DeleteFaqWithContext(aws.Context, *kendra.DeleteFaqInput, ...request.Option) (*kendra.DeleteFaqOutput, error) DeleteFaqRequest(*kendra.DeleteFaqInput) (*request.Request, *kendra.DeleteFaqOutput) @@ -124,6 +140,10 @@ type KendraAPI interface { DescribeDataSourceWithContext(aws.Context, *kendra.DescribeDataSourceInput, ...request.Option) (*kendra.DescribeDataSourceOutput, error) DescribeDataSourceRequest(*kendra.DescribeDataSourceInput) (*request.Request, *kendra.DescribeDataSourceOutput) + DescribeExperience(*kendra.DescribeExperienceInput) (*kendra.DescribeExperienceOutput, error) + DescribeExperienceWithContext(aws.Context, *kendra.DescribeExperienceInput, ...request.Option) (*kendra.DescribeExperienceOutput, error) + DescribeExperienceRequest(*kendra.DescribeExperienceInput) (*request.Request, *kendra.DescribeExperienceOutput) + DescribeFaq(*kendra.DescribeFaqInput) (*kendra.DescribeFaqOutput, error) DescribeFaqWithContext(aws.Context, *kendra.DescribeFaqInput, ...request.Option) (*kendra.DescribeFaqOutput, error) DescribeFaqRequest(*kendra.DescribeFaqInput) (*request.Request, *kendra.DescribeFaqOutput) @@ -148,10 +168,22 @@ type KendraAPI interface { DescribeThesaurusWithContext(aws.Context, *kendra.DescribeThesaurusInput, ...request.Option) (*kendra.DescribeThesaurusOutput, error) DescribeThesaurusRequest(*kendra.DescribeThesaurusInput) (*request.Request, *kendra.DescribeThesaurusOutput) + DisassociateEntitiesFromExperience(*kendra.DisassociateEntitiesFromExperienceInput) (*kendra.DisassociateEntitiesFromExperienceOutput, error) + DisassociateEntitiesFromExperienceWithContext(aws.Context, *kendra.DisassociateEntitiesFromExperienceInput, ...request.Option) (*kendra.DisassociateEntitiesFromExperienceOutput, error) + DisassociateEntitiesFromExperienceRequest(*kendra.DisassociateEntitiesFromExperienceInput) (*request.Request, *kendra.DisassociateEntitiesFromExperienceOutput) + + DisassociatePersonasFromEntities(*kendra.DisassociatePersonasFromEntitiesInput) (*kendra.DisassociatePersonasFromEntitiesOutput, error) + DisassociatePersonasFromEntitiesWithContext(aws.Context, *kendra.DisassociatePersonasFromEntitiesInput, ...request.Option) (*kendra.DisassociatePersonasFromEntitiesOutput, error) + DisassociatePersonasFromEntitiesRequest(*kendra.DisassociatePersonasFromEntitiesInput) (*request.Request, *kendra.DisassociatePersonasFromEntitiesOutput) + GetQuerySuggestions(*kendra.GetQuerySuggestionsInput) (*kendra.GetQuerySuggestionsOutput, error) GetQuerySuggestionsWithContext(aws.Context, *kendra.GetQuerySuggestionsInput, ...request.Option) (*kendra.GetQuerySuggestionsOutput, error) GetQuerySuggestionsRequest(*kendra.GetQuerySuggestionsInput) (*request.Request, *kendra.GetQuerySuggestionsOutput) + GetSnapshots(*kendra.GetSnapshotsInput) (*kendra.GetSnapshotsOutput, error) + GetSnapshotsWithContext(aws.Context, *kendra.GetSnapshotsInput, ...request.Option) (*kendra.GetSnapshotsOutput, error) + GetSnapshotsRequest(*kendra.GetSnapshotsInput) (*request.Request, *kendra.GetSnapshotsOutput) + ListDataSourceSyncJobs(*kendra.ListDataSourceSyncJobsInput) (*kendra.ListDataSourceSyncJobsOutput, error) ListDataSourceSyncJobsWithContext(aws.Context, *kendra.ListDataSourceSyncJobsInput, ...request.Option) (*kendra.ListDataSourceSyncJobsOutput, error) ListDataSourceSyncJobsRequest(*kendra.ListDataSourceSyncJobsInput) (*request.Request, *kendra.ListDataSourceSyncJobsOutput) @@ -166,6 +198,27 @@ type KendraAPI interface { ListDataSourcesPages(*kendra.ListDataSourcesInput, func(*kendra.ListDataSourcesOutput, bool) bool) error ListDataSourcesPagesWithContext(aws.Context, *kendra.ListDataSourcesInput, func(*kendra.ListDataSourcesOutput, bool) bool, ...request.Option) error + ListEntityPersonas(*kendra.ListEntityPersonasInput) (*kendra.ListEntityPersonasOutput, error) + ListEntityPersonasWithContext(aws.Context, *kendra.ListEntityPersonasInput, ...request.Option) (*kendra.ListEntityPersonasOutput, error) + ListEntityPersonasRequest(*kendra.ListEntityPersonasInput) (*request.Request, *kendra.ListEntityPersonasOutput) + + ListEntityPersonasPages(*kendra.ListEntityPersonasInput, func(*kendra.ListEntityPersonasOutput, bool) bool) error + ListEntityPersonasPagesWithContext(aws.Context, *kendra.ListEntityPersonasInput, func(*kendra.ListEntityPersonasOutput, bool) bool, ...request.Option) error + + ListExperienceEntities(*kendra.ListExperienceEntitiesInput) (*kendra.ListExperienceEntitiesOutput, error) + ListExperienceEntitiesWithContext(aws.Context, *kendra.ListExperienceEntitiesInput, ...request.Option) (*kendra.ListExperienceEntitiesOutput, error) + ListExperienceEntitiesRequest(*kendra.ListExperienceEntitiesInput) (*request.Request, *kendra.ListExperienceEntitiesOutput) + + ListExperienceEntitiesPages(*kendra.ListExperienceEntitiesInput, func(*kendra.ListExperienceEntitiesOutput, bool) bool) error + ListExperienceEntitiesPagesWithContext(aws.Context, *kendra.ListExperienceEntitiesInput, func(*kendra.ListExperienceEntitiesOutput, bool) bool, ...request.Option) error + + ListExperiences(*kendra.ListExperiencesInput) (*kendra.ListExperiencesOutput, error) + ListExperiencesWithContext(aws.Context, *kendra.ListExperiencesInput, ...request.Option) (*kendra.ListExperiencesOutput, error) + ListExperiencesRequest(*kendra.ListExperiencesInput) (*request.Request, *kendra.ListExperiencesOutput) + + ListExperiencesPages(*kendra.ListExperiencesInput, func(*kendra.ListExperiencesOutput, bool) bool) error + ListExperiencesPagesWithContext(aws.Context, *kendra.ListExperiencesInput, func(*kendra.ListExperiencesOutput, bool) bool, ...request.Option) error + ListFaqs(*kendra.ListFaqsInput) (*kendra.ListFaqsOutput, error) ListFaqsWithContext(aws.Context, *kendra.ListFaqsInput, ...request.Option) (*kendra.ListFaqsOutput, error) ListFaqsRequest(*kendra.ListFaqsInput) (*request.Request, *kendra.ListFaqsOutput) @@ -225,6 +278,10 @@ type KendraAPI interface { UpdateDataSourceWithContext(aws.Context, *kendra.UpdateDataSourceInput, ...request.Option) (*kendra.UpdateDataSourceOutput, error) UpdateDataSourceRequest(*kendra.UpdateDataSourceInput) (*request.Request, *kendra.UpdateDataSourceOutput) + UpdateExperience(*kendra.UpdateExperienceInput) (*kendra.UpdateExperienceOutput, error) + UpdateExperienceWithContext(aws.Context, *kendra.UpdateExperienceInput, ...request.Option) (*kendra.UpdateExperienceOutput, error) + UpdateExperienceRequest(*kendra.UpdateExperienceInput) (*request.Request, *kendra.UpdateExperienceOutput) + UpdateIndex(*kendra.UpdateIndexInput) (*kendra.UpdateIndexOutput, error) UpdateIndexWithContext(aws.Context, *kendra.UpdateIndexInput, ...request.Option) (*kendra.UpdateIndexOutput, error) UpdateIndexRequest(*kendra.UpdateIndexInput) (*request.Request, *kendra.UpdateIndexOutput) diff --git a/service/lexmodelsv2/api.go b/service/lexmodelsv2/api.go index fd7400f472e..1c7e583f3c8 100644 --- a/service/lexmodelsv2/api.go +++ b/service/lexmodelsv2/api.go @@ -2708,6 +2708,99 @@ func (c *LexModelsV2) DescribeBotLocaleWithContext(ctx aws.Context, input *Descr return out, req.Send() } +const opDescribeBotRecommendation = "DescribeBotRecommendation" + +// DescribeBotRecommendationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeBotRecommendation 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 DescribeBotRecommendation for more information on using the DescribeBotRecommendation +// 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 DescribeBotRecommendationRequest method. +// req, resp := client.DescribeBotRecommendationRequest(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/DescribeBotRecommendation +func (c *LexModelsV2) DescribeBotRecommendationRequest(input *DescribeBotRecommendationInput) (req *request.Request, output *DescribeBotRecommendationOutput) { + op := &request.Operation{ + Name: opDescribeBotRecommendation, + HTTPMethod: "GET", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/", + } + + if input == nil { + input = &DescribeBotRecommendationInput{} + } + + output = &DescribeBotRecommendationOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeBotRecommendation API operation for Amazon Lex Model Building V2. +// +// Provides metadata information about a bot recommendation. This information +// will enable you to get a description on the request inputs, to download associated +// transcripts after processing is complete, and to download intents and slot-types +// generated by the bot recommendation. +// +// 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 DescribeBotRecommendation for usage and error information. +// +// Returned Error Types: +// * ThrottlingException +// Your request rate is too high. Reduce the frequency of requests. +// +// * 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. +// +// * 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/DescribeBotRecommendation +func (c *LexModelsV2) DescribeBotRecommendation(input *DescribeBotRecommendationInput) (*DescribeBotRecommendationOutput, error) { + req, out := c.DescribeBotRecommendationRequest(input) + return out, req.Send() +} + +// DescribeBotRecommendationWithContext is the same as DescribeBotRecommendation with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeBotRecommendation 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) DescribeBotRecommendationWithContext(ctx aws.Context, input *DescribeBotRecommendationInput, opts ...request.Option) (*DescribeBotRecommendationOutput, error) { + req, out := c.DescribeBotRecommendationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeBotVersion = "DescribeBotVersion" // DescribeBotVersionRequest generates a "aws/request.Request" representing the @@ -3808,6 +3901,154 @@ func (c *LexModelsV2) ListBotLocalesPagesWithContext(ctx aws.Context, input *Lis return p.Err() } +const opListBotRecommendations = "ListBotRecommendations" + +// ListBotRecommendationsRequest generates a "aws/request.Request" representing the +// client's request for the ListBotRecommendations 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 ListBotRecommendations for more information on using the ListBotRecommendations +// 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 ListBotRecommendationsRequest method. +// req, resp := client.ListBotRecommendationsRequest(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/ListBotRecommendations +func (c *LexModelsV2) ListBotRecommendationsRequest(input *ListBotRecommendationsInput) (req *request.Request, output *ListBotRecommendationsOutput) { + op := &request.Operation{ + Name: opListBotRecommendations, + HTTPMethod: "POST", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListBotRecommendationsInput{} + } + + output = &ListBotRecommendationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListBotRecommendations API operation for Amazon Lex Model Building V2. +// +// Get a list of bot recommendations that meet the specified criteria. +// +// 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 ListBotRecommendations for usage and error information. +// +// Returned Error Types: +// * ThrottlingException +// Your request rate is too high. Reduce the frequency of requests. +// +// * ValidationException +// One of the input parameters in your request isn't valid. Check the parameters +// and try your request again. +// +// * InternalServerException +// The service encountered an unexpected condition. 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. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotRecommendations +func (c *LexModelsV2) ListBotRecommendations(input *ListBotRecommendationsInput) (*ListBotRecommendationsOutput, error) { + req, out := c.ListBotRecommendationsRequest(input) + return out, req.Send() +} + +// ListBotRecommendationsWithContext is the same as ListBotRecommendations with the addition of +// the ability to pass a context and additional request options. +// +// See ListBotRecommendations 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) ListBotRecommendationsWithContext(ctx aws.Context, input *ListBotRecommendationsInput, opts ...request.Option) (*ListBotRecommendationsOutput, error) { + req, out := c.ListBotRecommendationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListBotRecommendationsPages iterates over the pages of a ListBotRecommendations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListBotRecommendations 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 ListBotRecommendations operation. +// pageNum := 0 +// err := client.ListBotRecommendationsPages(params, +// func(page *lexmodelsv2.ListBotRecommendationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *LexModelsV2) ListBotRecommendationsPages(input *ListBotRecommendationsInput, fn func(*ListBotRecommendationsOutput, bool) bool) error { + return c.ListBotRecommendationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListBotRecommendationsPagesWithContext same as ListBotRecommendationsPages 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 *LexModelsV2) ListBotRecommendationsPagesWithContext(ctx aws.Context, input *ListBotRecommendationsInput, fn func(*ListBotRecommendationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListBotRecommendationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListBotRecommendationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListBotRecommendationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListBotVersions = "ListBotVersions" // ListBotVersionsRequest generates a "aws/request.Request" representing the @@ -4846,37 +5087,37 @@ func (c *LexModelsV2) ListIntentsPagesWithContext(ctx aws.Context, input *ListIn return p.Err() } -const opListSlotTypes = "ListSlotTypes" +const opListRecommendedIntents = "ListRecommendedIntents" -// ListSlotTypesRequest generates a "aws/request.Request" representing the -// client's request for the ListSlotTypes operation. The "output" return +// ListRecommendedIntentsRequest generates a "aws/request.Request" representing the +// client's request for the ListRecommendedIntents 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 ListSlotTypes for more information on using the ListSlotTypes +// See ListRecommendedIntents for more information on using the ListRecommendedIntents // 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 ListSlotTypesRequest method. -// req, resp := client.ListSlotTypesRequest(params) +// // Example sending a request using the ListRecommendedIntentsRequest method. +// req, resp := client.ListRecommendedIntentsRequest(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/ListSlotTypes -func (c *LexModelsV2) ListSlotTypesRequest(input *ListSlotTypesInput) (req *request.Request, output *ListSlotTypesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntents +func (c *LexModelsV2) ListRecommendedIntentsRequest(input *ListRecommendedIntentsInput) (req *request.Request, output *ListRecommendedIntentsOutput) { op := &request.Operation{ - Name: opListSlotTypes, + Name: opListRecommendedIntents, HTTPMethod: "POST", - HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -4886,24 +5127,25 @@ func (c *LexModelsV2) ListSlotTypesRequest(input *ListSlotTypesInput) (req *requ } if input == nil { - input = &ListSlotTypesInput{} + input = &ListRecommendedIntentsInput{} } - output = &ListSlotTypesOutput{} + output = &ListRecommendedIntentsOutput{} req = c.newRequest(op, input, output) return } -// ListSlotTypes API operation for Amazon Lex Model Building V2. +// ListRecommendedIntents API operation for Amazon Lex Model Building V2. // -// Gets a list of slot types that match the specified criteria. +// Gets a list of recommended intents provided by the bot recommendation that +// you can use in your bot. // // 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 ListSlotTypes for usage and error information. +// API operation ListRecommendedIntents for usage and error information. // // Returned Error Types: // * ThrottlingException @@ -4919,65 +5161,69 @@ func (c *LexModelsV2) ListSlotTypesRequest(input *ListSlotTypesInput) (req *requ // * 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/ListSlotTypes -func (c *LexModelsV2) ListSlotTypes(input *ListSlotTypesInput) (*ListSlotTypesOutput, error) { - req, out := c.ListSlotTypesRequest(input) +// * ResourceNotFoundException +// You asked to describe a resource that doesn't exist. Check the resource that +// you are requesting and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntents +func (c *LexModelsV2) ListRecommendedIntents(input *ListRecommendedIntentsInput) (*ListRecommendedIntentsOutput, error) { + req, out := c.ListRecommendedIntentsRequest(input) return out, req.Send() } -// ListSlotTypesWithContext is the same as ListSlotTypes with the addition of +// ListRecommendedIntentsWithContext is the same as ListRecommendedIntents with the addition of // the ability to pass a context and additional request options. // -// See ListSlotTypes for details on how to use this API operation. +// See ListRecommendedIntents 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) ListSlotTypesWithContext(ctx aws.Context, input *ListSlotTypesInput, opts ...request.Option) (*ListSlotTypesOutput, error) { - req, out := c.ListSlotTypesRequest(input) +func (c *LexModelsV2) ListRecommendedIntentsWithContext(ctx aws.Context, input *ListRecommendedIntentsInput, opts ...request.Option) (*ListRecommendedIntentsOutput, error) { + req, out := c.ListRecommendedIntentsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSlotTypesPages iterates over the pages of a ListSlotTypes operation, +// ListRecommendedIntentsPages iterates over the pages of a ListRecommendedIntents operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListSlotTypes method for more information on how to use this operation. +// See ListRecommendedIntents 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 ListSlotTypes operation. +// // Example iterating over at most 3 pages of a ListRecommendedIntents operation. // pageNum := 0 -// err := client.ListSlotTypesPages(params, -// func(page *lexmodelsv2.ListSlotTypesOutput, lastPage bool) bool { +// err := client.ListRecommendedIntentsPages(params, +// func(page *lexmodelsv2.ListRecommendedIntentsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *LexModelsV2) ListSlotTypesPages(input *ListSlotTypesInput, fn func(*ListSlotTypesOutput, bool) bool) error { - return c.ListSlotTypesPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *LexModelsV2) ListRecommendedIntentsPages(input *ListRecommendedIntentsInput, fn func(*ListRecommendedIntentsOutput, bool) bool) error { + return c.ListRecommendedIntentsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListSlotTypesPagesWithContext same as ListSlotTypesPages except +// ListRecommendedIntentsPagesWithContext same as ListRecommendedIntentsPages 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 *LexModelsV2) ListSlotTypesPagesWithContext(ctx aws.Context, input *ListSlotTypesInput, fn func(*ListSlotTypesOutput, bool) bool, opts ...request.Option) error { +func (c *LexModelsV2) ListRecommendedIntentsPagesWithContext(ctx aws.Context, input *ListRecommendedIntentsInput, fn func(*ListRecommendedIntentsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListSlotTypesInput + var inCpy *ListRecommendedIntentsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListSlotTypesRequest(inCpy) + req, _ := c.ListRecommendedIntentsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -4985,7 +5231,7 @@ func (c *LexModelsV2) ListSlotTypesPagesWithContext(ctx aws.Context, input *List } for p.Next() { - if !fn(p.Page().(*ListSlotTypesOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListRecommendedIntentsOutput), !p.HasNextPage()) { break } } @@ -4993,37 +5239,37 @@ func (c *LexModelsV2) ListSlotTypesPagesWithContext(ctx aws.Context, input *List return p.Err() } -const opListSlots = "ListSlots" +const opListSlotTypes = "ListSlotTypes" -// ListSlotsRequest generates a "aws/request.Request" representing the -// client's request for the ListSlots operation. The "output" return +// ListSlotTypesRequest generates a "aws/request.Request" representing the +// client's request for the ListSlotTypes 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 ListSlots for more information on using the ListSlots +// See ListSlotTypes for more information on using the ListSlotTypes // 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 ListSlotsRequest method. -// req, resp := client.ListSlotsRequest(params) +// // Example sending a request using the ListSlotTypesRequest method. +// req, resp := client.ListSlotTypesRequest(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/ListSlots -func (c *LexModelsV2) ListSlotsRequest(input *ListSlotsInput) (req *request.Request, output *ListSlotsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotTypes +func (c *LexModelsV2) ListSlotTypesRequest(input *ListSlotTypesInput) (req *request.Request, output *ListSlotTypesOutput) { op := &request.Operation{ - Name: opListSlots, + Name: opListSlotTypes, HTTPMethod: "POST", - HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -5033,24 +5279,24 @@ func (c *LexModelsV2) ListSlotsRequest(input *ListSlotsInput) (req *request.Requ } if input == nil { - input = &ListSlotsInput{} + input = &ListSlotTypesInput{} } - output = &ListSlotsOutput{} + output = &ListSlotTypesOutput{} req = c.newRequest(op, input, output) return } -// ListSlots API operation for Amazon Lex Model Building V2. +// ListSlotTypes API operation for Amazon Lex Model Building V2. // -// Gets a list of slots that match the specified criteria. +// Gets a list of slot types that match the specified criteria. // // 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 ListSlots for usage and error information. +// API operation ListSlotTypes for usage and error information. // // Returned Error Types: // * ThrottlingException @@ -5066,9 +5312,156 @@ func (c *LexModelsV2) ListSlotsRequest(input *ListSlotsInput) (req *request.Requ // * 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/ListSlots -func (c *LexModelsV2) ListSlots(input *ListSlotsInput) (*ListSlotsOutput, error) { - req, out := c.ListSlotsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotTypes +func (c *LexModelsV2) ListSlotTypes(input *ListSlotTypesInput) (*ListSlotTypesOutput, error) { + req, out := c.ListSlotTypesRequest(input) + return out, req.Send() +} + +// ListSlotTypesWithContext is the same as ListSlotTypes with the addition of +// the ability to pass a context and additional request options. +// +// See ListSlotTypes 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) ListSlotTypesWithContext(ctx aws.Context, input *ListSlotTypesInput, opts ...request.Option) (*ListSlotTypesOutput, error) { + req, out := c.ListSlotTypesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSlotTypesPages iterates over the pages of a ListSlotTypes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSlotTypes 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 ListSlotTypes operation. +// pageNum := 0 +// err := client.ListSlotTypesPages(params, +// func(page *lexmodelsv2.ListSlotTypesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *LexModelsV2) ListSlotTypesPages(input *ListSlotTypesInput, fn func(*ListSlotTypesOutput, bool) bool) error { + return c.ListSlotTypesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSlotTypesPagesWithContext same as ListSlotTypesPages 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 *LexModelsV2) ListSlotTypesPagesWithContext(ctx aws.Context, input *ListSlotTypesInput, fn func(*ListSlotTypesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSlotTypesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSlotTypesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSlotTypesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSlots = "ListSlots" + +// ListSlotsRequest generates a "aws/request.Request" representing the +// client's request for the ListSlots 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 ListSlots for more information on using the ListSlots +// 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 ListSlotsRequest method. +// req, resp := client.ListSlotsRequest(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/ListSlots +func (c *LexModelsV2) ListSlotsRequest(input *ListSlotsInput) (req *request.Request, output *ListSlotsOutput) { + op := &request.Operation{ + Name: opListSlots, + HTTPMethod: "POST", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSlotsInput{} + } + + output = &ListSlotsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSlots API operation for Amazon Lex Model Building V2. +// +// Gets a list of slots that match the specified criteria. +// +// 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 ListSlots 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. +// +// * 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/ListSlots +func (c *LexModelsV2) ListSlots(input *ListSlotsInput) (*ListSlotsOutput, error) { + req, out := c.ListSlotsRequest(input) return out, req.Send() } @@ -5231,6 +5624,207 @@ func (c *LexModelsV2) ListTagsForResourceWithContext(ctx aws.Context, input *Lis return out, req.Send() } +const opSearchAssociatedTranscripts = "SearchAssociatedTranscripts" + +// SearchAssociatedTranscriptsRequest generates a "aws/request.Request" representing the +// client's request for the SearchAssociatedTranscripts 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 SearchAssociatedTranscripts for more information on using the SearchAssociatedTranscripts +// 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 SearchAssociatedTranscriptsRequest method. +// req, resp := client.SearchAssociatedTranscriptsRequest(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/SearchAssociatedTranscripts +func (c *LexModelsV2) SearchAssociatedTranscriptsRequest(input *SearchAssociatedTranscriptsInput) (req *request.Request, output *SearchAssociatedTranscriptsOutput) { + op := &request.Operation{ + Name: opSearchAssociatedTranscripts, + HTTPMethod: "POST", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts", + } + + if input == nil { + input = &SearchAssociatedTranscriptsInput{} + } + + output = &SearchAssociatedTranscriptsOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchAssociatedTranscripts API operation for Amazon Lex Model Building V2. +// +// Search for associated transcripts that meet the specified criteria. +// +// 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 SearchAssociatedTranscripts 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. +// +// * InternalServerException +// The service encountered an unexpected condition. 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. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SearchAssociatedTranscripts +func (c *LexModelsV2) SearchAssociatedTranscripts(input *SearchAssociatedTranscriptsInput) (*SearchAssociatedTranscriptsOutput, error) { + req, out := c.SearchAssociatedTranscriptsRequest(input) + return out, req.Send() +} + +// SearchAssociatedTranscriptsWithContext is the same as SearchAssociatedTranscripts with the addition of +// the ability to pass a context and additional request options. +// +// See SearchAssociatedTranscripts 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) SearchAssociatedTranscriptsWithContext(ctx aws.Context, input *SearchAssociatedTranscriptsInput, opts ...request.Option) (*SearchAssociatedTranscriptsOutput, error) { + req, out := c.SearchAssociatedTranscriptsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartBotRecommendation = "StartBotRecommendation" + +// StartBotRecommendationRequest generates a "aws/request.Request" representing the +// client's request for the StartBotRecommendation 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 StartBotRecommendation for more information on using the StartBotRecommendation +// 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 StartBotRecommendationRequest method. +// req, resp := client.StartBotRecommendationRequest(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/StartBotRecommendation +func (c *LexModelsV2) StartBotRecommendationRequest(input *StartBotRecommendationInput) (req *request.Request, output *StartBotRecommendationOutput) { + op := &request.Operation{ + Name: opStartBotRecommendation, + HTTPMethod: "PUT", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/", + } + + if input == nil { + input = &StartBotRecommendationInput{} + } + + output = &StartBotRecommendationOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartBotRecommendation API operation for Amazon Lex Model Building V2. +// +// Use this to provide your transcript data, and to start the bot recommendation +// process. +// +// 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 StartBotRecommendation 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/StartBotRecommendation +func (c *LexModelsV2) StartBotRecommendation(input *StartBotRecommendationInput) (*StartBotRecommendationOutput, error) { + req, out := c.StartBotRecommendationRequest(input) + return out, req.Send() +} + +// StartBotRecommendationWithContext is the same as StartBotRecommendation with the addition of +// the ability to pass a context and additional request options. +// +// See StartBotRecommendation 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) StartBotRecommendationWithContext(ctx aws.Context, input *StartBotRecommendationInput, opts ...request.Option) (*StartBotRecommendationOutput, error) { + req, out := c.StartBotRecommendationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartImport = "StartImport" // StartImportRequest generates a "aws/request.Request" representing the @@ -5611,58 +6205,156 @@ func (c *LexModelsV2) UpdateBotWithContext(ctx aws.Context, input *UpdateBotInpu return out, req.Send() } -const opUpdateBotAlias = "UpdateBotAlias" +const opUpdateBotAlias = "UpdateBotAlias" + +// UpdateBotAliasRequest generates a "aws/request.Request" representing the +// client's request for the UpdateBotAlias 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 UpdateBotAlias for more information on using the UpdateBotAlias +// 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 UpdateBotAliasRequest method. +// req, resp := client.UpdateBotAliasRequest(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/UpdateBotAlias +func (c *LexModelsV2) UpdateBotAliasRequest(input *UpdateBotAliasInput) (req *request.Request, output *UpdateBotAliasOutput) { + op := &request.Operation{ + Name: opUpdateBotAlias, + HTTPMethod: "PUT", + HTTPPath: "/bots/{botId}/botaliases/{botAliasId}/", + } + + if input == nil { + input = &UpdateBotAliasInput{} + } + + output = &UpdateBotAliasOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateBotAlias API operation for Amazon Lex Model Building V2. +// +// Updates the configuration of an existing bot alias. +// +// 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 UpdateBotAlias 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. +// +// * 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/UpdateBotAlias +func (c *LexModelsV2) UpdateBotAlias(input *UpdateBotAliasInput) (*UpdateBotAliasOutput, error) { + req, out := c.UpdateBotAliasRequest(input) + return out, req.Send() +} + +// UpdateBotAliasWithContext is the same as UpdateBotAlias with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateBotAlias 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) UpdateBotAliasWithContext(ctx aws.Context, input *UpdateBotAliasInput, opts ...request.Option) (*UpdateBotAliasOutput, error) { + req, out := c.UpdateBotAliasRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateBotLocale = "UpdateBotLocale" -// UpdateBotAliasRequest generates a "aws/request.Request" representing the -// client's request for the UpdateBotAlias operation. The "output" return +// UpdateBotLocaleRequest generates a "aws/request.Request" representing the +// client's request for the UpdateBotLocale 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 UpdateBotAlias for more information on using the UpdateBotAlias +// See UpdateBotLocale for more information on using the UpdateBotLocale // 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 UpdateBotAliasRequest method. -// req, resp := client.UpdateBotAliasRequest(params) +// // Example sending a request using the UpdateBotLocaleRequest method. +// req, resp := client.UpdateBotLocaleRequest(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/UpdateBotAlias -func (c *LexModelsV2) UpdateBotAliasRequest(input *UpdateBotAliasInput) (req *request.Request, output *UpdateBotAliasOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotLocale +func (c *LexModelsV2) UpdateBotLocaleRequest(input *UpdateBotLocaleInput) (req *request.Request, output *UpdateBotLocaleOutput) { op := &request.Operation{ - Name: opUpdateBotAlias, + Name: opUpdateBotLocale, HTTPMethod: "PUT", - HTTPPath: "/bots/{botId}/botaliases/{botAliasId}/", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/", } if input == nil { - input = &UpdateBotAliasInput{} + input = &UpdateBotLocaleInput{} } - output = &UpdateBotAliasOutput{} + output = &UpdateBotLocaleOutput{} req = c.newRequest(op, input, output) return } -// UpdateBotAlias API operation for Amazon Lex Model Building V2. +// UpdateBotLocale API operation for Amazon Lex Model Building V2. // -// Updates the configuration of an existing bot alias. +// Updates the settings that a bot has for a specific locale. // // 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 UpdateBotAlias for usage and error information. +// API operation UpdateBotLocale for usage and error information. // // Returned Error Types: // * ThrottlingException @@ -5687,80 +6379,80 @@ func (c *LexModelsV2) UpdateBotAliasRequest(input *UpdateBotAliasInput) (req *re // * 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/UpdateBotAlias -func (c *LexModelsV2) UpdateBotAlias(input *UpdateBotAliasInput) (*UpdateBotAliasOutput, error) { - req, out := c.UpdateBotAliasRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotLocale +func (c *LexModelsV2) UpdateBotLocale(input *UpdateBotLocaleInput) (*UpdateBotLocaleOutput, error) { + req, out := c.UpdateBotLocaleRequest(input) return out, req.Send() } -// UpdateBotAliasWithContext is the same as UpdateBotAlias with the addition of +// UpdateBotLocaleWithContext is the same as UpdateBotLocale with the addition of // the ability to pass a context and additional request options. // -// See UpdateBotAlias for details on how to use this API operation. +// See UpdateBotLocale 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) UpdateBotAliasWithContext(ctx aws.Context, input *UpdateBotAliasInput, opts ...request.Option) (*UpdateBotAliasOutput, error) { - req, out := c.UpdateBotAliasRequest(input) +func (c *LexModelsV2) UpdateBotLocaleWithContext(ctx aws.Context, input *UpdateBotLocaleInput, opts ...request.Option) (*UpdateBotLocaleOutput, error) { + req, out := c.UpdateBotLocaleRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateBotLocale = "UpdateBotLocale" +const opUpdateBotRecommendation = "UpdateBotRecommendation" -// UpdateBotLocaleRequest generates a "aws/request.Request" representing the -// client's request for the UpdateBotLocale operation. The "output" return +// UpdateBotRecommendationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateBotRecommendation 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 UpdateBotLocale for more information on using the UpdateBotLocale +// See UpdateBotRecommendation for more information on using the UpdateBotRecommendation // 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 UpdateBotLocaleRequest method. -// req, resp := client.UpdateBotLocaleRequest(params) +// // Example sending a request using the UpdateBotRecommendationRequest method. +// req, resp := client.UpdateBotRecommendationRequest(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/UpdateBotLocale -func (c *LexModelsV2) UpdateBotLocaleRequest(input *UpdateBotLocaleInput) (req *request.Request, output *UpdateBotLocaleOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendation +func (c *LexModelsV2) UpdateBotRecommendationRequest(input *UpdateBotRecommendationInput) (req *request.Request, output *UpdateBotRecommendationOutput) { op := &request.Operation{ - Name: opUpdateBotLocale, + Name: opUpdateBotRecommendation, HTTPMethod: "PUT", - HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/", } if input == nil { - input = &UpdateBotLocaleInput{} + input = &UpdateBotRecommendationInput{} } - output = &UpdateBotLocaleOutput{} + output = &UpdateBotRecommendationOutput{} req = c.newRequest(op, input, output) return } -// UpdateBotLocale API operation for Amazon Lex Model Building V2. +// UpdateBotRecommendation API operation for Amazon Lex Model Building V2. // -// Updates the settings that a bot has for a specific locale. +// Updates an existing 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 UpdateBotLocale for usage and error information. +// API operation UpdateBotRecommendation for usage and error information. // // Returned Error Types: // * ThrottlingException @@ -5773,6 +6465,15 @@ func (c *LexModelsV2) UpdateBotLocaleRequest(input *UpdateBotLocaleInput) (req * // 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. @@ -5785,23 +6486,23 @@ func (c *LexModelsV2) UpdateBotLocaleRequest(input *UpdateBotLocaleInput) (req * // * 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/UpdateBotLocale -func (c *LexModelsV2) UpdateBotLocale(input *UpdateBotLocaleInput) (*UpdateBotLocaleOutput, error) { - req, out := c.UpdateBotLocaleRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendation +func (c *LexModelsV2) UpdateBotRecommendation(input *UpdateBotRecommendationInput) (*UpdateBotRecommendationOutput, error) { + req, out := c.UpdateBotRecommendationRequest(input) return out, req.Send() } -// UpdateBotLocaleWithContext is the same as UpdateBotLocale with the addition of +// UpdateBotRecommendationWithContext is the same as UpdateBotRecommendation with the addition of // the ability to pass a context and additional request options. // -// See UpdateBotLocale for details on how to use this API operation. +// See UpdateBotRecommendation 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) UpdateBotLocaleWithContext(ctx aws.Context, input *UpdateBotLocaleInput, opts ...request.Option) (*UpdateBotLocaleOutput, error) { - req, out := c.UpdateBotLocaleRequest(input) +func (c *LexModelsV2) UpdateBotRecommendationWithContext(ctx aws.Context, input *UpdateBotRecommendationInput, opts ...request.Option) (*UpdateBotRecommendationOutput, error) { + req, out := c.UpdateBotRecommendationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -6534,6 +7235,105 @@ func (s *AggregatedUtterancesSummary) SetUtteranceLastRecordedInAggregationDurat return s } +// The object containing information that associates the recommended intent/slot +// type with a conversation. +type AssociatedTranscript struct { + _ struct{} `type:"structure"` + + // The content of the transcript that meets the search filter criteria. For + // the JSON format of the transcript, see Output transcript format (https://docs.aws.amazon.com/lex/latest/dg/designing-output-format.html). + Transcript *string `locationName:"transcript" 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 AssociatedTranscript) 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 AssociatedTranscript) GoString() string { + return s.String() +} + +// SetTranscript sets the Transcript field's value. +func (s *AssociatedTranscript) SetTranscript(v string) *AssociatedTranscript { + s.Transcript = &v + return s +} + +// Filters to search for the associated transcript. +type AssociatedTranscriptFilter struct { + _ struct{} `type:"structure"` + + // The name of the field to use for filtering. The allowed names are IntentId + // and SlotTypeId. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true" enum:"AssociatedTranscriptFilterName"` + + // The values to use to filter the transcript. + // + // Values is a required field + Values []*string `locationName:"values" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociatedTranscriptFilter) 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 AssociatedTranscriptFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociatedTranscriptFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociatedTranscriptFilter"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Values == nil { + invalidParams.Add(request.NewErrParamRequired("Values")) + } + if s.Values != nil && len(s.Values) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Values", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *AssociatedTranscriptFilter) SetName(v string) *AssociatedTranscriptFilter { + s.Name = &v + return s +} + +// SetValues sets the Values field's value. +func (s *AssociatedTranscriptFilter) SetValues(v []*string) *AssociatedTranscriptFilter { + s.Values = v + return s +} + // The location of audio log files collected when conversation logging is enabled // for a bot. type AudioLogDestination struct { @@ -7600,15 +8400,175 @@ func (s *BotLocaleSummary) SetLastUpdatedDateTime(v time.Time) *BotLocaleSummary return s } -// SetLocaleId sets the LocaleId field's value. -func (s *BotLocaleSummary) SetLocaleId(v string) *BotLocaleSummary { - s.LocaleId = &v +// SetLocaleId sets the LocaleId field's value. +func (s *BotLocaleSummary) SetLocaleId(v string) *BotLocaleSummary { + s.LocaleId = &v + return s +} + +// SetLocaleName sets the LocaleName field's value. +func (s *BotLocaleSummary) SetLocaleName(v string) *BotLocaleSummary { + s.LocaleName = &v + return s +} + +// A statistical summary of the bot recommendation results. +type BotRecommendationResultStatistics struct { + _ struct{} `type:"structure"` + + // Statistical information about about the intents associated with the bot recommendation + // results. + Intents *IntentStatistics `locationName:"intents" type:"structure"` + + // Statistical information about the slot types associated with the bot recommendation + // results. + SlotTypes *SlotTypeStatistics `locationName:"slotTypes" 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 BotRecommendationResultStatistics) 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 BotRecommendationResultStatistics) GoString() string { + return s.String() +} + +// SetIntents sets the Intents field's value. +func (s *BotRecommendationResultStatistics) SetIntents(v *IntentStatistics) *BotRecommendationResultStatistics { + s.Intents = v + return s +} + +// SetSlotTypes sets the SlotTypes field's value. +func (s *BotRecommendationResultStatistics) SetSlotTypes(v *SlotTypeStatistics) *BotRecommendationResultStatistics { + s.SlotTypes = v + return s +} + +// The object representing the URL of the bot definition, the URL of the associated +// transcript and a statistical summary of the bot recommendation results. +type BotRecommendationResults struct { + _ struct{} `type:"structure"` + + // The presigned url link of the associated transcript. + AssociatedTranscriptsUrl *string `locationName:"associatedTranscriptsUrl" min:"1" type:"string"` + + // The presigned URL link of the recommended bot definition. + BotLocaleExportUrl *string `locationName:"botLocaleExportUrl" min:"1" type:"string"` + + // The statistical summary of the bot recommendation results. + Statistics *BotRecommendationResultStatistics `locationName:"statistics" 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 BotRecommendationResults) 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 BotRecommendationResults) GoString() string { + return s.String() +} + +// SetAssociatedTranscriptsUrl sets the AssociatedTranscriptsUrl field's value. +func (s *BotRecommendationResults) SetAssociatedTranscriptsUrl(v string) *BotRecommendationResults { + s.AssociatedTranscriptsUrl = &v + return s +} + +// SetBotLocaleExportUrl sets the BotLocaleExportUrl field's value. +func (s *BotRecommendationResults) SetBotLocaleExportUrl(v string) *BotRecommendationResults { + s.BotLocaleExportUrl = &v + return s +} + +// SetStatistics sets the Statistics field's value. +func (s *BotRecommendationResults) SetStatistics(v *BotRecommendationResultStatistics) *BotRecommendationResults { + s.Statistics = v + return s +} + +// A summary of the bot recommendation. +type BotRecommendationSummary struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot recommendation to be updated. + // + // BotRecommendationId is a required field + BotRecommendationId *string `locationName:"botRecommendationId" min:"10" type:"string" required:"true"` + + // The status of the bot recommendation. + // + // If the status is Failed, then the reasons for the failure are listed in the + // failureReasons field. + // + // BotRecommendationStatus is a required field + BotRecommendationStatus *string `locationName:"botRecommendationStatus" type:"string" required:"true" enum:"BotRecommendationStatus"` + + // A timestamp of the date and time that the bot recommendation was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // A timestamp of the date and time that the bot recommendation was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" 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 BotRecommendationSummary) 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 BotRecommendationSummary) GoString() string { + return s.String() +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *BotRecommendationSummary) SetBotRecommendationId(v string) *BotRecommendationSummary { + s.BotRecommendationId = &v + return s +} + +// SetBotRecommendationStatus sets the BotRecommendationStatus field's value. +func (s *BotRecommendationSummary) SetBotRecommendationStatus(v string) *BotRecommendationSummary { + s.BotRecommendationStatus = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *BotRecommendationSummary) SetCreationDateTime(v time.Time) *BotRecommendationSummary { + s.CreationDateTime = &v return s } -// SetLocaleName sets the LocaleName field's value. -func (s *BotLocaleSummary) SetLocaleName(v string) *BotLocaleSummary { - s.LocaleName = &v +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *BotRecommendationSummary) SetLastUpdatedDateTime(v time.Time) *BotRecommendationSummary { + s.LastUpdatedDateTime = &v return s } @@ -11343,6 +12303,68 @@ func (s *DataPrivacy) SetChildDirected(v bool) *DataPrivacy { return s } +// The object used for specifying the data range that the customer wants Amazon +// Lex to read through in the input transcripts. +type DateRangeFilter struct { + _ struct{} `type:"structure"` + + // A timestamp indicating the end date for the date range filter. + // + // EndDateTime is a required field + EndDateTime *time.Time `locationName:"endDateTime" type:"timestamp" required:"true"` + + // A timestamp indicating the start date for the date range filter. + // + // StartDateTime is a required field + StartDateTime *time.Time `locationName:"startDateTime" type:"timestamp" 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 DateRangeFilter) 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 DateRangeFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DateRangeFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DateRangeFilter"} + if s.EndDateTime == nil { + invalidParams.Add(request.NewErrParamRequired("EndDateTime")) + } + if s.StartDateTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartDateTime")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndDateTime sets the EndDateTime field's value. +func (s *DateRangeFilter) SetEndDateTime(v time.Time) *DateRangeFilter { + s.EndDateTime = &v + return s +} + +// SetStartDateTime sets the StartDateTime field's value. +func (s *DateRangeFilter) SetStartDateTime(v time.Time) *DateRangeFilter { + s.StartDateTime = &v + return s +} + type DeleteBotAliasInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -13363,6 +14385,234 @@ func (s *DescribeBotOutput) SetRoleArn(v string) *DescribeBotOutput { return s } +type DescribeBotRecommendationInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier of the bot associated with the bot recommendation. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` + + // The identifier of the bot recommendation to describe. + // + // BotRecommendationId is a required field + BotRecommendationId *string `location:"uri" locationName:"botRecommendationId" min:"10" type:"string" required:"true"` + + // The version of the bot associated with 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 describe. + // 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 DescribeBotRecommendationInput) 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 DescribeBotRecommendationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeBotRecommendationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeBotRecommendationInput"} + 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 *DescribeBotRecommendationInput) SetBotId(v string) *DescribeBotRecommendationInput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *DescribeBotRecommendationInput) SetBotRecommendationId(v string) *DescribeBotRecommendationInput { + s.BotRecommendationId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *DescribeBotRecommendationInput) SetBotVersion(v string) *DescribeBotRecommendationInput { + s.BotVersion = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *DescribeBotRecommendationInput) SetLocaleId(v string) *DescribeBotRecommendationInput { + s.LocaleId = &v + return s +} + +type DescribeBotRecommendationOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the bot associated with the bot recommendation. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The identifier of the bot recommendation being described. + BotRecommendationId *string `locationName:"botRecommendationId" min:"10" type:"string"` + + // The object representing the URL of the bot definition, the URL of the associated + // transcript and a statistical summary of the bot recommendation results. + BotRecommendationResults *BotRecommendationResults `locationName:"botRecommendationResults" type:"structure"` + + // 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 associated with the bot recommendation. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` + + // The date and time that the bot recommendation was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used + // to encrypt the associated metadata. + EncryptionSetting *EncryptionSetting `locationName:"encryptionSetting" type:"structure"` + + // If botRecommendationStatus is Failed, Amazon Lex explains why. + FailureReasons []*string `locationName:"failureReasons" type:"list"` + + // The date and time that the bot recommendation was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The identifier of the language and locale of the bot recommendation to describe. + LocaleId *string `locationName:"localeId" type:"string"` + + // The object representing the Amazon S3 bucket containing the transcript, as + // well as the associated metadata. + TranscriptSourceSetting *TranscriptSourceSetting `locationName:"transcriptSourceSetting" 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 DescribeBotRecommendationOutput) 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 DescribeBotRecommendationOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *DescribeBotRecommendationOutput) SetBotId(v string) *DescribeBotRecommendationOutput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *DescribeBotRecommendationOutput) SetBotRecommendationId(v string) *DescribeBotRecommendationOutput { + s.BotRecommendationId = &v + return s +} + +// SetBotRecommendationResults sets the BotRecommendationResults field's value. +func (s *DescribeBotRecommendationOutput) SetBotRecommendationResults(v *BotRecommendationResults) *DescribeBotRecommendationOutput { + s.BotRecommendationResults = v + return s +} + +// SetBotRecommendationStatus sets the BotRecommendationStatus field's value. +func (s *DescribeBotRecommendationOutput) SetBotRecommendationStatus(v string) *DescribeBotRecommendationOutput { + s.BotRecommendationStatus = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *DescribeBotRecommendationOutput) SetBotVersion(v string) *DescribeBotRecommendationOutput { + s.BotVersion = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *DescribeBotRecommendationOutput) SetCreationDateTime(v time.Time) *DescribeBotRecommendationOutput { + s.CreationDateTime = &v + return s +} + +// SetEncryptionSetting sets the EncryptionSetting field's value. +func (s *DescribeBotRecommendationOutput) SetEncryptionSetting(v *EncryptionSetting) *DescribeBotRecommendationOutput { + s.EncryptionSetting = v + return s +} + +// SetFailureReasons sets the FailureReasons field's value. +func (s *DescribeBotRecommendationOutput) SetFailureReasons(v []*string) *DescribeBotRecommendationOutput { + s.FailureReasons = v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *DescribeBotRecommendationOutput) SetLastUpdatedDateTime(v time.Time) *DescribeBotRecommendationOutput { + s.LastUpdatedDateTime = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *DescribeBotRecommendationOutput) SetLocaleId(v string) *DescribeBotRecommendationOutput { + s.LocaleId = &v + return s +} + +// SetTranscriptSourceSetting sets the TranscriptSourceSetting field's value. +func (s *DescribeBotRecommendationOutput) SetTranscriptSourceSetting(v *TranscriptSourceSetting) *DescribeBotRecommendationOutput { + s.TranscriptSourceSetting = v + return s +} + type DescribeBotVersionInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -14723,21 +15973,82 @@ func (s *DescribeSlotTypeOutput) SetSlotTypeValues(v []*SlotTypeValue) *Describe return s } -// SetValueSelectionSetting sets the ValueSelectionSetting field's value. -func (s *DescribeSlotTypeOutput) SetValueSelectionSetting(v *SlotValueSelectionSetting) *DescribeSlotTypeOutput { - s.ValueSelectionSetting = v +// SetValueSelectionSetting sets the ValueSelectionSetting field's value. +func (s *DescribeSlotTypeOutput) SetValueSelectionSetting(v *SlotValueSelectionSetting) *DescribeSlotTypeOutput { + s.ValueSelectionSetting = v + return s +} + +// Settings that determine the Lambda function that Amazon Lex uses for processing +// user responses. +type DialogCodeHookSettings struct { + _ struct{} `type:"structure"` + + // Enables the dialog code hook so that it processes user requests. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" 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 DialogCodeHookSettings) 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 DialogCodeHookSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DialogCodeHookSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DialogCodeHookSettings"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnabled sets the Enabled field's value. +func (s *DialogCodeHookSettings) SetEnabled(v bool) *DialogCodeHookSettings { + s.Enabled = &v return s } -// Settings that determine the Lambda function that Amazon Lex uses for processing -// user responses. -type DialogCodeHookSettings struct { +// The object representing the passwords that were used to encrypt the data +// related to the bot recommendation, as well as the KMS key ARN used to encrypt +// the associated metadata. +type EncryptionSetting struct { _ struct{} `type:"structure"` - // Enables the dialog code hook so that it processes user requests. + // The password used to encrypt the associated transcript file. // - // Enabled is a required field - Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` + // AssociatedTranscriptsPassword is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EncryptionSetting's + // String and GoString methods. + AssociatedTranscriptsPassword *string `locationName:"associatedTranscriptsPassword" type:"string" sensitive:"true"` + + // The password used to encrypt the recommended bot recommendation file. + // + // BotLocaleExportPassword is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EncryptionSetting's + // String and GoString methods. + BotLocaleExportPassword *string `locationName:"botLocaleExportPassword" type:"string" sensitive:"true"` + + // The KMS key ARN used to encrypt the metadata associated with the bot recommendation. + KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` } // String returns the string representation. @@ -14745,7 +16056,7 @@ type DialogCodeHookSettings 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 DialogCodeHookSettings) String() string { +func (s EncryptionSetting) String() string { return awsutil.Prettify(s) } @@ -14754,15 +16065,15 @@ func (s DialogCodeHookSettings) 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 DialogCodeHookSettings) GoString() string { +func (s EncryptionSetting) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DialogCodeHookSettings) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DialogCodeHookSettings"} - if s.Enabled == nil { - invalidParams.Add(request.NewErrParamRequired("Enabled")) +func (s *EncryptionSetting) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EncryptionSetting"} + if s.KmsKeyArn != nil && len(*s.KmsKeyArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyArn", 20)) } if invalidParams.Len() > 0 { @@ -14771,9 +16082,21 @@ func (s *DialogCodeHookSettings) Validate() error { return nil } -// SetEnabled sets the Enabled field's value. -func (s *DialogCodeHookSettings) SetEnabled(v bool) *DialogCodeHookSettings { - s.Enabled = &v +// SetAssociatedTranscriptsPassword sets the AssociatedTranscriptsPassword field's value. +func (s *EncryptionSetting) SetAssociatedTranscriptsPassword(v string) *EncryptionSetting { + s.AssociatedTranscriptsPassword = &v + return s +} + +// SetBotLocaleExportPassword sets the BotLocaleExportPassword field's value. +func (s *EncryptionSetting) SetBotLocaleExportPassword(v string) *EncryptionSetting { + s.BotLocaleExportPassword = &v + return s +} + +// SetKmsKeyArn sets the KmsKeyArn field's value. +func (s *EncryptionSetting) SetKmsKeyArn(v string) *EncryptionSetting { + s.KmsKeyArn = &v return s } @@ -16162,6 +17485,39 @@ func (s *IntentSortBy) SetOrder(v string) *IntentSortBy { return s } +// The object that contains the statistical summary of recommended intents associated +// with the bot recommendation. +type IntentStatistics struct { + _ struct{} `type:"structure"` + + // The number of recommended intents associated with the bot recommendation. + DiscoveredIntentCount *int64 `locationName:"discoveredIntentCount" 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 IntentStatistics) 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 IntentStatistics) GoString() string { + return s.String() +} + +// SetDiscoveredIntentCount sets the DiscoveredIntentCount field's value. +func (s *IntentStatistics) SetDiscoveredIntentCount(v int64) *IntentStatistics { + s.DiscoveredIntentCount = &v + return s +} + // Summary information about an intent returned by the ListIntents operation. type IntentSummary struct { _ struct{} `type:"structure"` @@ -16462,6 +17818,56 @@ func (s *LambdaCodeHook) SetLambdaARN(v string) *LambdaCodeHook { return s } +// The object that contains transcript filter details that are associated with +// a bot recommendation. +type LexTranscriptFilter struct { + _ struct{} `type:"structure"` + + // The object that contains a date range filter that will be applied to the + // transcript. Specify this object if you want Amazon Lex to only read the files + // that are within the date range. + DateRangeFilter *DateRangeFilter `locationName:"dateRangeFilter" 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 LexTranscriptFilter) 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 LexTranscriptFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LexTranscriptFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LexTranscriptFilter"} + if s.DateRangeFilter != nil { + if err := s.DateRangeFilter.Validate(); err != nil { + invalidParams.AddNested("DateRangeFilter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDateRangeFilter sets the DateRangeFilter field's value. +func (s *LexTranscriptFilter) SetDateRangeFilter(v *DateRangeFilter) *LexTranscriptFilter { + s.DateRangeFilter = v + return s +} + type ListAggregatedUtterancesInput struct { _ struct{} `type:"structure"` @@ -17021,31 +18427,206 @@ func (s *ListBotLocalesInput) SetNextToken(v string) *ListBotLocalesInput { return s } -// SetSortBy sets the SortBy field's value. -func (s *ListBotLocalesInput) SetSortBy(v *BotLocaleSortBy) *ListBotLocalesInput { - s.SortBy = v +// SetSortBy sets the SortBy field's value. +func (s *ListBotLocalesInput) SetSortBy(v *BotLocaleSortBy) *ListBotLocalesInput { + s.SortBy = v + return s +} + +type ListBotLocalesOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the bot to list locales for. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // Summary information for the locales that meet the filter criteria specified + // in the request. The length of the list is specified in the maxResults parameter + // of the request. If there are more locales available, the nextToken field + // contains a token to get the next page of results. + BotLocaleSummaries []*BotLocaleSummary `locationName:"botLocaleSummaries" type:"list"` + + // The version of the bot. + BotVersion *string `locationName:"botVersion" min:"1" type:"string"` + + // A token that indicates whether there are more results to return in a response + // to the ListBotLocales operation. If the nextToken field is present, you send + // the contents as the nextToken parameter of a ListBotLocales operation request + // to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListBotLocalesOutput) 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 ListBotLocalesOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *ListBotLocalesOutput) SetBotId(v string) *ListBotLocalesOutput { + s.BotId = &v + return s +} + +// SetBotLocaleSummaries sets the BotLocaleSummaries field's value. +func (s *ListBotLocalesOutput) SetBotLocaleSummaries(v []*BotLocaleSummary) *ListBotLocalesOutput { + s.BotLocaleSummaries = v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *ListBotLocalesOutput) SetBotVersion(v string) *ListBotLocalesOutput { + s.BotVersion = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListBotLocalesOutput) SetNextToken(v string) *ListBotLocalesOutput { + s.NextToken = &v + return s +} + +type ListBotRecommendationsInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot that contains the bot recommendation list. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` + + // The version of the bot that contains the bot recommendation list. + // + // 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 list. + // + // LocaleId is a required field + LocaleId *string `location:"uri" locationName:"localeId" type:"string" required:"true"` + + // The maximum number of bot recommendations to return in each page of results. + // If there are fewer results than the max page size, only the actual number + // of results are returned. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // If the response from the ListBotRecommendation operation contains more results + // than specified in the maxResults parameter, a token is returned in the response. + // Use that token in the nextToken parameter to return the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListBotRecommendationsInput) 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 ListBotRecommendationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListBotRecommendationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListBotRecommendationsInput"} + 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.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 s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotId sets the BotId field's value. +func (s *ListBotRecommendationsInput) SetBotId(v string) *ListBotRecommendationsInput { + s.BotId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *ListBotRecommendationsInput) SetBotVersion(v string) *ListBotRecommendationsInput { + s.BotVersion = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *ListBotRecommendationsInput) SetLocaleId(v string) *ListBotRecommendationsInput { + s.LocaleId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListBotRecommendationsInput) SetMaxResults(v int64) *ListBotRecommendationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListBotRecommendationsInput) SetNextToken(v string) *ListBotRecommendationsInput { + s.NextToken = &v return s } -type ListBotLocalesOutput struct { +type ListBotRecommendationsOutput struct { _ struct{} `type:"structure"` - // The identifier of the bot to list locales for. + // The unique identifier of the bot that contains the bot recommendation list. BotId *string `locationName:"botId" min:"10" type:"string"` - // Summary information for the locales that meet the filter criteria specified - // in the request. The length of the list is specified in the maxResults parameter - // of the request. If there are more locales available, the nextToken field - // contains a token to get the next page of results. - BotLocaleSummaries []*BotLocaleSummary `locationName:"botLocaleSummaries" type:"list"` + // Summary information for the bot recommendations that meet the filter specified + // in this request. The length of the list is specified in the maxResults parameter + // of the request. If there are more bot recommendations available, the nextToken + // field contains a token to get the next page of results. + BotRecommendationSummaries []*BotRecommendationSummary `locationName:"botRecommendationSummaries" type:"list"` - // The version of the bot. - BotVersion *string `locationName:"botVersion" min:"1" type:"string"` + // The version of the bot that contains the bot recommendation list. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` + + // The identifier of the language and locale of the bot recommendation list. + LocaleId *string `locationName:"localeId" type:"string"` // A token that indicates whether there are more results to return in a response - // to the ListBotLocales operation. If the nextToken field is present, you send - // the contents as the nextToken parameter of a ListBotLocales operation request - // to get the next page of results. + // to the ListBotRecommendations operation. If the nextToken field is present, + // you send the contents as the nextToken parameter of a ListBotRecommendations + // operation request to get the next page of results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -17054,7 +18635,7 @@ type ListBotLocalesOutput 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 ListBotLocalesOutput) String() string { +func (s ListBotRecommendationsOutput) String() string { return awsutil.Prettify(s) } @@ -17063,30 +18644,36 @@ func (s ListBotLocalesOutput) 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 ListBotLocalesOutput) GoString() string { +func (s ListBotRecommendationsOutput) GoString() string { return s.String() } // SetBotId sets the BotId field's value. -func (s *ListBotLocalesOutput) SetBotId(v string) *ListBotLocalesOutput { +func (s *ListBotRecommendationsOutput) SetBotId(v string) *ListBotRecommendationsOutput { s.BotId = &v return s } -// SetBotLocaleSummaries sets the BotLocaleSummaries field's value. -func (s *ListBotLocalesOutput) SetBotLocaleSummaries(v []*BotLocaleSummary) *ListBotLocalesOutput { - s.BotLocaleSummaries = v +// SetBotRecommendationSummaries sets the BotRecommendationSummaries field's value. +func (s *ListBotRecommendationsOutput) SetBotRecommendationSummaries(v []*BotRecommendationSummary) *ListBotRecommendationsOutput { + s.BotRecommendationSummaries = v return s } // SetBotVersion sets the BotVersion field's value. -func (s *ListBotLocalesOutput) SetBotVersion(v string) *ListBotLocalesOutput { +func (s *ListBotRecommendationsOutput) SetBotVersion(v string) *ListBotRecommendationsOutput { s.BotVersion = &v return s } +// SetLocaleId sets the LocaleId field's value. +func (s *ListBotRecommendationsOutput) SetLocaleId(v string) *ListBotRecommendationsOutput { + s.LocaleId = &v + return s +} + // SetNextToken sets the NextToken field's value. -func (s *ListBotLocalesOutput) SetNextToken(v string) *ListBotLocalesOutput { +func (s *ListBotRecommendationsOutput) SetNextToken(v string) *ListBotRecommendationsOutput { s.NextToken = &v return s } @@ -18047,37 +19634,253 @@ type ListIntentsInput struct { // BotId is a required field BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` - // The version of the bot that contains the intent. + // The version of the bot that contains the intent. + // + // BotVersion is a required field + BotVersion *string `location:"uri" locationName:"botVersion" min:"1" type:"string" required:"true"` + + // Provides the specification of a filter used to limit the intents in the response + // to only those that match the filter specification. You can only specify one + // filter and only one string to filter on. + Filters []*IntentFilter `locationName:"filters" min:"1" type:"list"` + + // The identifier of the language and locale of the intents to list. 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"` + + // The maximum number of intents to return in each page of results. If there + // are fewer results than the max page size, only the actual number of results + // are returned. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // If the response from the ListIntents operation contains more results than + // specified in the maxResults parameter, a token is returned in the response. + // Use that token in the nextToken parameter to return the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` + + // Determines the sort order for the response from the ListIntents operation. + // You can choose to sort by the intent name or last updated date in either + // ascending or descending order. + SortBy *IntentSortBy `locationName:"sortBy" 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 ListIntentsInput) 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 ListIntentsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListIntentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListIntentsInput"} + 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.BotVersion == nil { + invalidParams.Add(request.NewErrParamRequired("BotVersion")) + } + if s.BotVersion != nil && len(*s.BotVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotVersion", 1)) + } + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.LocaleId == nil { + invalidParams.Add(request.NewErrParamRequired("LocaleId")) + } + if s.LocaleId != nil && len(*s.LocaleId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LocaleId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 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 s.SortBy != nil { + if err := s.SortBy.Validate(); err != nil { + invalidParams.AddNested("SortBy", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotId sets the BotId field's value. +func (s *ListIntentsInput) SetBotId(v string) *ListIntentsInput { + s.BotId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *ListIntentsInput) SetBotVersion(v string) *ListIntentsInput { + s.BotVersion = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *ListIntentsInput) SetFilters(v []*IntentFilter) *ListIntentsInput { + s.Filters = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *ListIntentsInput) SetLocaleId(v string) *ListIntentsInput { + s.LocaleId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListIntentsInput) SetMaxResults(v int64) *ListIntentsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListIntentsInput) SetNextToken(v string) *ListIntentsInput { + s.NextToken = &v + return s +} + +// SetSortBy sets the SortBy field's value. +func (s *ListIntentsInput) SetSortBy(v *IntentSortBy) *ListIntentsInput { + s.SortBy = v + return s +} + +type ListIntentsOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the bot that contains the intent. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The version of the bot that contains the intent. + BotVersion *string `locationName:"botVersion" min:"1" type:"string"` + + // Summary information for the intents that meet the filter criteria specified + // in the request. The length of the list is specified in the maxResults parameter + // of the request. If there are more intents available, the nextToken field + // contains a token to get the next page of results. + IntentSummaries []*IntentSummary `locationName:"intentSummaries" type:"list"` + + // The language and locale of the intents in the list. + LocaleId *string `locationName:"localeId" type:"string"` + + // A token that indicates whether there are more results to return in a response + // to the ListIntents operation. If the nextToken field is present, you send + // the contents as the nextToken parameter of a ListIntents operation request + // to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListIntentsOutput) 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 ListIntentsOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *ListIntentsOutput) SetBotId(v string) *ListIntentsOutput { + s.BotId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *ListIntentsOutput) SetBotVersion(v string) *ListIntentsOutput { + s.BotVersion = &v + return s +} + +// SetIntentSummaries sets the IntentSummaries field's value. +func (s *ListIntentsOutput) SetIntentSummaries(v []*IntentSummary) *ListIntentsOutput { + s.IntentSummaries = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *ListIntentsOutput) SetLocaleId(v string) *ListIntentsOutput { + s.LocaleId = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListIntentsOutput) SetNextToken(v string) *ListIntentsOutput { + s.NextToken = &v + return s +} + +type ListRecommendedIntentsInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot associated with the recommended intents. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` + + // The identifier of the bot recommendation that contains the recommended intents. // - // BotVersion is a required field - BotVersion *string `location:"uri" locationName:"botVersion" min:"1" type:"string" required:"true"` + // BotRecommendationId is a required field + BotRecommendationId *string `location:"uri" locationName:"botRecommendationId" min:"10" type:"string" required:"true"` - // Provides the specification of a filter used to limit the intents in the response - // to only those that match the filter specification. You can only specify one - // filter and only one string to filter on. - Filters []*IntentFilter `locationName:"filters" min:"1" type:"list"` + // The version of the bot that contains the recommended intents. + // + // 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 intents to list. 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). + // The identifier of the language and locale of the recommended intents. // // LocaleId is a required field LocaleId *string `location:"uri" locationName:"localeId" type:"string" required:"true"` - // The maximum number of intents to return in each page of results. If there - // are fewer results than the max page size, only the actual number of results - // are returned. + // The maximum number of bot recommendations to return in each page of results. + // If there are fewer results than the max page size, only the actual number + // of results are returned. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // If the response from the ListIntents operation contains more results than - // specified in the maxResults parameter, a token is returned in the response. + // If the response from the ListRecommendedIntents operation contains more results + // than specified in the maxResults parameter, a token is returned in the response. // Use that token in the nextToken parameter to return the next page of results. NextToken *string `locationName:"nextToken" type:"string"` - - // Determines the sort order for the response from the ListIntents operation. - // You can choose to sort by the intent name or last updated date in either - // ascending or descending order. - SortBy *IntentSortBy `locationName:"sortBy" type:"structure"` } // String returns the string representation. @@ -18085,7 +19888,7 @@ type ListIntentsInput 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 ListIntentsInput) String() string { +func (s ListRecommendedIntentsInput) String() string { return awsutil.Prettify(s) } @@ -18094,27 +19897,30 @@ func (s ListIntentsInput) 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 ListIntentsInput) GoString() string { +func (s ListRecommendedIntentsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListIntentsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListIntentsInput"} +func (s *ListRecommendedIntentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRecommendedIntentsInput"} 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) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BotVersion", 1)) - } - if s.Filters != nil && len(s.Filters) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + if s.BotVersion != nil && len(*s.BotVersion) < 5 { + invalidParams.Add(request.NewErrParamMinLen("BotVersion", 5)) } if s.LocaleId == nil { invalidParams.Add(request.NewErrParamRequired("LocaleId")) @@ -18125,21 +19931,6 @@ func (s *ListIntentsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 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 s.SortBy != nil { - if err := s.SortBy.Validate(); err != nil { - invalidParams.AddNested("SortBy", err.(request.ErrInvalidParams)) - } - } if invalidParams.Len() > 0 { return invalidParams @@ -18148,70 +19939,69 @@ func (s *ListIntentsInput) Validate() error { } // SetBotId sets the BotId field's value. -func (s *ListIntentsInput) SetBotId(v string) *ListIntentsInput { +func (s *ListRecommendedIntentsInput) SetBotId(v string) *ListRecommendedIntentsInput { s.BotId = &v return s } -// SetBotVersion sets the BotVersion field's value. -func (s *ListIntentsInput) SetBotVersion(v string) *ListIntentsInput { - s.BotVersion = &v +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *ListRecommendedIntentsInput) SetBotRecommendationId(v string) *ListRecommendedIntentsInput { + s.BotRecommendationId = &v return s } -// SetFilters sets the Filters field's value. -func (s *ListIntentsInput) SetFilters(v []*IntentFilter) *ListIntentsInput { - s.Filters = v +// SetBotVersion sets the BotVersion field's value. +func (s *ListRecommendedIntentsInput) SetBotVersion(v string) *ListRecommendedIntentsInput { + s.BotVersion = &v return s } // SetLocaleId sets the LocaleId field's value. -func (s *ListIntentsInput) SetLocaleId(v string) *ListIntentsInput { +func (s *ListRecommendedIntentsInput) SetLocaleId(v string) *ListRecommendedIntentsInput { s.LocaleId = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListIntentsInput) SetMaxResults(v int64) *ListIntentsInput { +func (s *ListRecommendedIntentsInput) SetMaxResults(v int64) *ListRecommendedIntentsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListIntentsInput) SetNextToken(v string) *ListIntentsInput { +func (s *ListRecommendedIntentsInput) SetNextToken(v string) *ListRecommendedIntentsInput { s.NextToken = &v return s } -// SetSortBy sets the SortBy field's value. -func (s *ListIntentsInput) SetSortBy(v *IntentSortBy) *ListIntentsInput { - s.SortBy = v - return s -} - -type ListIntentsOutput struct { +type ListRecommendedIntentsOutput struct { _ struct{} `type:"structure"` - // The identifier of the bot that contains the intent. + // The unique identifier of the bot associated with the recommended intent. BotId *string `locationName:"botId" min:"10" type:"string"` - // The version of the bot that contains the intent. - BotVersion *string `locationName:"botVersion" min:"1" type:"string"` + // The identifier of the bot recommendation that contains the recommended intent. + BotRecommendationId *string `locationName:"botRecommendationId" min:"10" type:"string"` - // Summary information for the intents that meet the filter criteria specified - // in the request. The length of the list is specified in the maxResults parameter - // of the request. If there are more intents available, the nextToken field - // contains a token to get the next page of results. - IntentSummaries []*IntentSummary `locationName:"intentSummaries" type:"list"` + // The version of the bot that contains the intent. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` - // The language and locale of the intents in the list. + // The identifier of the language and locale of the intents to list. 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"` // A token that indicates whether there are more results to return in a response - // to the ListIntents operation. If the nextToken field is present, you send - // the contents as the nextToken parameter of a ListIntents operation request - // to get the next page of results. + // to the ListRecommendedIntents operation. If the nextToken field is present, + // you send the contents as the nextToken parameter of a ListRecommendedIntents + // operation request to get the next page of results. NextToken *string `locationName:"nextToken" type:"string"` + + // Summary information for the intents that meet the filter criteria specified + // in the request. The length of the list is specified in the maxResults parameter + // of the request. If there are more intents available, the nextToken field + // contains a token to get the next page of results. + SummaryList []*RecommendedIntentSummary `locationName:"summaryList" type:"list"` } // String returns the string representation. @@ -18219,7 +20009,7 @@ type ListIntentsOutput 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 ListIntentsOutput) String() string { +func (s ListRecommendedIntentsOutput) String() string { return awsutil.Prettify(s) } @@ -18228,40 +20018,46 @@ func (s ListIntentsOutput) 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 ListIntentsOutput) GoString() string { +func (s ListRecommendedIntentsOutput) GoString() string { return s.String() } // SetBotId sets the BotId field's value. -func (s *ListIntentsOutput) SetBotId(v string) *ListIntentsOutput { +func (s *ListRecommendedIntentsOutput) SetBotId(v string) *ListRecommendedIntentsOutput { s.BotId = &v return s } -// SetBotVersion sets the BotVersion field's value. -func (s *ListIntentsOutput) SetBotVersion(v string) *ListIntentsOutput { - s.BotVersion = &v +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *ListRecommendedIntentsOutput) SetBotRecommendationId(v string) *ListRecommendedIntentsOutput { + s.BotRecommendationId = &v return s } -// SetIntentSummaries sets the IntentSummaries field's value. -func (s *ListIntentsOutput) SetIntentSummaries(v []*IntentSummary) *ListIntentsOutput { - s.IntentSummaries = v +// SetBotVersion sets the BotVersion field's value. +func (s *ListRecommendedIntentsOutput) SetBotVersion(v string) *ListRecommendedIntentsOutput { + s.BotVersion = &v return s } // SetLocaleId sets the LocaleId field's value. -func (s *ListIntentsOutput) SetLocaleId(v string) *ListIntentsOutput { +func (s *ListRecommendedIntentsOutput) SetLocaleId(v string) *ListRecommendedIntentsOutput { s.LocaleId = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListIntentsOutput) SetNextToken(v string) *ListIntentsOutput { +func (s *ListRecommendedIntentsOutput) SetNextToken(v string) *ListRecommendedIntentsOutput { s.NextToken = &v return s } +// SetSummaryList sets the SummaryList field's value. +func (s *ListRecommendedIntentsOutput) SetSummaryList(v []*RecommendedIntentSummary) *ListRecommendedIntentsOutput { + s.SummaryList = v + return s +} + type ListSlotTypesInput struct { _ struct{} `type:"structure"` @@ -19150,6 +20946,55 @@ func (s *OutputContext) SetTurnsToLive(v int64) *OutputContext { return s } +// The object that contains a path format that will be applied when Amazon Lex +// reads the transcript file in the bucket you provide. Specify this object +// if you only want Lex to read a subset of files in your Amazon S3 bucket. +type PathFormat struct { + _ struct{} `type:"structure"` + + // A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 + // bucket. Specify this list if you only want Lex to read the files under this + // set of sub-folders. + ObjectPrefixes []*string `locationName:"objectPrefixes" 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 PathFormat) 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 PathFormat) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PathFormat) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PathFormat"} + if s.ObjectPrefixes != nil && len(s.ObjectPrefixes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ObjectPrefixes", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetObjectPrefixes sets the ObjectPrefixes field's value. +func (s *PathFormat) SetObjectPrefixes(v []*string) *PathFormat { + s.ObjectPrefixes = v + return s +} + // Defines an ASCII text message to send to the user. type PlainTextMessage struct { _ struct{} `type:"structure"` @@ -19491,6 +21336,57 @@ func (s *PromptSpecification) SetMessageGroups(v []*MessageGroup) *PromptSpecifi return s } +// An object that contains a summary of a recommended intent. +type RecommendedIntentSummary struct { + _ struct{} `type:"structure"` + + // The unique identifier of a recommended intent associated with the bot recommendation. + IntentId *string `locationName:"intentId" min:"10" type:"string"` + + // The name of a recommended intent associated with the bot recommendation. + IntentName *string `locationName:"intentName" min:"1" type:"string"` + + // The count of sample utterances of a recommended intent that is associated + // with a bot recommendation. + SampleUtterancesCount *int64 `locationName:"sampleUtterancesCount" 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 RecommendedIntentSummary) 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 RecommendedIntentSummary) GoString() string { + return s.String() +} + +// SetIntentId sets the IntentId field's value. +func (s *RecommendedIntentSummary) SetIntentId(v string) *RecommendedIntentSummary { + s.IntentId = &v + return s +} + +// SetIntentName sets the IntentName field's value. +func (s *RecommendedIntentSummary) SetIntentName(v string) *RecommendedIntentSummary { + s.IntentName = &v + return s +} + +// SetSampleUtterancesCount sets the SampleUtterancesCount field's value. +func (s *RecommendedIntentSummary) SetSampleUtterancesCount(v int64) *RecommendedIntentSummary { + s.SampleUtterancesCount = &v + return s +} + // Specifies the time window that utterance statistics are returned for. The // time window is always relative to the last time that the that utterances // were aggregated. For example, if the ListAggregatedUtterances operation is @@ -19703,36 +21599,127 @@ func (s *ResponseSpecification) Validate() error { return nil } -// SetAllowInterrupt sets the AllowInterrupt field's value. -func (s *ResponseSpecification) SetAllowInterrupt(v bool) *ResponseSpecification { - s.AllowInterrupt = &v +// SetAllowInterrupt sets the AllowInterrupt field's value. +func (s *ResponseSpecification) SetAllowInterrupt(v bool) *ResponseSpecification { + s.AllowInterrupt = &v + return s +} + +// SetMessageGroups sets the MessageGroups field's value. +func (s *ResponseSpecification) SetMessageGroups(v []*MessageGroup) *ResponseSpecification { + s.MessageGroups = v + return s +} + +// Specifies an Amazon S3 bucket for logging audio conversations +type S3BucketLogDestination struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key + // for encrypting audio log files stored in an S3 bucket. + KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` + + // The S3 prefix to assign to audio log files. + // + // LogPrefix is a required field + LogPrefix *string `locationName:"logPrefix" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files + // are stored. + // + // S3BucketArn is a required field + S3BucketArn *string `locationName:"s3BucketArn" 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 S3BucketLogDestination) 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 S3BucketLogDestination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3BucketLogDestination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3BucketLogDestination"} + if s.KmsKeyArn != nil && len(*s.KmsKeyArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyArn", 20)) + } + if s.LogPrefix == nil { + invalidParams.Add(request.NewErrParamRequired("LogPrefix")) + } + if s.S3BucketArn == nil { + invalidParams.Add(request.NewErrParamRequired("S3BucketArn")) + } + if s.S3BucketArn != nil && len(*s.S3BucketArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3BucketArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKmsKeyArn sets the KmsKeyArn field's value. +func (s *S3BucketLogDestination) SetKmsKeyArn(v string) *S3BucketLogDestination { + s.KmsKeyArn = &v + return s +} + +// SetLogPrefix sets the LogPrefix field's value. +func (s *S3BucketLogDestination) SetLogPrefix(v string) *S3BucketLogDestination { + s.LogPrefix = &v return s } -// SetMessageGroups sets the MessageGroups field's value. -func (s *ResponseSpecification) SetMessageGroups(v []*MessageGroup) *ResponseSpecification { - s.MessageGroups = v +// SetS3BucketArn sets the S3BucketArn field's value. +func (s *S3BucketLogDestination) SetS3BucketArn(v string) *S3BucketLogDestination { + s.S3BucketArn = &v return s } -// Specifies an Amazon S3 bucket for logging audio conversations -type S3BucketLogDestination struct { +// The object representing the Amazon S3 bucket containing the transcript, as +// well as the associated metadata. +type S3BucketTranscriptSource struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key - // for encrypting audio log files stored in an S3 bucket. + // The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. + // Only use this field if your bucket is encrypted using a customer managed + // KMS key. KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` - // The S3 prefix to assign to audio log files. + // The object that contains a path format that will be applied when Amazon Lex + // reads the transcript file in the bucket you provide. Specify this object + // if you only want Lex to read a subset of files in your Amazon S3 bucket. + PathFormat *PathFormat `locationName:"pathFormat" type:"structure"` + + // The name of the bucket containing the transcript and the associated metadata. // - // LogPrefix is a required field - LogPrefix *string `locationName:"logPrefix" type:"string" required:"true"` + // S3BucketName is a required field + S3BucketName *string `locationName:"s3BucketName" min:"3" type:"string" required:"true"` - // The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files - // are stored. + // The object that contains the filter which will be applied when Amazon Lex + // reads through the Amazon S3 bucket. Specify this object if you want Amazon + // Lex to read only a subset of the Amazon S3 bucket based on the filter you + // provide. + TranscriptFilter *TranscriptFilter `locationName:"transcriptFilter" type:"structure"` + + // The format of the transcript content. Currently, Genie only supports the + // Amazon Lex transcript format. // - // S3BucketArn is a required field - S3BucketArn *string `locationName:"s3BucketArn" min:"1" type:"string" required:"true"` + // TranscriptFormat is a required field + TranscriptFormat *string `locationName:"transcriptFormat" type:"string" required:"true" enum:"TranscriptFormat"` } // String returns the string representation. @@ -19740,7 +21727,7 @@ type S3BucketLogDestination 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 S3BucketLogDestination) String() string { +func (s S3BucketTranscriptSource) String() string { return awsutil.Prettify(s) } @@ -19749,24 +21736,34 @@ func (s S3BucketLogDestination) 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 S3BucketLogDestination) GoString() string { +func (s S3BucketTranscriptSource) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *S3BucketLogDestination) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "S3BucketLogDestination"} +func (s *S3BucketTranscriptSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3BucketTranscriptSource"} if s.KmsKeyArn != nil && len(*s.KmsKeyArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("KmsKeyArn", 20)) } - if s.LogPrefix == nil { - invalidParams.Add(request.NewErrParamRequired("LogPrefix")) + if s.S3BucketName == nil { + invalidParams.Add(request.NewErrParamRequired("S3BucketName")) } - if s.S3BucketArn == nil { - invalidParams.Add(request.NewErrParamRequired("S3BucketArn")) + if s.S3BucketName != nil && len(*s.S3BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("S3BucketName", 3)) } - if s.S3BucketArn != nil && len(*s.S3BucketArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("S3BucketArn", 1)) + if s.TranscriptFormat == nil { + invalidParams.Add(request.NewErrParamRequired("TranscriptFormat")) + } + if s.PathFormat != nil { + if err := s.PathFormat.Validate(); err != nil { + invalidParams.AddNested("PathFormat", err.(request.ErrInvalidParams)) + } + } + if s.TranscriptFilter != nil { + if err := s.TranscriptFilter.Validate(); err != nil { + invalidParams.AddNested("TranscriptFilter", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -19776,20 +21773,32 @@ func (s *S3BucketLogDestination) Validate() error { } // SetKmsKeyArn sets the KmsKeyArn field's value. -func (s *S3BucketLogDestination) SetKmsKeyArn(v string) *S3BucketLogDestination { +func (s *S3BucketTranscriptSource) SetKmsKeyArn(v string) *S3BucketTranscriptSource { s.KmsKeyArn = &v return s } -// SetLogPrefix sets the LogPrefix field's value. -func (s *S3BucketLogDestination) SetLogPrefix(v string) *S3BucketLogDestination { - s.LogPrefix = &v +// SetPathFormat sets the PathFormat field's value. +func (s *S3BucketTranscriptSource) SetPathFormat(v *PathFormat) *S3BucketTranscriptSource { + s.PathFormat = v return s } -// SetS3BucketArn sets the S3BucketArn field's value. -func (s *S3BucketLogDestination) SetS3BucketArn(v string) *S3BucketLogDestination { - s.S3BucketArn = &v +// SetS3BucketName sets the S3BucketName field's value. +func (s *S3BucketTranscriptSource) SetS3BucketName(v string) *S3BucketTranscriptSource { + s.S3BucketName = &v + return s +} + +// SetTranscriptFilter sets the TranscriptFilter field's value. +func (s *S3BucketTranscriptSource) SetTranscriptFilter(v *TranscriptFilter) *S3BucketTranscriptSource { + s.TranscriptFilter = v + return s +} + +// SetTranscriptFormat sets the TranscriptFormat field's value. +func (s *S3BucketTranscriptSource) SetTranscriptFormat(v string) *S3BucketTranscriptSource { + s.TranscriptFormat = &v return s } @@ -19942,6 +21951,266 @@ func (s *SampleValue) SetValue(v string) *SampleValue { return s } +type SearchAssociatedTranscriptsInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot associated with the transcripts that you + // are searching. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` + + // The unique identifier of the bot recommendation associated with the transcripts + // to search. + // + // BotRecommendationId is a required field + BotRecommendationId *string `location:"uri" locationName:"botRecommendationId" min:"10" type:"string" required:"true"` + + // The version of the bot containing the transcripts that you are searching. + // + // BotVersion is a required field + BotVersion *string `location:"uri" locationName:"botVersion" min:"1" type:"string" required:"true"` + + // A list of filter objects. + // + // Filters is a required field + Filters []*AssociatedTranscriptFilter `locationName:"filters" min:"1" type:"list" required:"true"` + + // 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 (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"` + + // The maximum number of bot recommendations to return in each page of results. + // If there are fewer results than the max page size, only the actual number + // of results are returned. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // If the response from the SearchAssociatedTranscriptsRequest operation contains + // more results than specified in the maxResults parameter, an index is returned + // in the response. Use that index in the nextIndex parameter to return the + // next page of results. + NextIndex *int64 `locationName:"nextIndex" type:"integer"` + + // How SearchResults are ordered. Valid values are Ascending or Descending. + // The default is Descending. + SearchOrder *string `locationName:"searchOrder" type:"string" enum:"SearchOrder"` +} + +// 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 SearchAssociatedTranscriptsInput) 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 SearchAssociatedTranscriptsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchAssociatedTranscriptsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchAssociatedTranscriptsInput"} + 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) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotVersion", 1)) + } + 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.LocaleId == nil { + invalidParams.Add(request.NewErrParamRequired("LocaleId")) + } + if s.LocaleId != nil && len(*s.LocaleId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LocaleId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 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 +} + +// SetBotId sets the BotId field's value. +func (s *SearchAssociatedTranscriptsInput) SetBotId(v string) *SearchAssociatedTranscriptsInput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *SearchAssociatedTranscriptsInput) SetBotRecommendationId(v string) *SearchAssociatedTranscriptsInput { + s.BotRecommendationId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *SearchAssociatedTranscriptsInput) SetBotVersion(v string) *SearchAssociatedTranscriptsInput { + s.BotVersion = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *SearchAssociatedTranscriptsInput) SetFilters(v []*AssociatedTranscriptFilter) *SearchAssociatedTranscriptsInput { + s.Filters = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *SearchAssociatedTranscriptsInput) SetLocaleId(v string) *SearchAssociatedTranscriptsInput { + s.LocaleId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchAssociatedTranscriptsInput) SetMaxResults(v int64) *SearchAssociatedTranscriptsInput { + s.MaxResults = &v + return s +} + +// SetNextIndex sets the NextIndex field's value. +func (s *SearchAssociatedTranscriptsInput) SetNextIndex(v int64) *SearchAssociatedTranscriptsInput { + s.NextIndex = &v + return s +} + +// SetSearchOrder sets the SearchOrder field's value. +func (s *SearchAssociatedTranscriptsInput) SetSearchOrder(v string) *SearchAssociatedTranscriptsInput { + s.SearchOrder = &v + return s +} + +type SearchAssociatedTranscriptsOutput struct { + _ struct{} `type:"structure"` + + // The object that contains the associated transcript that meet the criteria + // you specified. + AssociatedTranscripts []*AssociatedTranscript `locationName:"associatedTranscripts" type:"list"` + + // The unique identifier of the bot associated with the transcripts that you + // are searching. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The unique identifier of the bot recommendation associated with the transcripts + // to search. + BotRecommendationId *string `locationName:"botRecommendationId" min:"10" type:"string"` + + // The version of the bot containing the transcripts that you are searching. + BotVersion *string `locationName:"botVersion" min:"1" type:"string"` + + // 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 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + LocaleId *string `locationName:"localeId" type:"string"` + + // A index that indicates whether there are more results to return in a response + // to the SearchAssociatedTranscripts operation. If the nextIndex field is present, + // you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest + // operation to get the next page of results. + NextIndex *int64 `locationName:"nextIndex" type:"integer"` + + // The total number of transcripts returned by the search. + TotalResults *int64 `locationName:"totalResults" min:"1" 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 SearchAssociatedTranscriptsOutput) 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 SearchAssociatedTranscriptsOutput) GoString() string { + return s.String() +} + +// SetAssociatedTranscripts sets the AssociatedTranscripts field's value. +func (s *SearchAssociatedTranscriptsOutput) SetAssociatedTranscripts(v []*AssociatedTranscript) *SearchAssociatedTranscriptsOutput { + s.AssociatedTranscripts = v + return s +} + +// SetBotId sets the BotId field's value. +func (s *SearchAssociatedTranscriptsOutput) SetBotId(v string) *SearchAssociatedTranscriptsOutput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *SearchAssociatedTranscriptsOutput) SetBotRecommendationId(v string) *SearchAssociatedTranscriptsOutput { + s.BotRecommendationId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *SearchAssociatedTranscriptsOutput) SetBotVersion(v string) *SearchAssociatedTranscriptsOutput { + s.BotVersion = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *SearchAssociatedTranscriptsOutput) SetLocaleId(v string) *SearchAssociatedTranscriptsOutput { + s.LocaleId = &v + return s +} + +// SetNextIndex sets the NextIndex field's value. +func (s *SearchAssociatedTranscriptsOutput) SetNextIndex(v int64) *SearchAssociatedTranscriptsOutput { + s.NextIndex = &v + return s +} + +// SetTotalResults sets the TotalResults field's value. +func (s *SearchAssociatedTranscriptsOutput) SetTotalResults(v int64) *SearchAssociatedTranscriptsOutput { + s.TotalResults = &v + return s +} + // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment // of user utterances. type SentimentAnalysisSettings struct { @@ -20601,6 +22870,39 @@ func (s *SlotTypeSortBy) SetOrder(v string) *SlotTypeSortBy { return s } +// The object that contains the statistical summary of the recommended slot +// type associated with the bot recommendation. +type SlotTypeStatistics struct { + _ struct{} `type:"structure"` + + // The number of recommended slot types associated with the bot recommendation. + DiscoveredSlotTypeCount *int64 `locationName:"discoveredSlotTypeCount" 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 SlotTypeStatistics) 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 SlotTypeStatistics) GoString() string { + return s.String() +} + +// SetDiscoveredSlotTypeCount sets the DiscoveredSlotTypeCount field's value. +func (s *SlotTypeStatistics) SetDiscoveredSlotTypeCount(v int64) *SlotTypeStatistics { + s.DiscoveredSlotTypeCount = &v + return s +} + // Provides summary information about a slot type. type SlotTypeSummary struct { _ struct{} `type:"structure"` @@ -20992,6 +23294,229 @@ func (s *SlotValueSelectionSetting) SetResolutionStrategy(v string) *SlotValueSe return s } +type StartBotRecommendationInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot containing the bot recommendation. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" 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 object representing the passwords that will be used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used + // to encrypt the associated metadata. + EncryptionSetting *EncryptionSetting `locationName:"encryptionSetting" type:"structure"` + + // 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 (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"` + + // The object representing the Amazon S3 bucket containing the transcript, as + // well as the associated metadata. + // + // TranscriptSourceSetting is a required field + TranscriptSourceSetting *TranscriptSourceSetting `locationName:"transcriptSourceSetting" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartBotRecommendationInput) 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 StartBotRecommendationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartBotRecommendationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartBotRecommendationInput"} + 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.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 s.TranscriptSourceSetting == nil { + invalidParams.Add(request.NewErrParamRequired("TranscriptSourceSetting")) + } + if s.EncryptionSetting != nil { + if err := s.EncryptionSetting.Validate(); err != nil { + invalidParams.AddNested("EncryptionSetting", err.(request.ErrInvalidParams)) + } + } + if s.TranscriptSourceSetting != nil { + if err := s.TranscriptSourceSetting.Validate(); err != nil { + invalidParams.AddNested("TranscriptSourceSetting", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotId sets the BotId field's value. +func (s *StartBotRecommendationInput) SetBotId(v string) *StartBotRecommendationInput { + s.BotId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *StartBotRecommendationInput) SetBotVersion(v string) *StartBotRecommendationInput { + s.BotVersion = &v + return s +} + +// SetEncryptionSetting sets the EncryptionSetting field's value. +func (s *StartBotRecommendationInput) SetEncryptionSetting(v *EncryptionSetting) *StartBotRecommendationInput { + s.EncryptionSetting = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *StartBotRecommendationInput) SetLocaleId(v string) *StartBotRecommendationInput { + s.LocaleId = &v + return s +} + +// SetTranscriptSourceSetting sets the TranscriptSourceSetting field's value. +func (s *StartBotRecommendationInput) SetTranscriptSourceSetting(v *TranscriptSourceSetting) *StartBotRecommendationInput { + s.TranscriptSourceSetting = v + return s +} + +type StartBotRecommendationOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot containing the bot recommendation. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The identifier of the bot recommendation that you have created. + 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 bot recommendation. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` + + // A timestamp of the date and time that the bot recommendation was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used + // to encrypt the associated metadata. + EncryptionSetting *EncryptionSetting `locationName:"encryptionSetting" type:"structure"` + + // 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 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + LocaleId *string `locationName:"localeId" type:"string"` + + // The object representing the Amazon S3 bucket containing the transcript, as + // well as the associated metadata. + TranscriptSourceSetting *TranscriptSourceSetting `locationName:"transcriptSourceSetting" 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 StartBotRecommendationOutput) 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 StartBotRecommendationOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *StartBotRecommendationOutput) SetBotId(v string) *StartBotRecommendationOutput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *StartBotRecommendationOutput) SetBotRecommendationId(v string) *StartBotRecommendationOutput { + s.BotRecommendationId = &v + return s +} + +// SetBotRecommendationStatus sets the BotRecommendationStatus field's value. +func (s *StartBotRecommendationOutput) SetBotRecommendationStatus(v string) *StartBotRecommendationOutput { + s.BotRecommendationStatus = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *StartBotRecommendationOutput) SetBotVersion(v string) *StartBotRecommendationOutput { + s.BotVersion = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *StartBotRecommendationOutput) SetCreationDateTime(v time.Time) *StartBotRecommendationOutput { + s.CreationDateTime = &v + return s +} + +// SetEncryptionSetting sets the EncryptionSetting field's value. +func (s *StartBotRecommendationOutput) SetEncryptionSetting(v *EncryptionSetting) *StartBotRecommendationOutput { + s.EncryptionSetting = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *StartBotRecommendationOutput) SetLocaleId(v string) *StartBotRecommendationOutput { + s.LocaleId = &v + return s +} + +// SetTranscriptSourceSetting sets the TranscriptSourceSetting field's value. +func (s *StartBotRecommendationOutput) SetTranscriptSourceSetting(v *TranscriptSourceSetting) *StartBotRecommendationOutput { + s.TranscriptSourceSetting = v + return s +} + type StartImportInput struct { _ struct{} `type:"structure"` @@ -21469,26 +23994,139 @@ func (s *TextLogSetting) Validate() error { return nil } -// SetDestination sets the Destination field's value. -func (s *TextLogSetting) SetDestination(v *TextLogDestination) *TextLogSetting { - s.Destination = v - return s -} - -// SetEnabled sets the Enabled field's value. -func (s *TextLogSetting) SetEnabled(v bool) *TextLogSetting { - s.Enabled = &v +// SetDestination sets the Destination field's value. +func (s *TextLogSetting) SetDestination(v *TextLogDestination) *TextLogSetting { + s.Destination = v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *TextLogSetting) SetEnabled(v bool) *TextLogSetting { + s.Enabled = &v + return s +} + +// Your request rate is too high. Reduce the frequency of requests. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" 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 ThrottlingException) 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 ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The object representing the filter that Amazon Lex will use to select the +// appropriate transcript. +type TranscriptFilter struct { + _ struct{} `type:"structure"` + + // The object representing the filter that Amazon Lex will use to select the + // appropriate transcript when the transcript format is the Amazon Lex format. + LexTranscriptFilter *LexTranscriptFilter `locationName:"lexTranscriptFilter" 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 TranscriptFilter) 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 TranscriptFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TranscriptFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TranscriptFilter"} + if s.LexTranscriptFilter != nil { + if err := s.LexTranscriptFilter.Validate(); err != nil { + invalidParams.AddNested("LexTranscriptFilter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLexTranscriptFilter sets the LexTranscriptFilter field's value. +func (s *TranscriptFilter) SetLexTranscriptFilter(v *LexTranscriptFilter) *TranscriptFilter { + s.LexTranscriptFilter = v return s } -// Your request rate is too high. Reduce the frequency of requests. -type ThrottlingException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - - Message_ *string `locationName:"message" type:"string"` +// Indicates the setting of the location where the transcript is stored. +type TranscriptSourceSetting struct { + _ struct{} `type:"structure"` - RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` + // Indicates the setting of the Amazon S3 bucket where the transcript is stored. + S3BucketTranscriptSource *S3BucketTranscriptSource `locationName:"s3BucketTranscriptSource" type:"structure"` } // String returns the string representation. @@ -21496,7 +24134,7 @@ type ThrottlingException 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 ThrottlingException) String() string { +func (s TranscriptSourceSetting) String() string { return awsutil.Prettify(s) } @@ -21505,46 +24143,29 @@ func (s ThrottlingException) 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 ThrottlingException) GoString() string { +func (s TranscriptSourceSetting) GoString() string { return s.String() } -func newErrorThrottlingException(v protocol.ResponseMetadata) error { - return &ThrottlingException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *TranscriptSourceSetting) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TranscriptSourceSetting"} + if s.S3BucketTranscriptSource != nil { + if err := s.S3BucketTranscriptSource.Validate(); err != nil { + invalidParams.AddNested("S3BucketTranscriptSource", err.(request.ErrInvalidParams)) + } } -} - -// Code returns the exception type name. -func (s *ThrottlingException) Code() string { - return "ThrottlingException" -} -// Message returns the exception's message. -func (s *ThrottlingException) Message() string { - if s.Message_ != nil { - return *s.Message_ + if invalidParams.Len() > 0 { + return invalidParams } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ThrottlingException) OrigErr() error { return nil } -func (s *ThrottlingException) Error() string { - return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) -} - -// Status code returns the HTTP status code for the request's response error. -func (s *ThrottlingException) StatusCode() int { - return s.RespMetadata.StatusCode -} - -// RequestID returns the service's response RequestID for request. -func (s *ThrottlingException) RequestID() string { - return s.RespMetadata.RequestID +// SetS3BucketTranscriptSource sets the S3BucketTranscriptSource field's value. +func (s *TranscriptSourceSetting) SetS3BucketTranscriptSource(v *S3BucketTranscriptSource) *TranscriptSourceSetting { + s.S3BucketTranscriptSource = v + return s } type UntagResourceInput struct { @@ -22410,6 +25031,242 @@ func (s *UpdateBotOutput) SetRoleArn(v string) *UpdateBotOutput { return s } +type UpdateBotRecommendationInput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot containing the bot recommendation to be + // updated. + // + // 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 updated. + // + // 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 to be updated. + // + // BotVersion is a required field + BotVersion *string `location:"uri" locationName:"botVersion" min:"5" type:"string" required:"true"` + + // The object representing the passwords that will be used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used + // to encrypt the associated metadata. + // + // EncryptionSetting is a required field + EncryptionSetting *EncryptionSetting `locationName:"encryptionSetting" type:"structure" required:"true"` + + // 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 (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 UpdateBotRecommendationInput) 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 UpdateBotRecommendationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateBotRecommendationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateBotRecommendationInput"} + 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.EncryptionSetting == nil { + invalidParams.Add(request.NewErrParamRequired("EncryptionSetting")) + } + if s.LocaleId == nil { + invalidParams.Add(request.NewErrParamRequired("LocaleId")) + } + if s.LocaleId != nil && len(*s.LocaleId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LocaleId", 1)) + } + if s.EncryptionSetting != nil { + if err := s.EncryptionSetting.Validate(); err != nil { + invalidParams.AddNested("EncryptionSetting", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotId sets the BotId field's value. +func (s *UpdateBotRecommendationInput) SetBotId(v string) *UpdateBotRecommendationInput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *UpdateBotRecommendationInput) SetBotRecommendationId(v string) *UpdateBotRecommendationInput { + s.BotRecommendationId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *UpdateBotRecommendationInput) SetBotVersion(v string) *UpdateBotRecommendationInput { + s.BotVersion = &v + return s +} + +// SetEncryptionSetting sets the EncryptionSetting field's value. +func (s *UpdateBotRecommendationInput) SetEncryptionSetting(v *EncryptionSetting) *UpdateBotRecommendationInput { + s.EncryptionSetting = v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *UpdateBotRecommendationInput) SetLocaleId(v string) *UpdateBotRecommendationInput { + s.LocaleId = &v + return s +} + +type UpdateBotRecommendationOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot containing the bot recommendation that has + // been updated. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The unique identifier of the bot recommendation to be updated. + 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 bot recommendation that has been updated. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` + + // A timestamp of the date and time that the bot recommendation was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used + // to encrypt the associated metadata. + EncryptionSetting *EncryptionSetting `locationName:"encryptionSetting" type:"structure"` + + // A timestamp of the date and time that the bot recommendation was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // 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 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + LocaleId *string `locationName:"localeId" type:"string"` + + // The object representing the Amazon S3 bucket containing the transcript, as + // well as the associated metadata. + TranscriptSourceSetting *TranscriptSourceSetting `locationName:"transcriptSourceSetting" 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 UpdateBotRecommendationOutput) 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 UpdateBotRecommendationOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *UpdateBotRecommendationOutput) SetBotId(v string) *UpdateBotRecommendationOutput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *UpdateBotRecommendationOutput) SetBotRecommendationId(v string) *UpdateBotRecommendationOutput { + s.BotRecommendationId = &v + return s +} + +// SetBotRecommendationStatus sets the BotRecommendationStatus field's value. +func (s *UpdateBotRecommendationOutput) SetBotRecommendationStatus(v string) *UpdateBotRecommendationOutput { + s.BotRecommendationStatus = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *UpdateBotRecommendationOutput) SetBotVersion(v string) *UpdateBotRecommendationOutput { + s.BotVersion = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *UpdateBotRecommendationOutput) SetCreationDateTime(v time.Time) *UpdateBotRecommendationOutput { + s.CreationDateTime = &v + return s +} + +// SetEncryptionSetting sets the EncryptionSetting field's value. +func (s *UpdateBotRecommendationOutput) SetEncryptionSetting(v *EncryptionSetting) *UpdateBotRecommendationOutput { + s.EncryptionSetting = v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *UpdateBotRecommendationOutput) SetLastUpdatedDateTime(v time.Time) *UpdateBotRecommendationOutput { + s.LastUpdatedDateTime = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *UpdateBotRecommendationOutput) SetLocaleId(v string) *UpdateBotRecommendationOutput { + s.LocaleId = &v + return s +} + +// SetTranscriptSourceSetting sets the TranscriptSourceSetting field's value. +func (s *UpdateBotRecommendationOutput) SetTranscriptSourceSetting(v *TranscriptSourceSetting) *UpdateBotRecommendationOutput { + s.TranscriptSourceSetting = v + return s +} + type UpdateExportInput struct { _ struct{} `type:"structure"` @@ -24138,6 +26995,22 @@ func AggregatedUtterancesSortAttribute_Values() []string { } } +const ( + // AssociatedTranscriptFilterNameIntentId is a AssociatedTranscriptFilterName enum value + AssociatedTranscriptFilterNameIntentId = "IntentId" + + // AssociatedTranscriptFilterNameSlotTypeId is a AssociatedTranscriptFilterName enum value + AssociatedTranscriptFilterNameSlotTypeId = "SlotTypeId" +) + +// AssociatedTranscriptFilterName_Values returns all elements of the AssociatedTranscriptFilterName enum +func AssociatedTranscriptFilterName_Values() []string { + return []string{ + AssociatedTranscriptFilterNameIntentId, + AssociatedTranscriptFilterNameSlotTypeId, + } +} + const ( // BotAliasStatusCreating is a BotAliasStatus enum value BotAliasStatusCreating = "Creating" @@ -24254,6 +27127,9 @@ const ( // BotLocaleStatusImporting is a BotLocaleStatus enum value BotLocaleStatusImporting = "Importing" + + // BotLocaleStatusProcessing is a BotLocaleStatus enum value + BotLocaleStatusProcessing = "Processing" ) // BotLocaleStatus_Values returns all elements of the BotLocaleStatus enum @@ -24267,6 +27143,43 @@ func BotLocaleStatus_Values() []string { BotLocaleStatusDeleting, BotLocaleStatusNotBuilt, BotLocaleStatusImporting, + BotLocaleStatusProcessing, + } +} + +const ( + // BotRecommendationStatusProcessing is a BotRecommendationStatus enum value + BotRecommendationStatusProcessing = "Processing" + + // BotRecommendationStatusDeleting is a BotRecommendationStatus enum value + BotRecommendationStatusDeleting = "Deleting" + + // BotRecommendationStatusDeleted is a BotRecommendationStatus enum value + BotRecommendationStatusDeleted = "Deleted" + + // BotRecommendationStatusDownloading is a BotRecommendationStatus enum value + BotRecommendationStatusDownloading = "Downloading" + + // BotRecommendationStatusUpdating is a BotRecommendationStatus enum value + BotRecommendationStatusUpdating = "Updating" + + // BotRecommendationStatusAvailable is a BotRecommendationStatus enum value + BotRecommendationStatusAvailable = "Available" + + // BotRecommendationStatusFailed is a BotRecommendationStatus enum value + BotRecommendationStatusFailed = "Failed" +) + +// BotRecommendationStatus_Values returns all elements of the BotRecommendationStatus enum +func BotRecommendationStatus_Values() []string { + return []string{ + BotRecommendationStatusProcessing, + BotRecommendationStatusDeleting, + BotRecommendationStatusDeleted, + BotRecommendationStatusDownloading, + BotRecommendationStatusUpdating, + BotRecommendationStatusAvailable, + BotRecommendationStatusFailed, } } @@ -24560,6 +27473,9 @@ const ( // MergeStrategyFailOnConflict is a MergeStrategy enum value MergeStrategyFailOnConflict = "FailOnConflict" + + // MergeStrategyAppend is a MergeStrategy enum value + MergeStrategyAppend = "Append" ) // MergeStrategy_Values returns all elements of the MergeStrategy enum @@ -24567,6 +27483,7 @@ func MergeStrategy_Values() []string { return []string{ MergeStrategyOverwrite, MergeStrategyFailOnConflict, + MergeStrategyAppend, } } @@ -24586,6 +27503,22 @@ func ObfuscationSettingType_Values() []string { } } +const ( + // SearchOrderAscending is a SearchOrder enum value + SearchOrderAscending = "Ascending" + + // SearchOrderDescending is a SearchOrder enum value + SearchOrderDescending = "Descending" +) + +// SearchOrder_Values returns all elements of the SearchOrder enum +func SearchOrder_Values() []string { + return []string{ + SearchOrderAscending, + SearchOrderDescending, + } +} + const ( // SlotConstraintRequired is a SlotConstraint enum value SlotConstraintRequired = "Required" @@ -24742,6 +27675,18 @@ func TimeDimension_Values() []string { } } +const ( + // TranscriptFormatLex is a TranscriptFormat enum value + TranscriptFormatLex = "Lex" +) + +// TranscriptFormat_Values returns all elements of the TranscriptFormat enum +func TranscriptFormat_Values() []string { + return []string{ + TranscriptFormatLex, + } +} + const ( // VoiceEngineStandard is a VoiceEngine enum value VoiceEngineStandard = "standard" diff --git a/service/lexmodelsv2/lexmodelsv2iface/interface.go b/service/lexmodelsv2/lexmodelsv2iface/interface.go index bd816a842ca..18b547c5587 100644 --- a/service/lexmodelsv2/lexmodelsv2iface/interface.go +++ b/service/lexmodelsv2/lexmodelsv2iface/interface.go @@ -168,6 +168,10 @@ type LexModelsV2API interface { DescribeBotLocaleWithContext(aws.Context, *lexmodelsv2.DescribeBotLocaleInput, ...request.Option) (*lexmodelsv2.DescribeBotLocaleOutput, error) DescribeBotLocaleRequest(*lexmodelsv2.DescribeBotLocaleInput) (*request.Request, *lexmodelsv2.DescribeBotLocaleOutput) + DescribeBotRecommendation(*lexmodelsv2.DescribeBotRecommendationInput) (*lexmodelsv2.DescribeBotRecommendationOutput, error) + DescribeBotRecommendationWithContext(aws.Context, *lexmodelsv2.DescribeBotRecommendationInput, ...request.Option) (*lexmodelsv2.DescribeBotRecommendationOutput, error) + DescribeBotRecommendationRequest(*lexmodelsv2.DescribeBotRecommendationInput) (*request.Request, *lexmodelsv2.DescribeBotRecommendationOutput) + DescribeBotVersion(*lexmodelsv2.DescribeBotVersionInput) (*lexmodelsv2.DescribeBotVersionOutput, error) DescribeBotVersionWithContext(aws.Context, *lexmodelsv2.DescribeBotVersionInput, ...request.Option) (*lexmodelsv2.DescribeBotVersionOutput, error) DescribeBotVersionRequest(*lexmodelsv2.DescribeBotVersionInput) (*request.Request, *lexmodelsv2.DescribeBotVersionOutput) @@ -217,6 +221,13 @@ type LexModelsV2API interface { ListBotLocalesPages(*lexmodelsv2.ListBotLocalesInput, func(*lexmodelsv2.ListBotLocalesOutput, bool) bool) error ListBotLocalesPagesWithContext(aws.Context, *lexmodelsv2.ListBotLocalesInput, func(*lexmodelsv2.ListBotLocalesOutput, bool) bool, ...request.Option) error + ListBotRecommendations(*lexmodelsv2.ListBotRecommendationsInput) (*lexmodelsv2.ListBotRecommendationsOutput, error) + ListBotRecommendationsWithContext(aws.Context, *lexmodelsv2.ListBotRecommendationsInput, ...request.Option) (*lexmodelsv2.ListBotRecommendationsOutput, error) + ListBotRecommendationsRequest(*lexmodelsv2.ListBotRecommendationsInput) (*request.Request, *lexmodelsv2.ListBotRecommendationsOutput) + + ListBotRecommendationsPages(*lexmodelsv2.ListBotRecommendationsInput, func(*lexmodelsv2.ListBotRecommendationsOutput, bool) bool) error + ListBotRecommendationsPagesWithContext(aws.Context, *lexmodelsv2.ListBotRecommendationsInput, func(*lexmodelsv2.ListBotRecommendationsOutput, bool) bool, ...request.Option) error + ListBotVersions(*lexmodelsv2.ListBotVersionsInput) (*lexmodelsv2.ListBotVersionsOutput, error) ListBotVersionsWithContext(aws.Context, *lexmodelsv2.ListBotVersionsInput, ...request.Option) (*lexmodelsv2.ListBotVersionsOutput, error) ListBotVersionsRequest(*lexmodelsv2.ListBotVersionsInput) (*request.Request, *lexmodelsv2.ListBotVersionsOutput) @@ -266,6 +277,13 @@ type LexModelsV2API interface { ListIntentsPages(*lexmodelsv2.ListIntentsInput, func(*lexmodelsv2.ListIntentsOutput, bool) bool) error ListIntentsPagesWithContext(aws.Context, *lexmodelsv2.ListIntentsInput, func(*lexmodelsv2.ListIntentsOutput, bool) bool, ...request.Option) error + ListRecommendedIntents(*lexmodelsv2.ListRecommendedIntentsInput) (*lexmodelsv2.ListRecommendedIntentsOutput, error) + ListRecommendedIntentsWithContext(aws.Context, *lexmodelsv2.ListRecommendedIntentsInput, ...request.Option) (*lexmodelsv2.ListRecommendedIntentsOutput, error) + ListRecommendedIntentsRequest(*lexmodelsv2.ListRecommendedIntentsInput) (*request.Request, *lexmodelsv2.ListRecommendedIntentsOutput) + + ListRecommendedIntentsPages(*lexmodelsv2.ListRecommendedIntentsInput, func(*lexmodelsv2.ListRecommendedIntentsOutput, bool) bool) error + ListRecommendedIntentsPagesWithContext(aws.Context, *lexmodelsv2.ListRecommendedIntentsInput, func(*lexmodelsv2.ListRecommendedIntentsOutput, bool) bool, ...request.Option) error + ListSlotTypes(*lexmodelsv2.ListSlotTypesInput) (*lexmodelsv2.ListSlotTypesOutput, error) ListSlotTypesWithContext(aws.Context, *lexmodelsv2.ListSlotTypesInput, ...request.Option) (*lexmodelsv2.ListSlotTypesOutput, error) ListSlotTypesRequest(*lexmodelsv2.ListSlotTypesInput) (*request.Request, *lexmodelsv2.ListSlotTypesOutput) @@ -284,6 +302,14 @@ type LexModelsV2API interface { ListTagsForResourceWithContext(aws.Context, *lexmodelsv2.ListTagsForResourceInput, ...request.Option) (*lexmodelsv2.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*lexmodelsv2.ListTagsForResourceInput) (*request.Request, *lexmodelsv2.ListTagsForResourceOutput) + SearchAssociatedTranscripts(*lexmodelsv2.SearchAssociatedTranscriptsInput) (*lexmodelsv2.SearchAssociatedTranscriptsOutput, error) + SearchAssociatedTranscriptsWithContext(aws.Context, *lexmodelsv2.SearchAssociatedTranscriptsInput, ...request.Option) (*lexmodelsv2.SearchAssociatedTranscriptsOutput, error) + SearchAssociatedTranscriptsRequest(*lexmodelsv2.SearchAssociatedTranscriptsInput) (*request.Request, *lexmodelsv2.SearchAssociatedTranscriptsOutput) + + StartBotRecommendation(*lexmodelsv2.StartBotRecommendationInput) (*lexmodelsv2.StartBotRecommendationOutput, error) + StartBotRecommendationWithContext(aws.Context, *lexmodelsv2.StartBotRecommendationInput, ...request.Option) (*lexmodelsv2.StartBotRecommendationOutput, error) + StartBotRecommendationRequest(*lexmodelsv2.StartBotRecommendationInput) (*request.Request, *lexmodelsv2.StartBotRecommendationOutput) + StartImport(*lexmodelsv2.StartImportInput) (*lexmodelsv2.StartImportOutput, error) StartImportWithContext(aws.Context, *lexmodelsv2.StartImportInput, ...request.Option) (*lexmodelsv2.StartImportOutput, error) StartImportRequest(*lexmodelsv2.StartImportInput) (*request.Request, *lexmodelsv2.StartImportOutput) @@ -308,6 +334,10 @@ type LexModelsV2API interface { UpdateBotLocaleWithContext(aws.Context, *lexmodelsv2.UpdateBotLocaleInput, ...request.Option) (*lexmodelsv2.UpdateBotLocaleOutput, error) UpdateBotLocaleRequest(*lexmodelsv2.UpdateBotLocaleInput) (*request.Request, *lexmodelsv2.UpdateBotLocaleOutput) + UpdateBotRecommendation(*lexmodelsv2.UpdateBotRecommendationInput) (*lexmodelsv2.UpdateBotRecommendationOutput, error) + UpdateBotRecommendationWithContext(aws.Context, *lexmodelsv2.UpdateBotRecommendationInput, ...request.Option) (*lexmodelsv2.UpdateBotRecommendationOutput, error) + UpdateBotRecommendationRequest(*lexmodelsv2.UpdateBotRecommendationInput) (*request.Request, *lexmodelsv2.UpdateBotRecommendationOutput) + UpdateExport(*lexmodelsv2.UpdateExportInput) (*lexmodelsv2.UpdateExportOutput, error) UpdateExportWithContext(aws.Context, *lexmodelsv2.UpdateExportInput, ...request.Option) (*lexmodelsv2.UpdateExportOutput, error) UpdateExportRequest(*lexmodelsv2.UpdateExportInput) (*request.Request, *lexmodelsv2.UpdateExportOutput) diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 02a37b39437..6e4a8554a86 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -2375,6 +2375,90 @@ func (c *SageMaker) CreateImageVersionWithContext(ctx aws.Context, input *Create return out, req.Send() } +const opCreateInferenceRecommendationsJob = "CreateInferenceRecommendationsJob" + +// CreateInferenceRecommendationsJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateInferenceRecommendationsJob 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 CreateInferenceRecommendationsJob for more information on using the CreateInferenceRecommendationsJob +// 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 CreateInferenceRecommendationsJobRequest method. +// req, resp := client.CreateInferenceRecommendationsJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateInferenceRecommendationsJob +func (c *SageMaker) CreateInferenceRecommendationsJobRequest(input *CreateInferenceRecommendationsJobInput) (req *request.Request, output *CreateInferenceRecommendationsJobOutput) { + op := &request.Operation{ + Name: opCreateInferenceRecommendationsJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateInferenceRecommendationsJobInput{} + } + + output = &CreateInferenceRecommendationsJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateInferenceRecommendationsJob API operation for Amazon SageMaker Service. +// +// Starts a recommendation job. You can create either an instance recommendation +// or load test 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 SageMaker Service's +// API operation CreateInferenceRecommendationsJob for usage and error information. +// +// Returned Error Types: +// * ResourceInUse +// Resource being accessed is in use. +// +// * ResourceLimitExceeded +// You have exceeded an Amazon SageMaker resource limit. For example, you might +// have too many training jobs created. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateInferenceRecommendationsJob +func (c *SageMaker) CreateInferenceRecommendationsJob(input *CreateInferenceRecommendationsJobInput) (*CreateInferenceRecommendationsJobOutput, error) { + req, out := c.CreateInferenceRecommendationsJobRequest(input) + return out, req.Send() +} + +// CreateInferenceRecommendationsJobWithContext is the same as CreateInferenceRecommendationsJob with the addition of +// the ability to pass a context and additional request options. +// +// See CreateInferenceRecommendationsJob 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 *SageMaker) CreateInferenceRecommendationsJobWithContext(ctx aws.Context, input *CreateInferenceRecommendationsJobInput, opts ...request.Option) (*CreateInferenceRecommendationsJobOutput, error) { + req, out := c.CreateInferenceRecommendationsJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateLabelingJob = "CreateLabelingJob" // CreateLabelingJobRequest generates a "aws/request.Request" representing the @@ -9517,6 +9601,86 @@ func (c *SageMaker) DescribeImageVersionWithContext(ctx aws.Context, input *Desc return out, req.Send() } +const opDescribeInferenceRecommendationsJob = "DescribeInferenceRecommendationsJob" + +// DescribeInferenceRecommendationsJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeInferenceRecommendationsJob 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 DescribeInferenceRecommendationsJob for more information on using the DescribeInferenceRecommendationsJob +// 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 DescribeInferenceRecommendationsJobRequest method. +// req, resp := client.DescribeInferenceRecommendationsJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob +func (c *SageMaker) DescribeInferenceRecommendationsJobRequest(input *DescribeInferenceRecommendationsJobInput) (req *request.Request, output *DescribeInferenceRecommendationsJobOutput) { + op := &request.Operation{ + Name: opDescribeInferenceRecommendationsJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeInferenceRecommendationsJobInput{} + } + + output = &DescribeInferenceRecommendationsJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeInferenceRecommendationsJob API operation for Amazon SageMaker Service. +// +// Provides the results of the Inference Recommender job. One or more recommendation +// jobs are returned. +// +// 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 SageMaker Service's +// API operation DescribeInferenceRecommendationsJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob +func (c *SageMaker) DescribeInferenceRecommendationsJob(input *DescribeInferenceRecommendationsJobInput) (*DescribeInferenceRecommendationsJobOutput, error) { + req, out := c.DescribeInferenceRecommendationsJobRequest(input) + return out, req.Send() +} + +// DescribeInferenceRecommendationsJobWithContext is the same as DescribeInferenceRecommendationsJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeInferenceRecommendationsJob 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 *SageMaker) DescribeInferenceRecommendationsJobWithContext(ctx aws.Context, input *DescribeInferenceRecommendationsJobInput, opts ...request.Option) (*DescribeInferenceRecommendationsJobOutput, error) { + req, out := c.DescribeInferenceRecommendationsJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeLabelingJob = "DescribeLabelingJob" // DescribeLabelingJobRequest generates a "aws/request.Request" representing the @@ -9596,6 +9760,87 @@ func (c *SageMaker) DescribeLabelingJobWithContext(ctx aws.Context, input *Descr return out, req.Send() } +const opDescribeLineageGroup = "DescribeLineageGroup" + +// DescribeLineageGroupRequest generates a "aws/request.Request" representing the +// client's request for the DescribeLineageGroup 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 DescribeLineageGroup for more information on using the DescribeLineageGroup +// 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 DescribeLineageGroupRequest method. +// req, resp := client.DescribeLineageGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeLineageGroup +func (c *SageMaker) DescribeLineageGroupRequest(input *DescribeLineageGroupInput) (req *request.Request, output *DescribeLineageGroupOutput) { + op := &request.Operation{ + Name: opDescribeLineageGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeLineageGroupInput{} + } + + output = &DescribeLineageGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeLineageGroup API operation for Amazon SageMaker Service. +// +// Provides a list of properties for the requested lineage group. For more information, +// see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) +// in the Amazon SageMaker Developer Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon SageMaker Service's +// API operation DescribeLineageGroup for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeLineageGroup +func (c *SageMaker) DescribeLineageGroup(input *DescribeLineageGroupInput) (*DescribeLineageGroupOutput, error) { + req, out := c.DescribeLineageGroupRequest(input) + return out, req.Send() +} + +// DescribeLineageGroupWithContext is the same as DescribeLineageGroup with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeLineageGroup 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 *SageMaker) DescribeLineageGroupWithContext(ctx aws.Context, input *DescribeLineageGroupInput, opts ...request.Option) (*DescribeLineageGroupOutput, error) { + req, out := c.DescribeLineageGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeModel = "DescribeModel" // DescribeModelRequest generates a "aws/request.Request" representing the @@ -11701,6 +11946,85 @@ func (c *SageMaker) GetDeviceFleetReportWithContext(ctx aws.Context, input *GetD return out, req.Send() } +const opGetLineageGroupPolicy = "GetLineageGroupPolicy" + +// GetLineageGroupPolicyRequest generates a "aws/request.Request" representing the +// client's request for the GetLineageGroupPolicy 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 GetLineageGroupPolicy for more information on using the GetLineageGroupPolicy +// 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 GetLineageGroupPolicyRequest method. +// req, resp := client.GetLineageGroupPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/GetLineageGroupPolicy +func (c *SageMaker) GetLineageGroupPolicyRequest(input *GetLineageGroupPolicyInput) (req *request.Request, output *GetLineageGroupPolicyOutput) { + op := &request.Operation{ + Name: opGetLineageGroupPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetLineageGroupPolicyInput{} + } + + output = &GetLineageGroupPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetLineageGroupPolicy API operation for Amazon SageMaker Service. +// +// The resource policy for the lineage group. +// +// 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 SageMaker Service's +// API operation GetLineageGroupPolicy for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/GetLineageGroupPolicy +func (c *SageMaker) GetLineageGroupPolicy(input *GetLineageGroupPolicyInput) (*GetLineageGroupPolicyOutput, error) { + req, out := c.GetLineageGroupPolicyRequest(input) + return out, req.Send() +} + +// GetLineageGroupPolicyWithContext is the same as GetLineageGroupPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See GetLineageGroupPolicy 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 *SageMaker) GetLineageGroupPolicyWithContext(ctx aws.Context, input *GetLineageGroupPolicyInput, opts ...request.Option) (*GetLineageGroupPolicyOutput, error) { + req, out := c.GetLineageGroupPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetModelPackageGroupPolicy = "GetModelPackageGroupPolicy" // GetModelPackageGroupPolicyRequest generates a "aws/request.Request" representing the @@ -15271,6 +15595,138 @@ func (c *SageMaker) ListImagesPagesWithContext(ctx aws.Context, input *ListImage return p.Err() } +const opListInferenceRecommendationsJobs = "ListInferenceRecommendationsJobs" + +// ListInferenceRecommendationsJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListInferenceRecommendationsJobs 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 ListInferenceRecommendationsJobs for more information on using the ListInferenceRecommendationsJobs +// 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 ListInferenceRecommendationsJobsRequest method. +// req, resp := client.ListInferenceRecommendationsJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRecommendationsJobs +func (c *SageMaker) ListInferenceRecommendationsJobsRequest(input *ListInferenceRecommendationsJobsInput) (req *request.Request, output *ListInferenceRecommendationsJobsOutput) { + op := &request.Operation{ + Name: opListInferenceRecommendationsJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListInferenceRecommendationsJobsInput{} + } + + output = &ListInferenceRecommendationsJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListInferenceRecommendationsJobs API operation for Amazon SageMaker Service. +// +// Lists recommendation jobs that satisfy various filters. +// +// 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 SageMaker Service's +// API operation ListInferenceRecommendationsJobs for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRecommendationsJobs +func (c *SageMaker) ListInferenceRecommendationsJobs(input *ListInferenceRecommendationsJobsInput) (*ListInferenceRecommendationsJobsOutput, error) { + req, out := c.ListInferenceRecommendationsJobsRequest(input) + return out, req.Send() +} + +// ListInferenceRecommendationsJobsWithContext is the same as ListInferenceRecommendationsJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListInferenceRecommendationsJobs 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 *SageMaker) ListInferenceRecommendationsJobsWithContext(ctx aws.Context, input *ListInferenceRecommendationsJobsInput, opts ...request.Option) (*ListInferenceRecommendationsJobsOutput, error) { + req, out := c.ListInferenceRecommendationsJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListInferenceRecommendationsJobsPages iterates over the pages of a ListInferenceRecommendationsJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListInferenceRecommendationsJobs 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 ListInferenceRecommendationsJobs operation. +// pageNum := 0 +// err := client.ListInferenceRecommendationsJobsPages(params, +// func(page *sagemaker.ListInferenceRecommendationsJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SageMaker) ListInferenceRecommendationsJobsPages(input *ListInferenceRecommendationsJobsInput, fn func(*ListInferenceRecommendationsJobsOutput, bool) bool) error { + return c.ListInferenceRecommendationsJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListInferenceRecommendationsJobsPagesWithContext same as ListInferenceRecommendationsJobsPages 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 *SageMaker) ListInferenceRecommendationsJobsPagesWithContext(ctx aws.Context, input *ListInferenceRecommendationsJobsInput, fn func(*ListInferenceRecommendationsJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListInferenceRecommendationsJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListInferenceRecommendationsJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListInferenceRecommendationsJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListLabelingJobs = "ListLabelingJobs" // ListLabelingJobsRequest generates a "aws/request.Request" representing the @@ -15540,6 +15996,140 @@ func (c *SageMaker) ListLabelingJobsForWorkteamPagesWithContext(ctx aws.Context, return p.Err() } +const opListLineageGroups = "ListLineageGroups" + +// ListLineageGroupsRequest generates a "aws/request.Request" representing the +// client's request for the ListLineageGroups 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 ListLineageGroups for more information on using the ListLineageGroups +// 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 ListLineageGroupsRequest method. +// req, resp := client.ListLineageGroupsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListLineageGroups +func (c *SageMaker) ListLineageGroupsRequest(input *ListLineageGroupsInput) (req *request.Request, output *ListLineageGroupsOutput) { + op := &request.Operation{ + Name: opListLineageGroups, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListLineageGroupsInput{} + } + + output = &ListLineageGroupsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListLineageGroups API operation for Amazon SageMaker Service. +// +// A list of lineage groups shared with your Amazon Web Services account. For +// more information, see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) +// in the Amazon SageMaker Developer Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon SageMaker Service's +// API operation ListLineageGroups for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListLineageGroups +func (c *SageMaker) ListLineageGroups(input *ListLineageGroupsInput) (*ListLineageGroupsOutput, error) { + req, out := c.ListLineageGroupsRequest(input) + return out, req.Send() +} + +// ListLineageGroupsWithContext is the same as ListLineageGroups with the addition of +// the ability to pass a context and additional request options. +// +// See ListLineageGroups 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 *SageMaker) ListLineageGroupsWithContext(ctx aws.Context, input *ListLineageGroupsInput, opts ...request.Option) (*ListLineageGroupsOutput, error) { + req, out := c.ListLineageGroupsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListLineageGroupsPages iterates over the pages of a ListLineageGroups operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListLineageGroups 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 ListLineageGroups operation. +// pageNum := 0 +// err := client.ListLineageGroupsPages(params, +// func(page *sagemaker.ListLineageGroupsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SageMaker) ListLineageGroupsPages(input *ListLineageGroupsInput, fn func(*ListLineageGroupsOutput, bool) bool) error { + return c.ListLineageGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListLineageGroupsPagesWithContext same as ListLineageGroupsPages 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 *SageMaker) ListLineageGroupsPagesWithContext(ctx aws.Context, input *ListLineageGroupsInput, fn func(*ListLineageGroupsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListLineageGroupsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListLineageGroupsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListLineageGroupsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListModelBiasJobDefinitions = "ListModelBiasJobDefinitions" // ListModelBiasJobDefinitionsRequest generates a "aws/request.Request" representing the @@ -15804,6 +16394,139 @@ func (c *SageMaker) ListModelExplainabilityJobDefinitionsPagesWithContext(ctx aw return p.Err() } +const opListModelMetadata = "ListModelMetadata" + +// ListModelMetadataRequest generates a "aws/request.Request" representing the +// client's request for the ListModelMetadata 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 ListModelMetadata for more information on using the ListModelMetadata +// 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 ListModelMetadataRequest method. +// req, resp := client.ListModelMetadataRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListModelMetadata +func (c *SageMaker) ListModelMetadataRequest(input *ListModelMetadataInput) (req *request.Request, output *ListModelMetadataOutput) { + op := &request.Operation{ + Name: opListModelMetadata, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListModelMetadataInput{} + } + + output = &ListModelMetadataOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListModelMetadata API operation for Amazon SageMaker Service. +// +// Lists the domain, framework, task, and model name of standard machine learning +// models found in common model zoos. +// +// 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 SageMaker Service's +// API operation ListModelMetadata for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListModelMetadata +func (c *SageMaker) ListModelMetadata(input *ListModelMetadataInput) (*ListModelMetadataOutput, error) { + req, out := c.ListModelMetadataRequest(input) + return out, req.Send() +} + +// ListModelMetadataWithContext is the same as ListModelMetadata with the addition of +// the ability to pass a context and additional request options. +// +// See ListModelMetadata 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 *SageMaker) ListModelMetadataWithContext(ctx aws.Context, input *ListModelMetadataInput, opts ...request.Option) (*ListModelMetadataOutput, error) { + req, out := c.ListModelMetadataRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListModelMetadataPages iterates over the pages of a ListModelMetadata operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListModelMetadata 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 ListModelMetadata operation. +// pageNum := 0 +// err := client.ListModelMetadataPages(params, +// func(page *sagemaker.ListModelMetadataOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SageMaker) ListModelMetadataPages(input *ListModelMetadataInput, fn func(*ListModelMetadataOutput, bool) bool) error { + return c.ListModelMetadataPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListModelMetadataPagesWithContext same as ListModelMetadataPages 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 *SageMaker) ListModelMetadataPagesWithContext(ctx aws.Context, input *ListModelMetadataInput, fn func(*ListModelMetadataOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListModelMetadataInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListModelMetadataRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListModelMetadataOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListModelPackageGroups = "ListModelPackageGroups" // ListModelPackageGroupsRequest generates a "aws/request.Request" representing the @@ -19256,6 +19979,145 @@ func (c *SageMaker) PutModelPackageGroupPolicyWithContext(ctx aws.Context, input return out, req.Send() } +const opQueryLineage = "QueryLineage" + +// QueryLineageRequest generates a "aws/request.Request" representing the +// client's request for the QueryLineage 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 QueryLineage for more information on using the QueryLineage +// 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 QueryLineageRequest method. +// req, resp := client.QueryLineageRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/QueryLineage +func (c *SageMaker) QueryLineageRequest(input *QueryLineageInput) (req *request.Request, output *QueryLineageOutput) { + op := &request.Operation{ + Name: opQueryLineage, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &QueryLineageInput{} + } + + output = &QueryLineageOutput{} + req = c.newRequest(op, input, output) + return +} + +// QueryLineage API operation for Amazon SageMaker Service. +// +// Use this action to inspect your lineage and discover relationships between +// entities. For more information, see Querying Lineage Entities (https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html) +// in the Amazon SageMaker Developer Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon SageMaker Service's +// API operation QueryLineage for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/QueryLineage +func (c *SageMaker) QueryLineage(input *QueryLineageInput) (*QueryLineageOutput, error) { + req, out := c.QueryLineageRequest(input) + return out, req.Send() +} + +// QueryLineageWithContext is the same as QueryLineage with the addition of +// the ability to pass a context and additional request options. +// +// See QueryLineage 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 *SageMaker) QueryLineageWithContext(ctx aws.Context, input *QueryLineageInput, opts ...request.Option) (*QueryLineageOutput, error) { + req, out := c.QueryLineageRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// QueryLineagePages iterates over the pages of a QueryLineage operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See QueryLineage 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 QueryLineage operation. +// pageNum := 0 +// err := client.QueryLineagePages(params, +// func(page *sagemaker.QueryLineageOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SageMaker) QueryLineagePages(input *QueryLineageInput, fn func(*QueryLineageOutput, bool) bool) error { + return c.QueryLineagePagesWithContext(aws.BackgroundContext(), input, fn) +} + +// QueryLineagePagesWithContext same as QueryLineagePages 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 *SageMaker) QueryLineagePagesWithContext(ctx aws.Context, input *QueryLineageInput, fn func(*QueryLineageOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *QueryLineageInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.QueryLineageRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*QueryLineageOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opRegisterDevices = "RegisterDevices" // RegisterDevicesRequest generates a "aws/request.Request" representing the @@ -20394,6 +21256,86 @@ func (c *SageMaker) StopHyperParameterTuningJobWithContext(ctx aws.Context, inpu return out, req.Send() } +const opStopInferenceRecommendationsJob = "StopInferenceRecommendationsJob" + +// StopInferenceRecommendationsJobRequest generates a "aws/request.Request" representing the +// client's request for the StopInferenceRecommendationsJob 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 StopInferenceRecommendationsJob for more information on using the StopInferenceRecommendationsJob +// 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 StopInferenceRecommendationsJobRequest method. +// req, resp := client.StopInferenceRecommendationsJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopInferenceRecommendationsJob +func (c *SageMaker) StopInferenceRecommendationsJobRequest(input *StopInferenceRecommendationsJobInput) (req *request.Request, output *StopInferenceRecommendationsJobOutput) { + op := &request.Operation{ + Name: opStopInferenceRecommendationsJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StopInferenceRecommendationsJobInput{} + } + + output = &StopInferenceRecommendationsJobOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// StopInferenceRecommendationsJob API operation for Amazon SageMaker Service. +// +// Stops an Inference Recommender 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 SageMaker Service's +// API operation StopInferenceRecommendationsJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopInferenceRecommendationsJob +func (c *SageMaker) StopInferenceRecommendationsJob(input *StopInferenceRecommendationsJobInput) (*StopInferenceRecommendationsJobOutput, error) { + req, out := c.StopInferenceRecommendationsJobRequest(input) + return out, req.Send() +} + +// StopInferenceRecommendationsJobWithContext is the same as StopInferenceRecommendationsJob with the addition of +// the ability to pass a context and additional request options. +// +// See StopInferenceRecommendationsJob 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 *SageMaker) StopInferenceRecommendationsJobWithContext(ctx aws.Context, input *StopInferenceRecommendationsJobInput, opts ...request.Option) (*StopInferenceRecommendationsJobOutput, error) { + req, out := c.StopInferenceRecommendationsJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStopLabelingJob = "StopLabelingJob" // StopLabelingJobRequest generates a "aws/request.Request" representing the @@ -23430,6 +24372,137 @@ func (s *AddTagsOutput) SetTags(v []*Tag) *AddTagsOutput { return s } +// A structure of additional Inference Specification. Additional Inference Specification +// specifies details about inference jobs that can be run with models based +// on this model package +type AdditionalInferenceSpecificationDefinition struct { + _ struct{} `type:"structure"` + + // The Amazon ECR registry path of the Docker image that contains the inference + // code. + // + // Containers is a required field + Containers []*ModelPackageContainerDefinition `min:"1" type:"list" required:"true"` + + // A description of the additional Inference specification + Description *string `type:"string"` + + // A unique name to identify the additional inference specification. The name + // must be unique within the list of your additional inference specifications + // for a particular model package. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The supported MIME types for the input data. + SupportedContentTypes []*string `type:"list"` + + // A list of the instance types that are used to generate inferences in real-time. + SupportedRealtimeInferenceInstanceTypes []*string `type:"list"` + + // The supported MIME types for the output data. + SupportedResponseMIMETypes []*string `type:"list"` + + // A list of the instance types on which a transformation job can be run or + // on which an endpoint can be deployed. + SupportedTransformInstanceTypes []*string `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 AdditionalInferenceSpecificationDefinition) 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 AdditionalInferenceSpecificationDefinition) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AdditionalInferenceSpecificationDefinition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AdditionalInferenceSpecificationDefinition"} + if s.Containers == nil { + invalidParams.Add(request.NewErrParamRequired("Containers")) + } + if s.Containers != nil && len(s.Containers) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Containers", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SupportedTransformInstanceTypes != nil && len(s.SupportedTransformInstanceTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SupportedTransformInstanceTypes", 1)) + } + if s.Containers != nil { + for i, v := range s.Containers { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Containers", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContainers sets the Containers field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetContainers(v []*ModelPackageContainerDefinition) *AdditionalInferenceSpecificationDefinition { + s.Containers = v + return s +} + +// SetDescription sets the Description field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetDescription(v string) *AdditionalInferenceSpecificationDefinition { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetName(v string) *AdditionalInferenceSpecificationDefinition { + s.Name = &v + return s +} + +// SetSupportedContentTypes sets the SupportedContentTypes field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetSupportedContentTypes(v []*string) *AdditionalInferenceSpecificationDefinition { + s.SupportedContentTypes = v + return s +} + +// SetSupportedRealtimeInferenceInstanceTypes sets the SupportedRealtimeInferenceInstanceTypes field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetSupportedRealtimeInferenceInstanceTypes(v []*string) *AdditionalInferenceSpecificationDefinition { + s.SupportedRealtimeInferenceInstanceTypes = v + return s +} + +// SetSupportedResponseMIMETypes sets the SupportedResponseMIMETypes field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetSupportedResponseMIMETypes(v []*string) *AdditionalInferenceSpecificationDefinition { + s.SupportedResponseMIMETypes = v + return s +} + +// SetSupportedTransformInstanceTypes sets the SupportedTransformInstanceTypes field's value. +func (s *AdditionalInferenceSpecificationDefinition) SetSupportedTransformInstanceTypes(v []*string) *AdditionalInferenceSpecificationDefinition { + s.SupportedTransformInstanceTypes = v + return s +} + // Edge Manager agent version. type AgentVersion struct { _ struct{} `type:"structure"` @@ -25234,7 +26307,7 @@ type AssociationSummary struct { AssociationType *string `type:"string" enum:"AssociationEdgeType"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // When the association was created. @@ -27006,6 +28079,10 @@ func (s *BatchDescribeModelPackageSummary) SetModelPackageVersion(v int64) *Batc type Bias struct { _ struct{} `type:"structure"` + PostTrainingReport *MetricsSource `type:"structure"` + + PreTrainingReport *MetricsSource `type:"structure"` + // The bias report for a model Report *MetricsSource `type:"structure"` } @@ -27031,6 +28108,16 @@ func (s Bias) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *Bias) Validate() error { invalidParams := request.ErrInvalidParams{Context: "Bias"} + if s.PostTrainingReport != nil { + if err := s.PostTrainingReport.Validate(); err != nil { + invalidParams.AddNested("PostTrainingReport", err.(request.ErrInvalidParams)) + } + } + if s.PreTrainingReport != nil { + if err := s.PreTrainingReport.Validate(); err != nil { + invalidParams.AddNested("PreTrainingReport", err.(request.ErrInvalidParams)) + } + } if s.Report != nil { if err := s.Report.Validate(); err != nil { invalidParams.AddNested("Report", err.(request.ErrInvalidParams)) @@ -27043,6 +28130,18 @@ func (s *Bias) Validate() error { return nil } +// SetPostTrainingReport sets the PostTrainingReport field's value. +func (s *Bias) SetPostTrainingReport(v *MetricsSource) *Bias { + s.PostTrainingReport = v + return s +} + +// SetPreTrainingReport sets the PreTrainingReport field's value. +func (s *Bias) SetPreTrainingReport(v *MetricsSource) *Bias { + s.PreTrainingReport = v + return s +} + // SetReport sets the Report field's value. func (s *Bias) SetReport(v *MetricsSource) *Bias { s.Report = v @@ -27458,6 +28557,70 @@ func (s *CaptureOption) SetCaptureMode(v string) *CaptureOption { return s } +// Environment parameters you want to benchmark your load test against. +type CategoricalParameter struct { + _ struct{} `type:"structure"` + + // The Name of the environment variable. + // + // Name is a required field + Name *string `type:"string" required:"true"` + + // The list of values you can pass. + // + // Value is a required field + Value []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CategoricalParameter) 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 CategoricalParameter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CategoricalParameter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CategoricalParameter"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + if s.Value != nil && len(s.Value) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Value", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *CategoricalParameter) SetName(v string) *CategoricalParameter { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *CategoricalParameter) SetValue(v []*string) *CategoricalParameter { + s.Value = v + return s +} + // A list of categorical hyperparameters to tune. type CategoricalParameterRange struct { _ struct{} `type:"structure"` @@ -27896,6 +29059,110 @@ func (s *CheckpointConfig) SetS3Uri(v string) *CheckpointConfig { return s } +// The container for the metadata for the ClarifyCheck step. For more information, +// see the topic on ClarifyCheck step (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check) +// in the Amazon SageMaker Developer Guide. +type ClarifyCheckStepMetadata struct { + _ struct{} `type:"structure"` + + // The Amazon S3 URI of baseline constraints file to be used for the drift check. + BaselineUsedForDriftCheckConstraints *string `type:"string"` + + // The Amazon S3 URI of the newly calculated baseline constraints file. + CalculatedBaselineConstraints *string `type:"string"` + + // The Amazon Resource Name (ARN) of the check processing job that was run by + // this step's execution. + CheckJobArn *string `type:"string"` + + // The type of the Clarify Check step + CheckType *string `type:"string"` + + // The model package group name. + ModelPackageGroupName *string `type:"string"` + + // This flag indicates if a newly calculated baseline can be accessed through + // step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. + // If it is set to False, the previous baseline of the configured check type + // must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints + // property. + RegisterNewBaseline *bool `type:"boolean"` + + // This flag indicates if the drift check against the previous baseline will + // be skipped or not. If it is set to False, the previous baseline of the configured + // check type must be available. + SkipCheck *bool `type:"boolean"` + + // The Amazon S3 URI of the violation report if violations are detected. + ViolationReport *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 ClarifyCheckStepMetadata) 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 ClarifyCheckStepMetadata) GoString() string { + return s.String() +} + +// SetBaselineUsedForDriftCheckConstraints sets the BaselineUsedForDriftCheckConstraints field's value. +func (s *ClarifyCheckStepMetadata) SetBaselineUsedForDriftCheckConstraints(v string) *ClarifyCheckStepMetadata { + s.BaselineUsedForDriftCheckConstraints = &v + return s +} + +// SetCalculatedBaselineConstraints sets the CalculatedBaselineConstraints field's value. +func (s *ClarifyCheckStepMetadata) SetCalculatedBaselineConstraints(v string) *ClarifyCheckStepMetadata { + s.CalculatedBaselineConstraints = &v + return s +} + +// SetCheckJobArn sets the CheckJobArn field's value. +func (s *ClarifyCheckStepMetadata) SetCheckJobArn(v string) *ClarifyCheckStepMetadata { + s.CheckJobArn = &v + return s +} + +// SetCheckType sets the CheckType field's value. +func (s *ClarifyCheckStepMetadata) SetCheckType(v string) *ClarifyCheckStepMetadata { + s.CheckType = &v + return s +} + +// SetModelPackageGroupName sets the ModelPackageGroupName field's value. +func (s *ClarifyCheckStepMetadata) SetModelPackageGroupName(v string) *ClarifyCheckStepMetadata { + s.ModelPackageGroupName = &v + return s +} + +// SetRegisterNewBaseline sets the RegisterNewBaseline field's value. +func (s *ClarifyCheckStepMetadata) SetRegisterNewBaseline(v bool) *ClarifyCheckStepMetadata { + s.RegisterNewBaseline = &v + return s +} + +// SetSkipCheck sets the SkipCheck field's value. +func (s *ClarifyCheckStepMetadata) SetSkipCheck(v bool) *ClarifyCheckStepMetadata { + s.SkipCheck = &v + return s +} + +// SetViolationReport sets the ViolationReport field's value. +func (s *ClarifyCheckStepMetadata) SetViolationReport(v string) *ClarifyCheckStepMetadata { + s.ViolationReport = &v + return s +} + // Specifies summary information about a Git repository. type CodeRepositorySummary struct { _ struct{} `type:"structure"` @@ -28459,6 +29726,9 @@ type ContainerDefinition struct { // Docker Registry for Real-Time Inference Containers (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html) ImageConfig *ImageConfig `type:"structure"` + // The inference specification name in the model package version. + InferenceSpecificationName *string `min:"1" type:"string"` + // Whether the container hosts a single model or multiple models. Mode *string `type:"string" enum:"ContainerMode"` @@ -28513,6 +29783,9 @@ func (s ContainerDefinition) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ContainerDefinition) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ContainerDefinition"} + if s.InferenceSpecificationName != nil && len(*s.InferenceSpecificationName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InferenceSpecificationName", 1)) + } if s.ModelPackageName != nil && len(*s.ModelPackageName) < 1 { invalidParams.Add(request.NewErrParamMinLen("ModelPackageName", 1)) } @@ -28552,6 +29825,12 @@ func (s *ContainerDefinition) SetImageConfig(v *ImageConfig) *ContainerDefinitio return s } +// SetInferenceSpecificationName sets the InferenceSpecificationName field's value. +func (s *ContainerDefinition) SetInferenceSpecificationName(v string) *ContainerDefinition { + s.InferenceSpecificationName = &v + return s +} + // SetMode sets the Mode field's value. func (s *ContainerDefinition) SetMode(v string) *ContainerDefinition { s.Mode = &v @@ -30038,9 +31317,13 @@ type CreateCompilationJobInput struct { // Provides information about the location of input model artifacts, the name // and shape of the expected data inputs, and the framework in which the model // was trained. - // - // InputConfig is a required field - InputConfig *InputConfig `type:"structure" required:"true"` + InputConfig *InputConfig `type:"structure"` + + // The Amazon Resource Name (ARN) of a versioned model package. Provide either + // a ModelPackageVersionArn or an InputConfig object in the request syntax. + // The presence of both objects in the CreateCompilationJob request will return + // an exception. + ModelPackageVersionArn *string `min:"1" type:"string"` // Provides information about the output location for the compiled model and // the target device the model runs on. @@ -30115,8 +31398,8 @@ func (s *CreateCompilationJobInput) Validate() error { if s.CompilationJobName != nil && len(*s.CompilationJobName) < 1 { invalidParams.Add(request.NewErrParamMinLen("CompilationJobName", 1)) } - if s.InputConfig == nil { - invalidParams.Add(request.NewErrParamRequired("InputConfig")) + if s.ModelPackageVersionArn != nil && len(*s.ModelPackageVersionArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelPackageVersionArn", 1)) } if s.OutputConfig == nil { invalidParams.Add(request.NewErrParamRequired("OutputConfig")) @@ -30179,6 +31462,12 @@ func (s *CreateCompilationJobInput) SetInputConfig(v *InputConfig) *CreateCompil return s } +// SetModelPackageVersionArn sets the ModelPackageVersionArn field's value. +func (s *CreateCompilationJobInput) SetModelPackageVersionArn(v string) *CreateCompilationJobInput { + s.ModelPackageVersionArn = &v + return s +} + // SetOutputConfig sets the OutputConfig field's value. func (s *CreateCompilationJobInput) SetOutputConfig(v *OutputConfig) *CreateCompilationJobInput { s.OutputConfig = v @@ -32705,6 +33994,191 @@ func (s *CreateImageVersionOutput) SetImageVersionArn(v string) *CreateImageVers return s } +type CreateInferenceRecommendationsJobInput struct { + _ struct{} `type:"structure"` + + // Provides information about the versioned model package Amazon Resource Name + // (ARN), the traffic pattern, and endpoint configurations. + // + // InputConfig is a required field + InputConfig *RecommendationJobInputConfig `type:"structure" required:"true"` + + // Description of the recommendation job. + JobDescription *string `type:"string"` + + // A name for the recommendation job. The name must be unique within the Amazon + // Web Services Region and within your Amazon Web Services account. + // + // JobName is a required field + JobName *string `min:"1" type:"string" required:"true"` + + // Defines the type of recommendation job. Specify Default to initiate an instance + // recommendation and Advanced to initiate a load test. If left unspecified, + // Amazon SageMaker Inference Recommender will run an instance recommendation + // (DEFAULT) job. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"RecommendationJobType"` + + // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker + // to perform tasks on your behalf. + // + // RoleArn is a required field + RoleArn *string `min:"20" type:"string" required:"true"` + + // A set of conditions for stopping a recommendation job. If any of the conditions + // are met, the job is automatically stopped. + StoppingConditions *RecommendationJobStoppingConditions `type:"structure"` + + // The metadata that you apply to Amazon Web Services resources to help you + // categorize and organize them. Each tag consists of a key and a value, both + // of which you define. For more information, see Tagging Amazon Web Services + // Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. + 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 CreateInferenceRecommendationsJobInput) 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 CreateInferenceRecommendationsJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateInferenceRecommendationsJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateInferenceRecommendationsJobInput"} + if s.InputConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputConfig")) + } + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.JobType == nil { + invalidParams.Add(request.NewErrParamRequired("JobType")) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.RoleArn != nil && len(*s.RoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) + } + if s.InputConfig != nil { + if err := s.InputConfig.Validate(); err != nil { + invalidParams.AddNested("InputConfig", err.(request.ErrInvalidParams)) + } + } + if s.StoppingConditions != nil { + if err := s.StoppingConditions.Validate(); err != nil { + invalidParams.AddNested("StoppingConditions", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInputConfig sets the InputConfig field's value. +func (s *CreateInferenceRecommendationsJobInput) SetInputConfig(v *RecommendationJobInputConfig) *CreateInferenceRecommendationsJobInput { + s.InputConfig = v + return s +} + +// SetJobDescription sets the JobDescription field's value. +func (s *CreateInferenceRecommendationsJobInput) SetJobDescription(v string) *CreateInferenceRecommendationsJobInput { + s.JobDescription = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *CreateInferenceRecommendationsJobInput) SetJobName(v string) *CreateInferenceRecommendationsJobInput { + s.JobName = &v + return s +} + +// SetJobType sets the JobType field's value. +func (s *CreateInferenceRecommendationsJobInput) SetJobType(v string) *CreateInferenceRecommendationsJobInput { + s.JobType = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreateInferenceRecommendationsJobInput) SetRoleArn(v string) *CreateInferenceRecommendationsJobInput { + s.RoleArn = &v + return s +} + +// SetStoppingConditions sets the StoppingConditions field's value. +func (s *CreateInferenceRecommendationsJobInput) SetStoppingConditions(v *RecommendationJobStoppingConditions) *CreateInferenceRecommendationsJobInput { + s.StoppingConditions = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateInferenceRecommendationsJobInput) SetTags(v []*Tag) *CreateInferenceRecommendationsJobInput { + s.Tags = v + return s +} + +type CreateInferenceRecommendationsJobOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the recommendation job. + // + // JobArn is a required field + JobArn *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 CreateInferenceRecommendationsJobOutput) 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 CreateInferenceRecommendationsJobOutput) GoString() string { + return s.String() +} + +// SetJobArn sets the JobArn field's value. +func (s *CreateInferenceRecommendationsJobOutput) SetJobArn(v string) *CreateInferenceRecommendationsJobOutput { + s.JobArn = &v + return s +} + type CreateLabelingJobInput struct { _ struct{} `type:"structure"` @@ -33829,6 +35303,12 @@ func (s *CreateModelPackageGroupOutput) SetModelPackageGroupArn(v string) *Creat type CreateModelPackageInput struct { _ struct{} `type:"structure"` + // An array of additional Inference Specification objects. Each additional Inference + // Specification specifies artifacts based on this model package that can be + // used on inference endpoints. Generally used with SageMaker Neo to store the + // compiled artifacts. + AdditionalInferenceSpecifications []*AdditionalInferenceSpecificationDefinition `min:"1" type:"list"` + // Whether to certify the model package for listing on Amazon Web Services Marketplace. // // This parameter is optional for unversioned models, and does not apply to @@ -33841,6 +35321,16 @@ type CreateModelPackageInput struct { // The metadata properties associated with the model package versions. CustomerMetadataProperties map[string]*string `min:"1" type:"map"` + // The machine learning domain of your model package and its components. Common + // machine learning domains include computer vision and natural language processing. + Domain *string `type:"string"` + + // Represents the drift check baselines that can be used when the model monitor + // is set using the model package. For more information, see the topic on Drift + // Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) + // in the Amazon SageMaker Developer Guide. + DriftCheckBaselines *DriftCheckBaselines `type:"structure"` + // Specifies details about inference jobs that can be run with models based // on this model package, including the following: // @@ -33886,6 +35376,11 @@ type CreateModelPackageInput struct { // versioned models. ModelPackageName *string `min:"1" type:"string"` + // The Amazon Simple Storage Service (Amazon S3) path where the sample payload + // are stored. This path must point to a single gzip compressed tar archive + // (.tar.gz suffix). + SamplePayloadUrl *string `type:"string"` + // Details about the algorithm that was used to create the model package. SourceAlgorithmSpecification *SourceAlgorithmSpecification `type:"structure"` @@ -33894,6 +35389,10 @@ type CreateModelPackageInput struct { // in the Amazon Web Services General Reference Guide. Tags []*Tag `type:"list"` + // The machine learning task your model package accomplishes. Common machine + // learning tasks include object detection and image classification. + Task *string `type:"string"` + // Specifies configurations for one or more transform jobs that Amazon SageMaker // runs to test the model package. ValidationSpecification *ModelPackageValidationSpecification `type:"structure"` @@ -33920,6 +35419,9 @@ func (s CreateModelPackageInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateModelPackageInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateModelPackageInput"} + if s.AdditionalInferenceSpecifications != nil && len(s.AdditionalInferenceSpecifications) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AdditionalInferenceSpecifications", 1)) + } if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } @@ -33932,6 +35434,21 @@ func (s *CreateModelPackageInput) Validate() error { if s.ModelPackageName != nil && len(*s.ModelPackageName) < 1 { invalidParams.Add(request.NewErrParamMinLen("ModelPackageName", 1)) } + if s.AdditionalInferenceSpecifications != nil { + for i, v := range s.AdditionalInferenceSpecifications { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AdditionalInferenceSpecifications", i), err.(request.ErrInvalidParams)) + } + } + } + if s.DriftCheckBaselines != nil { + if err := s.DriftCheckBaselines.Validate(); err != nil { + invalidParams.AddNested("DriftCheckBaselines", err.(request.ErrInvalidParams)) + } + } if s.InferenceSpecification != nil { if err := s.InferenceSpecification.Validate(); err != nil { invalidParams.AddNested("InferenceSpecification", err.(request.ErrInvalidParams)) @@ -33969,6 +35486,12 @@ func (s *CreateModelPackageInput) Validate() error { return nil } +// SetAdditionalInferenceSpecifications sets the AdditionalInferenceSpecifications field's value. +func (s *CreateModelPackageInput) SetAdditionalInferenceSpecifications(v []*AdditionalInferenceSpecificationDefinition) *CreateModelPackageInput { + s.AdditionalInferenceSpecifications = v + return s +} + // SetCertifyForMarketplace sets the CertifyForMarketplace field's value. func (s *CreateModelPackageInput) SetCertifyForMarketplace(v bool) *CreateModelPackageInput { s.CertifyForMarketplace = &v @@ -33987,6 +35510,18 @@ func (s *CreateModelPackageInput) SetCustomerMetadataProperties(v map[string]*st return s } +// SetDomain sets the Domain field's value. +func (s *CreateModelPackageInput) SetDomain(v string) *CreateModelPackageInput { + s.Domain = &v + return s +} + +// SetDriftCheckBaselines sets the DriftCheckBaselines field's value. +func (s *CreateModelPackageInput) SetDriftCheckBaselines(v *DriftCheckBaselines) *CreateModelPackageInput { + s.DriftCheckBaselines = v + return s +} + // SetInferenceSpecification sets the InferenceSpecification field's value. func (s *CreateModelPackageInput) SetInferenceSpecification(v *InferenceSpecification) *CreateModelPackageInput { s.InferenceSpecification = v @@ -34029,6 +35564,12 @@ func (s *CreateModelPackageInput) SetModelPackageName(v string) *CreateModelPack return s } +// SetSamplePayloadUrl sets the SamplePayloadUrl field's value. +func (s *CreateModelPackageInput) SetSamplePayloadUrl(v string) *CreateModelPackageInput { + s.SamplePayloadUrl = &v + return s +} + // SetSourceAlgorithmSpecification sets the SourceAlgorithmSpecification field's value. func (s *CreateModelPackageInput) SetSourceAlgorithmSpecification(v *SourceAlgorithmSpecification) *CreateModelPackageInput { s.SourceAlgorithmSpecification = v @@ -34041,6 +35582,12 @@ func (s *CreateModelPackageInput) SetTags(v []*Tag) *CreateModelPackageInput { return s } +// SetTask sets the Task field's value. +func (s *CreateModelPackageInput) SetTask(v string) *CreateModelPackageInput { + s.Task = &v + return s +} + // SetValidationSpecification sets the ValidationSpecification field's value. func (s *CreateModelPackageInput) SetValidationSpecification(v *ModelPackageValidationSpecification) *CreateModelPackageInput { s.ValidationSpecification = v @@ -41611,7 +43158,7 @@ type DescribeActionOutput struct { ActionType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // When the action was created. @@ -41621,12 +43168,15 @@ type DescribeActionOutput struct { Description *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // When the action was last modified. LastModifiedTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *MetadataProperties `type:"structure"` @@ -41706,6 +43256,12 @@ func (s *DescribeActionOutput) SetLastModifiedTime(v time.Time) *DescribeActionO return s } +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *DescribeActionOutput) SetLineageGroupArn(v string) *DescribeActionOutput { + s.LineageGroupArn = &v + return s +} + // SetMetadataProperties sets the MetadataProperties field's value. func (s *DescribeActionOutput) SetMetadataProperties(v *MetadataProperties) *DescribeActionOutput { s.MetadataProperties = v @@ -42297,19 +43853,22 @@ type DescribeArtifactOutput struct { ArtifactType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // When the artifact was created. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // When the artifact was last modified. LastModifiedTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *MetadataProperties `type:"structure"` @@ -42380,6 +43939,12 @@ func (s *DescribeArtifactOutput) SetLastModifiedTime(v time.Time) *DescribeArtif return s } +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *DescribeArtifactOutput) SetLineageGroupArn(v string) *DescribeArtifactOutput { + s.LineageGroupArn = &v + return s +} + // SetMetadataProperties sets the MetadataProperties field's value. func (s *DescribeArtifactOutput) SetMetadataProperties(v *MetadataProperties) *DescribeArtifactOutput { s.MetadataProperties = v @@ -42927,6 +44492,10 @@ type DescribeCompilationJobOutput struct { // in Amazon S3. ModelDigests *ModelDigests `type:"structure"` + // The Amazon Resource Name (ARN) of the versioned model package that was provided + // to SageMaker Neo when you initiated a compilation job. + ModelPackageVersionArn *string `min:"1" type:"string"` + // Information about the output location for the compiled model and the target // device that the model runs on. // @@ -43043,6 +44612,12 @@ func (s *DescribeCompilationJobOutput) SetModelDigests(v *ModelDigests) *Describ return s } +// SetModelPackageVersionArn sets the ModelPackageVersionArn field's value. +func (s *DescribeCompilationJobOutput) SetModelPackageVersionArn(v string) *DescribeCompilationJobOutput { + s.ModelPackageVersionArn = &v + return s +} + // SetOutputConfig sets the OutputConfig field's value. func (s *DescribeCompilationJobOutput) SetOutputConfig(v *OutputConfig) *DescribeCompilationJobOutput { s.OutputConfig = v @@ -43129,7 +44704,7 @@ type DescribeContextOutput struct { ContextType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // When the context was created. @@ -43139,12 +44714,15 @@ type DescribeContextOutput struct { Description *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // When the context was last modified. LastModifiedTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + // A list of the context's properties. Properties map[string]*string `type:"map"` @@ -43218,6 +44796,12 @@ func (s *DescribeContextOutput) SetLastModifiedTime(v time.Time) *DescribeContex return s } +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *DescribeContextOutput) SetLineageGroupArn(v string) *DescribeContextOutput { + s.LineageGroupArn = &v + return s +} + // SetProperties sets the Properties field's value. func (s *DescribeContextOutput) SetProperties(v map[string]*string) *DescribeContextOutput { s.Properties = v @@ -45855,6 +47439,215 @@ func (s *DescribeImageVersionOutput) SetVersion(v int64) *DescribeImageVersionOu return s } +type DescribeInferenceRecommendationsJobInput struct { + _ struct{} `type:"structure"` + + // The name of the job. The name must be unique within an Amazon Web Services + // Region in the Amazon Web Services account. + // + // JobName is a required field + JobName *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 DescribeInferenceRecommendationsJobInput) 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 DescribeInferenceRecommendationsJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeInferenceRecommendationsJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeInferenceRecommendationsJobInput"} + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobName sets the JobName field's value. +func (s *DescribeInferenceRecommendationsJobInput) SetJobName(v string) *DescribeInferenceRecommendationsJobInput { + s.JobName = &v + return s +} + +type DescribeInferenceRecommendationsJobOutput struct { + _ struct{} `type:"structure"` + + // A timestamp that shows when the job completed. + CompletionTime *time.Time `type:"timestamp"` + + // A timestamp that shows when the job was created. + // + // CreationTime is a required field + CreationTime *time.Time `type:"timestamp" required:"true"` + + // If the job fails, provides information why the job failed. + FailureReason *string `type:"string"` + + // The recommendations made by Inference Recommender. + InferenceRecommendations []*InferenceRecommendation `min:"1" type:"list"` + + // Returns information about the versioned model package Amazon Resource Name + // (ARN), the traffic pattern, and endpoint configurations you provided when + // you initiated the job. + // + // InputConfig is a required field + InputConfig *RecommendationJobInputConfig `type:"structure" required:"true"` + + // The Amazon Resource Name (ARN) of the job. + // + // JobArn is a required field + JobArn *string `type:"string" required:"true"` + + // The job description that you provided when you initiated the job. + JobDescription *string `type:"string"` + + // The name of the job. The name must be unique within an Amazon Web Services + // Region in the Amazon Web Services account. + // + // JobName is a required field + JobName *string `min:"1" type:"string" required:"true"` + + // The job type that you provided when you initiated the job. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"RecommendationJobType"` + + // A timestamp that shows when the job was last modified. + // + // LastModifiedTime is a required field + LastModifiedTime *time.Time `type:"timestamp" required:"true"` + + // The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access + // Management (IAM) role you provided when you initiated the job. + // + // RoleArn is a required field + RoleArn *string `min:"20" type:"string" required:"true"` + + // The status of the job. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"RecommendationJobStatus"` + + // The stopping conditions that you provided when you initiated the job. + StoppingConditions *RecommendationJobStoppingConditions `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 DescribeInferenceRecommendationsJobOutput) 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 DescribeInferenceRecommendationsJobOutput) GoString() string { + return s.String() +} + +// SetCompletionTime sets the CompletionTime field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetCompletionTime(v time.Time) *DescribeInferenceRecommendationsJobOutput { + s.CompletionTime = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetCreationTime(v time.Time) *DescribeInferenceRecommendationsJobOutput { + s.CreationTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetFailureReason(v string) *DescribeInferenceRecommendationsJobOutput { + s.FailureReason = &v + return s +} + +// SetInferenceRecommendations sets the InferenceRecommendations field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetInferenceRecommendations(v []*InferenceRecommendation) *DescribeInferenceRecommendationsJobOutput { + s.InferenceRecommendations = v + return s +} + +// SetInputConfig sets the InputConfig field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetInputConfig(v *RecommendationJobInputConfig) *DescribeInferenceRecommendationsJobOutput { + s.InputConfig = v + return s +} + +// SetJobArn sets the JobArn field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetJobArn(v string) *DescribeInferenceRecommendationsJobOutput { + s.JobArn = &v + return s +} + +// SetJobDescription sets the JobDescription field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetJobDescription(v string) *DescribeInferenceRecommendationsJobOutput { + s.JobDescription = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetJobName(v string) *DescribeInferenceRecommendationsJobOutput { + s.JobName = &v + return s +} + +// SetJobType sets the JobType field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetJobType(v string) *DescribeInferenceRecommendationsJobOutput { + s.JobType = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetLastModifiedTime(v time.Time) *DescribeInferenceRecommendationsJobOutput { + s.LastModifiedTime = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetRoleArn(v string) *DescribeInferenceRecommendationsJobOutput { + s.RoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetStatus(v string) *DescribeInferenceRecommendationsJobOutput { + s.Status = &v + return s +} + +// SetStoppingConditions sets the StoppingConditions field's value. +func (s *DescribeInferenceRecommendationsJobOutput) SetStoppingConditions(v *RecommendationJobStoppingConditions) *DescribeInferenceRecommendationsJobOutput { + s.StoppingConditions = v + return s +} + type DescribeLabelingJobInput struct { _ struct{} `type:"structure"` @@ -46158,6 +47951,151 @@ func (s *DescribeLabelingJobOutput) SetTags(v []*Tag) *DescribeLabelingJobOutput return s } +type DescribeLineageGroupInput struct { + _ struct{} `type:"structure"` + + // The name of the lineage group. + // + // LineageGroupName is a required field + LineageGroupName *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 DescribeLineageGroupInput) 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 DescribeLineageGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeLineageGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeLineageGroupInput"} + if s.LineageGroupName == nil { + invalidParams.Add(request.NewErrParamRequired("LineageGroupName")) + } + if s.LineageGroupName != nil && len(*s.LineageGroupName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LineageGroupName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLineageGroupName sets the LineageGroupName field's value. +func (s *DescribeLineageGroupInput) SetLineageGroupName(v string) *DescribeLineageGroupInput { + s.LineageGroupName = &v + return s +} + +type DescribeLineageGroupOutput struct { + _ struct{} `type:"structure"` + + // Information about the user who created or modified an experiment, trial, + // trial component, lineage group, or project. + CreatedBy *UserContext `type:"structure"` + + // The creation time of lineage group. + CreationTime *time.Time `type:"timestamp"` + + // The description of the lineage group. + Description *string `type:"string"` + + // The display name of the lineage group. + DisplayName *string `min:"1" type:"string"` + + // Information about the user who created or modified an experiment, trial, + // trial component, lineage group, or project. + LastModifiedBy *UserContext `type:"structure"` + + // The last modified time of the lineage group. + LastModifiedTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + + // The name of the lineage group. + LineageGroupName *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 DescribeLineageGroupOutput) 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 DescribeLineageGroupOutput) GoString() string { + return s.String() +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *DescribeLineageGroupOutput) SetCreatedBy(v *UserContext) *DescribeLineageGroupOutput { + s.CreatedBy = v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeLineageGroupOutput) SetCreationTime(v time.Time) *DescribeLineageGroupOutput { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeLineageGroupOutput) SetDescription(v string) *DescribeLineageGroupOutput { + s.Description = &v + return s +} + +// SetDisplayName sets the DisplayName field's value. +func (s *DescribeLineageGroupOutput) SetDisplayName(v string) *DescribeLineageGroupOutput { + s.DisplayName = &v + return s +} + +// SetLastModifiedBy sets the LastModifiedBy field's value. +func (s *DescribeLineageGroupOutput) SetLastModifiedBy(v *UserContext) *DescribeLineageGroupOutput { + s.LastModifiedBy = v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DescribeLineageGroupOutput) SetLastModifiedTime(v time.Time) *DescribeLineageGroupOutput { + s.LastModifiedTime = &v + return s +} + +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *DescribeLineageGroupOutput) SetLineageGroupArn(v string) *DescribeLineageGroupOutput { + s.LineageGroupArn = &v + return s +} + +// SetLineageGroupName sets the LineageGroupName field's value. +func (s *DescribeLineageGroupOutput) SetLineageGroupName(v string) *DescribeLineageGroupOutput { + s.LineageGroupName = &v + return s +} + type DescribeModelBiasJobDefinitionInput struct { _ struct{} `type:"structure"` @@ -46754,7 +48692,7 @@ type DescribeModelPackageGroupOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. // // CreatedBy is a required field CreatedBy *UserContext `type:"structure" required:"true"` @@ -46892,6 +48830,12 @@ func (s *DescribeModelPackageInput) SetModelPackageName(v string) *DescribeModel type DescribeModelPackageOutput struct { _ struct{} `type:"structure"` + // An array of additional Inference Specification objects. Each additional Inference + // Specification specifies artifacts based on this model package that can be + // used on inference endpoints. Generally used with SageMaker Neo to store the + // compiled artifacts. + AdditionalInferenceSpecifications []*AdditionalInferenceSpecificationDefinition `min:"1" type:"list"` + // A description provided for the model approval. ApprovalDescription *string `type:"string"` @@ -46900,7 +48844,7 @@ type DescribeModelPackageOutput struct { CertifyForMarketplace *bool `type:"boolean"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // A timestamp specifying when the model package was created. @@ -46911,12 +48855,22 @@ type DescribeModelPackageOutput struct { // The metadata properties associated with the model package versions. CustomerMetadataProperties map[string]*string `min:"1" type:"map"` + // The machine learning domain of the model package you specified. Common machine + // learning domains include computer vision and natural language processing. + Domain *string `type:"string"` + + // Represents the drift check baselines that can be used when the model monitor + // is set using the model package. For more information, see the topic on Drift + // Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) + // in the Amazon SageMaker Developer Guide. + DriftCheckBaselines *DriftCheckBaselines `type:"structure"` + // Details about inference jobs that can be run with models based on this model // package. InferenceSpecification *InferenceSpecification `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The last time the model package was modified. @@ -46961,9 +48915,18 @@ type DescribeModelPackageOutput struct { // The version of the model package. ModelPackageVersion *int64 `min:"1" type:"integer"` + // The Amazon Simple Storage Service (Amazon S3) path where the sample payload + // are stored. This path points to a single gzip compressed tar archive (.tar.gz + // suffix). + SamplePayloadUrl *string `type:"string"` + // Details about the algorithm that was used to create the model package. SourceAlgorithmSpecification *SourceAlgorithmSpecification `type:"structure"` + // The machine learning task you specified that your model package accomplishes. + // Common machine learning tasks include object detection and image classification. + Task *string `type:"string"` + // Configurations for one or more transform jobs that SageMaker runs to test // the model package. ValidationSpecification *ModelPackageValidationSpecification `type:"structure"` @@ -46987,6 +48950,12 @@ func (s DescribeModelPackageOutput) GoString() string { return s.String() } +// SetAdditionalInferenceSpecifications sets the AdditionalInferenceSpecifications field's value. +func (s *DescribeModelPackageOutput) SetAdditionalInferenceSpecifications(v []*AdditionalInferenceSpecificationDefinition) *DescribeModelPackageOutput { + s.AdditionalInferenceSpecifications = v + return s +} + // SetApprovalDescription sets the ApprovalDescription field's value. func (s *DescribeModelPackageOutput) SetApprovalDescription(v string) *DescribeModelPackageOutput { s.ApprovalDescription = &v @@ -47017,6 +48986,18 @@ func (s *DescribeModelPackageOutput) SetCustomerMetadataProperties(v map[string] return s } +// SetDomain sets the Domain field's value. +func (s *DescribeModelPackageOutput) SetDomain(v string) *DescribeModelPackageOutput { + s.Domain = &v + return s +} + +// SetDriftCheckBaselines sets the DriftCheckBaselines field's value. +func (s *DescribeModelPackageOutput) SetDriftCheckBaselines(v *DriftCheckBaselines) *DescribeModelPackageOutput { + s.DriftCheckBaselines = v + return s +} + // SetInferenceSpecification sets the InferenceSpecification field's value. func (s *DescribeModelPackageOutput) SetInferenceSpecification(v *InferenceSpecification) *DescribeModelPackageOutput { s.InferenceSpecification = v @@ -47095,12 +49076,24 @@ func (s *DescribeModelPackageOutput) SetModelPackageVersion(v int64) *DescribeMo return s } +// SetSamplePayloadUrl sets the SamplePayloadUrl field's value. +func (s *DescribeModelPackageOutput) SetSamplePayloadUrl(v string) *DescribeModelPackageOutput { + s.SamplePayloadUrl = &v + return s +} + // SetSourceAlgorithmSpecification sets the SourceAlgorithmSpecification field's value. func (s *DescribeModelPackageOutput) SetSourceAlgorithmSpecification(v *SourceAlgorithmSpecification) *DescribeModelPackageOutput { s.SourceAlgorithmSpecification = v return s } +// SetTask sets the Task field's value. +func (s *DescribeModelPackageOutput) SetTask(v string) *DescribeModelPackageOutput { + s.Task = &v + return s +} + // SetValidationSpecification sets the ValidationSpecification field's value. func (s *DescribeModelPackageOutput) SetValidationSpecification(v *ModelPackageValidationSpecification) *DescribeModelPackageOutput { s.ValidationSpecification = v @@ -48032,7 +50025,7 @@ type DescribePipelineExecutionOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The time when the pipeline execution was created. @@ -48042,7 +50035,7 @@ type DescribePipelineExecutionOutput struct { FailureReason *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The time when the pipeline execution was modified last. @@ -48204,14 +50197,14 @@ type DescribePipelineOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The time when the pipeline was created. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The time when the pipeline was last modified. @@ -48665,7 +50658,7 @@ type DescribeProjectOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The time when the project was created. @@ -48674,7 +50667,7 @@ type DescribeProjectOutput struct { CreationTime *time.Time `type:"timestamp" required:"true"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The timestamp when project was last modified. @@ -49947,6 +51940,9 @@ type DescribeTrialComponentOutput struct { // When the component was last modified. LastModifiedTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *MetadataProperties `type:"structure"` @@ -50041,6 +52037,12 @@ func (s *DescribeTrialComponentOutput) SetLastModifiedTime(v time.Time) *Describ return s } +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *DescribeTrialComponentOutput) SetLineageGroupArn(v string) *DescribeTrialComponentOutput { + s.LineageGroupArn = &v + return s +} + // SetMetadataProperties sets the MetadataProperties field's value. func (s *DescribeTrialComponentOutput) SetMetadataProperties(v *MetadataProperties) *DescribeTrialComponentOutput { s.MetadataProperties = v @@ -51304,6 +53306,408 @@ func (s *DomainSettingsForUpdate) SetRStudioServerProDomainSettingsForUpdate(v * return s } +// Represents the drift check baselines that can be used when the model monitor +// is set using the model package. +type DriftCheckBaselines struct { + _ struct{} `type:"structure"` + + // Represents the drift check bias baselines that can be used when the model + // monitor is set using the model package. + Bias *DriftCheckBias `type:"structure"` + + // Represents the drift check explainability baselines that can be used when + // the model monitor is set using the model package. + Explainability *DriftCheckExplainability `type:"structure"` + + // Represents the drift check model data quality baselines that can be used + // when the model monitor is set using the model package. + ModelDataQuality *DriftCheckModelDataQuality `type:"structure"` + + // Represents the drift check model quality baselines that can be used when + // the model monitor is set using the model package. + ModelQuality *DriftCheckModelQuality `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 DriftCheckBaselines) 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 DriftCheckBaselines) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DriftCheckBaselines) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DriftCheckBaselines"} + if s.Bias != nil { + if err := s.Bias.Validate(); err != nil { + invalidParams.AddNested("Bias", err.(request.ErrInvalidParams)) + } + } + if s.Explainability != nil { + if err := s.Explainability.Validate(); err != nil { + invalidParams.AddNested("Explainability", err.(request.ErrInvalidParams)) + } + } + if s.ModelDataQuality != nil { + if err := s.ModelDataQuality.Validate(); err != nil { + invalidParams.AddNested("ModelDataQuality", err.(request.ErrInvalidParams)) + } + } + if s.ModelQuality != nil { + if err := s.ModelQuality.Validate(); err != nil { + invalidParams.AddNested("ModelQuality", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBias sets the Bias field's value. +func (s *DriftCheckBaselines) SetBias(v *DriftCheckBias) *DriftCheckBaselines { + s.Bias = v + return s +} + +// SetExplainability sets the Explainability field's value. +func (s *DriftCheckBaselines) SetExplainability(v *DriftCheckExplainability) *DriftCheckBaselines { + s.Explainability = v + return s +} + +// SetModelDataQuality sets the ModelDataQuality field's value. +func (s *DriftCheckBaselines) SetModelDataQuality(v *DriftCheckModelDataQuality) *DriftCheckBaselines { + s.ModelDataQuality = v + return s +} + +// SetModelQuality sets the ModelQuality field's value. +func (s *DriftCheckBaselines) SetModelQuality(v *DriftCheckModelQuality) *DriftCheckBaselines { + s.ModelQuality = v + return s +} + +// Represents the drift check bias baselines that can be used when the model +// monitor is set using the model package. +type DriftCheckBias struct { + _ struct{} `type:"structure"` + + // The bias config file for a model. + ConfigFile *FileSource `type:"structure"` + + PostTrainingConstraints *MetricsSource `type:"structure"` + + PreTrainingConstraints *MetricsSource `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 DriftCheckBias) 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 DriftCheckBias) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DriftCheckBias) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DriftCheckBias"} + if s.ConfigFile != nil { + if err := s.ConfigFile.Validate(); err != nil { + invalidParams.AddNested("ConfigFile", err.(request.ErrInvalidParams)) + } + } + if s.PostTrainingConstraints != nil { + if err := s.PostTrainingConstraints.Validate(); err != nil { + invalidParams.AddNested("PostTrainingConstraints", err.(request.ErrInvalidParams)) + } + } + if s.PreTrainingConstraints != nil { + if err := s.PreTrainingConstraints.Validate(); err != nil { + invalidParams.AddNested("PreTrainingConstraints", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfigFile sets the ConfigFile field's value. +func (s *DriftCheckBias) SetConfigFile(v *FileSource) *DriftCheckBias { + s.ConfigFile = v + return s +} + +// SetPostTrainingConstraints sets the PostTrainingConstraints field's value. +func (s *DriftCheckBias) SetPostTrainingConstraints(v *MetricsSource) *DriftCheckBias { + s.PostTrainingConstraints = v + return s +} + +// SetPreTrainingConstraints sets the PreTrainingConstraints field's value. +func (s *DriftCheckBias) SetPreTrainingConstraints(v *MetricsSource) *DriftCheckBias { + s.PreTrainingConstraints = v + return s +} + +// Represents the drift check explainability baselines that can be used when +// the model monitor is set using the model package. +type DriftCheckExplainability struct { + _ struct{} `type:"structure"` + + // The explainability config file for the model. + ConfigFile *FileSource `type:"structure"` + + Constraints *MetricsSource `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 DriftCheckExplainability) 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 DriftCheckExplainability) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DriftCheckExplainability) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DriftCheckExplainability"} + if s.ConfigFile != nil { + if err := s.ConfigFile.Validate(); err != nil { + invalidParams.AddNested("ConfigFile", err.(request.ErrInvalidParams)) + } + } + if s.Constraints != nil { + if err := s.Constraints.Validate(); err != nil { + invalidParams.AddNested("Constraints", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfigFile sets the ConfigFile field's value. +func (s *DriftCheckExplainability) SetConfigFile(v *FileSource) *DriftCheckExplainability { + s.ConfigFile = v + return s +} + +// SetConstraints sets the Constraints field's value. +func (s *DriftCheckExplainability) SetConstraints(v *MetricsSource) *DriftCheckExplainability { + s.Constraints = v + return s +} + +// Represents the drift check data quality baselines that can be used when the +// model monitor is set using the model package. +type DriftCheckModelDataQuality struct { + _ struct{} `type:"structure"` + + Constraints *MetricsSource `type:"structure"` + + Statistics *MetricsSource `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 DriftCheckModelDataQuality) 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 DriftCheckModelDataQuality) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DriftCheckModelDataQuality) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DriftCheckModelDataQuality"} + if s.Constraints != nil { + if err := s.Constraints.Validate(); err != nil { + invalidParams.AddNested("Constraints", err.(request.ErrInvalidParams)) + } + } + if s.Statistics != nil { + if err := s.Statistics.Validate(); err != nil { + invalidParams.AddNested("Statistics", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConstraints sets the Constraints field's value. +func (s *DriftCheckModelDataQuality) SetConstraints(v *MetricsSource) *DriftCheckModelDataQuality { + s.Constraints = v + return s +} + +// SetStatistics sets the Statistics field's value. +func (s *DriftCheckModelDataQuality) SetStatistics(v *MetricsSource) *DriftCheckModelDataQuality { + s.Statistics = v + return s +} + +// Represents the drift check model quality baselines that can be used when +// the model monitor is set using the model package. +type DriftCheckModelQuality struct { + _ struct{} `type:"structure"` + + Constraints *MetricsSource `type:"structure"` + + Statistics *MetricsSource `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 DriftCheckModelQuality) 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 DriftCheckModelQuality) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DriftCheckModelQuality) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DriftCheckModelQuality"} + if s.Constraints != nil { + if err := s.Constraints.Validate(); err != nil { + invalidParams.AddNested("Constraints", err.(request.ErrInvalidParams)) + } + } + if s.Statistics != nil { + if err := s.Statistics.Validate(); err != nil { + invalidParams.AddNested("Statistics", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConstraints sets the Constraints field's value. +func (s *DriftCheckModelQuality) SetConstraints(v *MetricsSource) *DriftCheckModelQuality { + s.Constraints = v + return s +} + +// SetStatistics sets the Statistics field's value. +func (s *DriftCheckModelQuality) SetStatistics(v *MetricsSource) *DriftCheckModelQuality { + s.Statistics = v + return s +} + +// A directed edge connecting two lineage entities. +type Edge struct { + _ struct{} `type:"structure"` + + // The type of the Association(Edge) between the source and destination. For + // example ContributedTo, Produced, or DerivedFrom. + AssociationType *string `type:"string" enum:"AssociationEdgeType"` + + // The Amazon Resource Name (ARN) of the destination lineage entity of the directed + // edge. + DestinationArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the source lineage entity of the directed + // edge. + SourceArn *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 Edge) 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 Edge) GoString() string { + return s.String() +} + +// SetAssociationType sets the AssociationType field's value. +func (s *Edge) SetAssociationType(v string) *Edge { + s.AssociationType = &v + return s +} + +// SetDestinationArn sets the DestinationArn field's value. +func (s *Edge) SetDestinationArn(v string) *Edge { + s.DestinationArn = &v + return s +} + +// SetSourceArn sets the SourceArn field's value. +func (s *Edge) SetSourceArn(v string) *Edge { + s.SourceArn = &v + return s +} + // The model on the edge device. type EdgeModel struct { _ struct{} `type:"structure"` @@ -52148,6 +54552,148 @@ func (s *EndpointInput) SetStartTimeOffset(v string) *EndpointInput { return s } +// The endpoint configuration for the load test. +type EndpointInputConfiguration struct { + _ struct{} `type:"structure"` + + // The parameter you want to benchmark against. + EnvironmentParameterRanges *EnvironmentParameterRanges `type:"structure"` + + // The inference specification name in the model package version. + InferenceSpecificationName *string `min:"1" type:"string"` + + // The instance types to use for the load test. + // + // InstanceType is a required field + InstanceType *string `type:"string" required:"true" enum:"ProductionVariantInstanceType"` +} + +// 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 EndpointInputConfiguration) 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 EndpointInputConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EndpointInputConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EndpointInputConfiguration"} + if s.InferenceSpecificationName != nil && len(*s.InferenceSpecificationName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InferenceSpecificationName", 1)) + } + if s.InstanceType == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceType")) + } + if s.EnvironmentParameterRanges != nil { + if err := s.EnvironmentParameterRanges.Validate(); err != nil { + invalidParams.AddNested("EnvironmentParameterRanges", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnvironmentParameterRanges sets the EnvironmentParameterRanges field's value. +func (s *EndpointInputConfiguration) SetEnvironmentParameterRanges(v *EnvironmentParameterRanges) *EndpointInputConfiguration { + s.EnvironmentParameterRanges = v + return s +} + +// SetInferenceSpecificationName sets the InferenceSpecificationName field's value. +func (s *EndpointInputConfiguration) SetInferenceSpecificationName(v string) *EndpointInputConfiguration { + s.InferenceSpecificationName = &v + return s +} + +// SetInstanceType sets the InstanceType field's value. +func (s *EndpointInputConfiguration) SetInstanceType(v string) *EndpointInputConfiguration { + s.InstanceType = &v + return s +} + +// The endpoint configuration made by Inference Recommender during a recommendation +// job. +type EndpointOutputConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the endpoint made during a recommendation job. + // + // EndpointName is a required field + EndpointName *string `type:"string" required:"true"` + + // The number of instances recommended to launch initially. + // + // InitialInstanceCount is a required field + InitialInstanceCount *int64 `type:"integer" required:"true"` + + // The instance type recommended by Amazon SageMaker Inference Recommender. + // + // InstanceType is a required field + InstanceType *string `type:"string" required:"true" enum:"ProductionVariantInstanceType"` + + // The name of the production variant (deployed model) made during a recommendation + // job. + // + // VariantName is a required field + VariantName *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 EndpointOutputConfiguration) 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 EndpointOutputConfiguration) GoString() string { + return s.String() +} + +// SetEndpointName sets the EndpointName field's value. +func (s *EndpointOutputConfiguration) SetEndpointName(v string) *EndpointOutputConfiguration { + s.EndpointName = &v + return s +} + +// SetInitialInstanceCount sets the InitialInstanceCount field's value. +func (s *EndpointOutputConfiguration) SetInitialInstanceCount(v int64) *EndpointOutputConfiguration { + s.InitialInstanceCount = &v + return s +} + +// SetInstanceType sets the InstanceType field's value. +func (s *EndpointOutputConfiguration) SetInstanceType(v string) *EndpointOutputConfiguration { + s.InstanceType = &v + return s +} + +// SetVariantName sets the VariantName field's value. +func (s *EndpointOutputConfiguration) SetVariantName(v string) *EndpointOutputConfiguration { + s.VariantName = &v + return s +} + // Provides summary information for an endpoint. type EndpointSummary struct { _ struct{} `type:"structure"` @@ -52256,6 +54802,118 @@ func (s *EndpointSummary) SetLastModifiedTime(v time.Time) *EndpointSummary { return s } +// A list of environment parameters suggested by the Amazon SageMaker Inference +// Recommender. +type EnvironmentParameter struct { + _ struct{} `type:"structure"` + + // The environment key suggested by the Amazon SageMaker Inference Recommender. + // + // Key is a required field + Key *string `type:"string" required:"true"` + + // The value suggested by the Amazon SageMaker Inference Recommender. + // + // Value is a required field + Value *string `type:"string" required:"true"` + + // The value type suggested by the Amazon SageMaker Inference Recommender. + // + // ValueType is a required field + ValueType *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 EnvironmentParameter) 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 EnvironmentParameter) GoString() string { + return s.String() +} + +// SetKey sets the Key field's value. +func (s *EnvironmentParameter) SetKey(v string) *EnvironmentParameter { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *EnvironmentParameter) SetValue(v string) *EnvironmentParameter { + s.Value = &v + return s +} + +// SetValueType sets the ValueType field's value. +func (s *EnvironmentParameter) SetValueType(v string) *EnvironmentParameter { + s.ValueType = &v + return s +} + +// Specifies the range of environment parameters +type EnvironmentParameterRanges struct { + _ struct{} `type:"structure"` + + // Specified a list of parameters for each category. + CategoricalParameterRanges []*CategoricalParameter `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 EnvironmentParameterRanges) 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 EnvironmentParameterRanges) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EnvironmentParameterRanges) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnvironmentParameterRanges"} + if s.CategoricalParameterRanges != nil && len(s.CategoricalParameterRanges) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CategoricalParameterRanges", 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 invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCategoricalParameterRanges sets the CategoricalParameterRanges field's value. +func (s *EnvironmentParameterRanges) SetCategoricalParameterRanges(v []*CategoricalParameter) *EnvironmentParameterRanges { + s.CategoricalParameterRanges = v + return s +} + // The properties of an experiment as returned by the Search API. type Experiment struct { _ struct{} `type:"structure"` @@ -52280,7 +54938,7 @@ type Experiment struct { ExperimentName *string `min:"1" type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // When the experiment was last modified. @@ -52927,6 +55585,71 @@ func (s *FeatureGroupSummary) SetOfflineStoreStatus(v *OfflineStoreStatus) *Feat return s } +// Contains details regarding the file source. +type FileSource struct { + _ struct{} `type:"structure"` + + // The digest of the file source. + ContentDigest *string `type:"string"` + + // The type of content stored in the file source. + ContentType *string `type:"string"` + + // The Amazon S3 URI for the file source. + // + // S3Uri is a required field + S3Uri *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 FileSource) 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 FileSource) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FileSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FileSource"} + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContentDigest sets the ContentDigest field's value. +func (s *FileSource) SetContentDigest(v string) *FileSource { + s.ContentDigest = &v + return s +} + +// SetContentType sets the ContentType field's value. +func (s *FileSource) SetContentType(v string) *FileSource { + s.ContentType = &v + return s +} + +// SetS3Uri sets the S3Uri field's value. +func (s *FileSource) SetS3Uri(v string) *FileSource { + s.S3Uri = &v + return s +} + // The Amazon Elastic File System (EFS) storage configuration for a SageMaker // image. type FileSystemConfig struct { @@ -53663,6 +56386,95 @@ func (s *GetDeviceFleetReportOutput) SetReportGenerated(v time.Time) *GetDeviceF return s } +type GetLineageGroupPolicyInput struct { + _ struct{} `type:"structure"` + + // The name or Amazon Resource Name (ARN) of the lineage group. + // + // LineageGroupName is a required field + LineageGroupName *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 GetLineageGroupPolicyInput) 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 GetLineageGroupPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetLineageGroupPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetLineageGroupPolicyInput"} + if s.LineageGroupName == nil { + invalidParams.Add(request.NewErrParamRequired("LineageGroupName")) + } + if s.LineageGroupName != nil && len(*s.LineageGroupName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LineageGroupName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLineageGroupName sets the LineageGroupName field's value. +func (s *GetLineageGroupPolicyInput) SetLineageGroupName(v string) *GetLineageGroupPolicyInput { + s.LineageGroupName = &v + return s +} + +type GetLineageGroupPolicyOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the lineage group. + LineageGroupArn *string `type:"string"` + + // The resource policy that gives access to the lineage group in another account. + ResourcePolicy *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 GetLineageGroupPolicyOutput) 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 GetLineageGroupPolicyOutput) GoString() string { + return s.String() +} + +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *GetLineageGroupPolicyOutput) SetLineageGroupArn(v string) *GetLineageGroupPolicyOutput { + s.LineageGroupArn = &v + return s +} + +// SetResourcePolicy sets the ResourcePolicy field's value. +func (s *GetLineageGroupPolicyOutput) SetResourcePolicy(v string) *GetLineageGroupPolicyOutput { + s.ResourcePolicy = &v + return s +} + type GetModelPackageGroupPolicyInput struct { _ struct{} `type:"structure"` @@ -55220,8 +58032,7 @@ type HumanTaskConfig struct { // // * If you choose a private or vendor workforce, the default value is 30 // days (2592,000 seconds) for non-AL mode. For most users, the maximum is - // also 30 days. If you want to change this limit, contact Amazon Web Services - // Support. + // also 30 days. TaskAvailabilityLifetimeInSeconds *int64 `min:"60" type:"integer"` // A description of the task for your human workers. @@ -55248,8 +58059,7 @@ type HumanTaskConfig struct { // * For 3D point cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud.html) // and video frame (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-video.html) // labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. - // For most users, the maximum is also 30 days. If you want to change these - // limits, contact Amazon Web Services Support. + // For most users, the maximum is also 30 days. // // TaskTimeLimitInSeconds is a required field TaskTimeLimitInSeconds *int64 `min:"30" type:"integer" required:"true"` @@ -56970,6 +59780,192 @@ func (s *InferenceExecutionConfig) SetMode(v string) *InferenceExecutionConfig { return s } +// A list of recommendations made by Amazon SageMaker Inference Recommender. +type InferenceRecommendation struct { + _ struct{} `type:"structure"` + + // Defines the endpoint configuration parameters. + // + // EndpointConfiguration is a required field + EndpointConfiguration *EndpointOutputConfiguration `type:"structure" required:"true"` + + // The metrics used to decide what recommendation to make. + // + // Metrics is a required field + Metrics *RecommendationMetrics `type:"structure" required:"true"` + + // Defines the model configuration. + // + // ModelConfiguration is a required field + ModelConfiguration *ModelConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferenceRecommendation) 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 InferenceRecommendation) GoString() string { + return s.String() +} + +// SetEndpointConfiguration sets the EndpointConfiguration field's value. +func (s *InferenceRecommendation) SetEndpointConfiguration(v *EndpointOutputConfiguration) *InferenceRecommendation { + s.EndpointConfiguration = v + return s +} + +// SetMetrics sets the Metrics field's value. +func (s *InferenceRecommendation) SetMetrics(v *RecommendationMetrics) *InferenceRecommendation { + s.Metrics = v + return s +} + +// SetModelConfiguration sets the ModelConfiguration field's value. +func (s *InferenceRecommendation) SetModelConfiguration(v *ModelConfiguration) *InferenceRecommendation { + s.ModelConfiguration = v + return s +} + +// A structure that contains a list of recommendation jobs. +type InferenceRecommendationsJob struct { + _ struct{} `type:"structure"` + + // A timestamp that shows when the job completed. + CompletionTime *time.Time `type:"timestamp"` + + // A timestamp that shows when the job was created. + // + // CreationTime is a required field + CreationTime *time.Time `type:"timestamp" required:"true"` + + // If the job fails, provides information why the job failed. + FailureReason *string `type:"string"` + + // The Amazon Resource Name (ARN) of the recommendation job. + // + // JobArn is a required field + JobArn *string `type:"string" required:"true"` + + // The job description. + // + // JobDescription is a required field + JobDescription *string `type:"string" required:"true"` + + // The name of the job. + // + // JobName is a required field + JobName *string `min:"1" type:"string" required:"true"` + + // The recommendation job type. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"RecommendationJobType"` + + // A timestamp that shows when the job was last modified. + // + // LastModifiedTime is a required field + LastModifiedTime *time.Time `type:"timestamp" required:"true"` + + // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker + // to perform tasks on your behalf. + // + // RoleArn is a required field + RoleArn *string `min:"20" type:"string" required:"true"` + + // The status of the job. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"RecommendationJobStatus"` +} + +// 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 InferenceRecommendationsJob) 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 InferenceRecommendationsJob) GoString() string { + return s.String() +} + +// SetCompletionTime sets the CompletionTime field's value. +func (s *InferenceRecommendationsJob) SetCompletionTime(v time.Time) *InferenceRecommendationsJob { + s.CompletionTime = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *InferenceRecommendationsJob) SetCreationTime(v time.Time) *InferenceRecommendationsJob { + s.CreationTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *InferenceRecommendationsJob) SetFailureReason(v string) *InferenceRecommendationsJob { + s.FailureReason = &v + return s +} + +// SetJobArn sets the JobArn field's value. +func (s *InferenceRecommendationsJob) SetJobArn(v string) *InferenceRecommendationsJob { + s.JobArn = &v + return s +} + +// SetJobDescription sets the JobDescription field's value. +func (s *InferenceRecommendationsJob) SetJobDescription(v string) *InferenceRecommendationsJob { + s.JobDescription = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *InferenceRecommendationsJob) SetJobName(v string) *InferenceRecommendationsJob { + s.JobName = &v + return s +} + +// SetJobType sets the JobType field's value. +func (s *InferenceRecommendationsJob) SetJobType(v string) *InferenceRecommendationsJob { + s.JobType = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *InferenceRecommendationsJob) SetLastModifiedTime(v time.Time) *InferenceRecommendationsJob { + s.LastModifiedTime = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *InferenceRecommendationsJob) SetRoleArn(v string) *InferenceRecommendationsJob { + s.RoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *InferenceRecommendationsJob) SetStatus(v string) *InferenceRecommendationsJob { + s.Status = &v + return s +} + // Defines how to perform inference generation after a training job is run. type InferenceSpecification struct { _ struct{} `type:"structure"` @@ -58697,6 +61693,75 @@ func (s *LambdaStepMetadata) SetOutputParameters(v []*OutputParameter) *LambdaSt return s } +// Lists a summary of the properties of a lineage group. A lineage group provides +// a group of shareable lineage entity resources. +type LineageGroupSummary struct { + _ struct{} `type:"structure"` + + // The creation time of the lineage group summary. + CreationTime *time.Time `type:"timestamp"` + + // The display name of the lineage group summary. + DisplayName *string `min:"1" type:"string"` + + // The last modified time of the lineage group summary. + LastModifiedTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the lineage group resource. + LineageGroupArn *string `type:"string"` + + // The name or Amazon Resource Name (ARN) of the lineage group. + LineageGroupName *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 LineageGroupSummary) 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 LineageGroupSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *LineageGroupSummary) SetCreationTime(v time.Time) *LineageGroupSummary { + s.CreationTime = &v + return s +} + +// SetDisplayName sets the DisplayName field's value. +func (s *LineageGroupSummary) SetDisplayName(v string) *LineageGroupSummary { + s.DisplayName = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *LineageGroupSummary) SetLastModifiedTime(v time.Time) *LineageGroupSummary { + s.LastModifiedTime = &v + return s +} + +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *LineageGroupSummary) SetLineageGroupArn(v string) *LineageGroupSummary { + s.LineageGroupArn = &v + return s +} + +// SetLineageGroupName sets the LineageGroupName field's value. +func (s *LineageGroupSummary) SetLineageGroupName(v string) *LineageGroupSummary { + s.LineageGroupName = &v + return s +} + type ListActionsInput struct { _ struct{} `type:"structure"` @@ -62507,6 +65572,180 @@ func (s *ListImagesOutput) SetNextToken(v string) *ListImagesOutput { return s } +type ListInferenceRecommendationsJobsInput struct { + _ struct{} `type:"structure"` + + // A filter that returns only jobs created after the specified time (timestamp). + CreationTimeAfter *time.Time `type:"timestamp"` + + // A filter that returns only jobs created before the specified time (timestamp). + CreationTimeBefore *time.Time `type:"timestamp"` + + // A filter that returns only jobs that were last modified after the specified + // time (timestamp). + LastModifiedTimeAfter *time.Time `type:"timestamp"` + + // A filter that returns only jobs that were last modified before the specified + // time (timestamp). + LastModifiedTimeBefore *time.Time `type:"timestamp"` + + // The maximum number of recommendations to return in the response. + MaxResults *int64 `min:"1" type:"integer"` + + // A string in the job name. This filter returns only recommendations whose + // name contains the specified string. + NameContains *string `type:"string"` + + // If the response to a previous ListInferenceRecommendationsJobsRequest request + // was truncated, the response includes a NextToken. To retrieve the next set + // of recommendations, use the token in the next request. + NextToken *string `type:"string"` + + // The parameter by which to sort the results. + SortBy *string `type:"string" enum:"ListInferenceRecommendationsJobsSortBy"` + + // The sort order for the results. + SortOrder *string `type:"string" enum:"SortOrder"` + + // A filter that retrieves only inference recommendations jobs with a specific + // status. + StatusEquals *string `type:"string" enum:"RecommendationJobStatus"` +} + +// 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 ListInferenceRecommendationsJobsInput) 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 ListInferenceRecommendationsJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListInferenceRecommendationsJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListInferenceRecommendationsJobsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreationTimeAfter sets the CreationTimeAfter field's value. +func (s *ListInferenceRecommendationsJobsInput) SetCreationTimeAfter(v time.Time) *ListInferenceRecommendationsJobsInput { + s.CreationTimeAfter = &v + return s +} + +// SetCreationTimeBefore sets the CreationTimeBefore field's value. +func (s *ListInferenceRecommendationsJobsInput) SetCreationTimeBefore(v time.Time) *ListInferenceRecommendationsJobsInput { + s.CreationTimeBefore = &v + return s +} + +// SetLastModifiedTimeAfter sets the LastModifiedTimeAfter field's value. +func (s *ListInferenceRecommendationsJobsInput) SetLastModifiedTimeAfter(v time.Time) *ListInferenceRecommendationsJobsInput { + s.LastModifiedTimeAfter = &v + return s +} + +// SetLastModifiedTimeBefore sets the LastModifiedTimeBefore field's value. +func (s *ListInferenceRecommendationsJobsInput) SetLastModifiedTimeBefore(v time.Time) *ListInferenceRecommendationsJobsInput { + s.LastModifiedTimeBefore = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListInferenceRecommendationsJobsInput) SetMaxResults(v int64) *ListInferenceRecommendationsJobsInput { + s.MaxResults = &v + return s +} + +// SetNameContains sets the NameContains field's value. +func (s *ListInferenceRecommendationsJobsInput) SetNameContains(v string) *ListInferenceRecommendationsJobsInput { + s.NameContains = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListInferenceRecommendationsJobsInput) SetNextToken(v string) *ListInferenceRecommendationsJobsInput { + s.NextToken = &v + return s +} + +// SetSortBy sets the SortBy field's value. +func (s *ListInferenceRecommendationsJobsInput) SetSortBy(v string) *ListInferenceRecommendationsJobsInput { + s.SortBy = &v + return s +} + +// SetSortOrder sets the SortOrder field's value. +func (s *ListInferenceRecommendationsJobsInput) SetSortOrder(v string) *ListInferenceRecommendationsJobsInput { + s.SortOrder = &v + return s +} + +// SetStatusEquals sets the StatusEquals field's value. +func (s *ListInferenceRecommendationsJobsInput) SetStatusEquals(v string) *ListInferenceRecommendationsJobsInput { + s.StatusEquals = &v + return s +} + +type ListInferenceRecommendationsJobsOutput struct { + _ struct{} `type:"structure"` + + // The recommendations created from the Amazon SageMaker Inference Recommender + // job. + // + // InferenceRecommendationsJobs is a required field + InferenceRecommendationsJobs []*InferenceRecommendationsJob `type:"list" required:"true"` + + // A token for getting the next set of recommendations, if there are any. + NextToken *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 ListInferenceRecommendationsJobsOutput) 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 ListInferenceRecommendationsJobsOutput) GoString() string { + return s.String() +} + +// SetInferenceRecommendationsJobs sets the InferenceRecommendationsJobs field's value. +func (s *ListInferenceRecommendationsJobsOutput) SetInferenceRecommendationsJobs(v []*InferenceRecommendationsJob) *ListInferenceRecommendationsJobsOutput { + s.InferenceRecommendationsJobs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListInferenceRecommendationsJobsOutput) SetNextToken(v string) *ListInferenceRecommendationsJobsOutput { + s.NextToken = &v + return s +} + type ListLabelingJobsForWorkteamInput struct { _ struct{} `type:"structure"` @@ -62844,6 +66083,140 @@ func (s *ListLabelingJobsOutput) SetNextToken(v string) *ListLabelingJobsOutput return s } +type ListLineageGroupsInput struct { + _ struct{} `type:"structure"` + + // A timestamp to filter against lineage groups created after a certain point + // in time. + CreatedAfter *time.Time `type:"timestamp"` + + // A timestamp to filter against lineage groups created before a certain point + // in time. + CreatedBefore *time.Time `type:"timestamp"` + + // The maximum number of endpoints to return in the response. This value defaults + // to 10. + MaxResults *int64 `min:"1" type:"integer"` + + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. + NextToken *string `type:"string"` + + // The parameter by which to sort the results. The default is CreationTime. + SortBy *string `type:"string" enum:"SortLineageGroupsBy"` + + // The sort order for the results. The default is Ascending. + SortOrder *string `type:"string" enum:"SortOrder"` +} + +// 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 ListLineageGroupsInput) 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 ListLineageGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListLineageGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListLineageGroupsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreatedAfter sets the CreatedAfter field's value. +func (s *ListLineageGroupsInput) SetCreatedAfter(v time.Time) *ListLineageGroupsInput { + s.CreatedAfter = &v + return s +} + +// SetCreatedBefore sets the CreatedBefore field's value. +func (s *ListLineageGroupsInput) SetCreatedBefore(v time.Time) *ListLineageGroupsInput { + s.CreatedBefore = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListLineageGroupsInput) SetMaxResults(v int64) *ListLineageGroupsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLineageGroupsInput) SetNextToken(v string) *ListLineageGroupsInput { + s.NextToken = &v + return s +} + +// SetSortBy sets the SortBy field's value. +func (s *ListLineageGroupsInput) SetSortBy(v string) *ListLineageGroupsInput { + s.SortBy = &v + return s +} + +// SetSortOrder sets the SortOrder field's value. +func (s *ListLineageGroupsInput) SetSortOrder(v string) *ListLineageGroupsInput { + s.SortOrder = &v + return s +} + +type ListLineageGroupsOutput struct { + _ struct{} `type:"structure"` + + // A list of lineage groups and their properties. + LineageGroupSummaries []*LineageGroupSummary `type:"list"` + + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. + NextToken *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 ListLineageGroupsOutput) 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 ListLineageGroupsOutput) GoString() string { + return s.String() +} + +// SetLineageGroupSummaries sets the LineageGroupSummaries field's value. +func (s *ListLineageGroupsOutput) SetLineageGroupSummaries(v []*LineageGroupSummary) *ListLineageGroupsOutput { + s.LineageGroupSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLineageGroupsOutput) SetNextToken(v string) *ListLineageGroupsOutput { + s.NextToken = &v + return s +} + type ListModelBiasJobDefinitionsInput struct { _ struct{} `type:"structure"` @@ -63155,6 +66528,120 @@ func (s *ListModelExplainabilityJobDefinitionsOutput) SetNextToken(v string) *Li return s } +type ListModelMetadataInput struct { + _ struct{} `type:"structure"` + + // The maximum number of models to return in the response. + MaxResults *int64 `min:"1" type:"integer"` + + // If the response to a previous ListModelMetadataResponse request was truncated, + // the response includes a NextToken. To retrieve the next set of model metadata, + // use the token in the next request. + NextToken *string `type:"string"` + + // One or more filters that searches for the specified resource or resources + // in a search. All resource objects that satisfy the expression's condition + // are included in the search results. Specify the Framework, FrameworkVersion, + // Domain or Task to filter supported. Filter names and values are case-sensitive. + SearchExpression *ModelMetadataSearchExpression `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 ListModelMetadataInput) 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 ListModelMetadataInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListModelMetadataInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListModelMetadataInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.SearchExpression != nil { + if err := s.SearchExpression.Validate(); err != nil { + invalidParams.AddNested("SearchExpression", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListModelMetadataInput) SetMaxResults(v int64) *ListModelMetadataInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListModelMetadataInput) SetNextToken(v string) *ListModelMetadataInput { + s.NextToken = &v + return s +} + +// SetSearchExpression sets the SearchExpression field's value. +func (s *ListModelMetadataInput) SetSearchExpression(v *ModelMetadataSearchExpression) *ListModelMetadataInput { + s.SearchExpression = v + return s +} + +type ListModelMetadataOutput struct { + _ struct{} `type:"structure"` + + // A structure that holds model metadata. + // + // ModelMetadataSummaries is a required field + ModelMetadataSummaries []*ModelMetadataSummary `type:"list" required:"true"` + + // A token for getting the next set of recommendations, if there are any. + NextToken *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 ListModelMetadataOutput) 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 ListModelMetadataOutput) GoString() string { + return s.String() +} + +// SetModelMetadataSummaries sets the ModelMetadataSummaries field's value. +func (s *ListModelMetadataOutput) SetModelMetadataSummaries(v []*ModelMetadataSummary) *ListModelMetadataOutput { + s.ModelMetadataSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListModelMetadataOutput) SetNextToken(v string) *ListModelMetadataOutput { + s.NextToken = &v + return s +} + type ListModelPackageGroupsInput struct { _ struct{} `type:"structure"` @@ -67697,6 +71184,48 @@ func (s *ModelClientConfig) SetInvocationsTimeoutInSeconds(v int64) *ModelClient return s } +// Defines the model configuration. Includes the specification name and environment +// parameters. +type ModelConfiguration struct { + _ struct{} `type:"structure"` + + // Defines the environment parameters that includes key, value types, and values. + EnvironmentParameters []*EnvironmentParameter `min:"1" type:"list"` + + // The inference specification name in the model package version. + InferenceSpecificationName *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 ModelConfiguration) 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 ModelConfiguration) GoString() string { + return s.String() +} + +// SetEnvironmentParameters sets the EnvironmentParameters field's value. +func (s *ModelConfiguration) SetEnvironmentParameters(v []*EnvironmentParameter) *ModelConfiguration { + s.EnvironmentParameters = v + return s +} + +// SetInferenceSpecificationName sets the InferenceSpecificationName field's value. +func (s *ModelConfiguration) SetInferenceSpecificationName(v string) *ModelConfiguration { + s.InferenceSpecificationName = &v + return s +} + // Data quality constraints and statistics for a model. type ModelDataQuality struct { _ struct{} `type:"structure"` @@ -68053,6 +71582,294 @@ func (s *ModelExplainabilityJobInput) SetEndpointInput(v *EndpointInput) *ModelE return s } +// Input object for the model. +type ModelInput_ struct { + _ struct{} `type:"structure"` + + // The input configuration object for the model. + // + // DataInputConfig is a required field + DataInputConfig *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 ModelInput_) 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 ModelInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModelInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModelInput_"} + if s.DataInputConfig == nil { + invalidParams.Add(request.NewErrParamRequired("DataInputConfig")) + } + if s.DataInputConfig != nil && len(*s.DataInputConfig) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataInputConfig", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataInputConfig sets the DataInputConfig field's value. +func (s *ModelInput_) SetDataInputConfig(v string) *ModelInput_ { + s.DataInputConfig = &v + return s +} + +// The model latency threshold. +type ModelLatencyThreshold struct { + _ struct{} `type:"structure"` + + // The model latency percentile threshold. + Percentile *string `type:"string"` + + // The model latency percentile value in milliseconds. + ValueInMilliseconds *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 ModelLatencyThreshold) 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 ModelLatencyThreshold) GoString() string { + return s.String() +} + +// SetPercentile sets the Percentile field's value. +func (s *ModelLatencyThreshold) SetPercentile(v string) *ModelLatencyThreshold { + s.Percentile = &v + return s +} + +// SetValueInMilliseconds sets the ValueInMilliseconds field's value. +func (s *ModelLatencyThreshold) SetValueInMilliseconds(v int64) *ModelLatencyThreshold { + s.ValueInMilliseconds = &v + return s +} + +// Part of the search expression. You can specify the name and value (domain, +// task, framework, framework version, task, and model). +type ModelMetadataFilter struct { + _ struct{} `type:"structure"` + + // The name of the of the model to filter by. + // + // Name is a required field + Name *string `type:"string" required:"true" enum:"ModelMetadataFilterType"` + + // The value to filter the model metadata. + // + // 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 ModelMetadataFilter) 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 ModelMetadataFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModelMetadataFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModelMetadataFilter"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + 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 *ModelMetadataFilter) SetName(v string) *ModelMetadataFilter { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *ModelMetadataFilter) SetValue(v string) *ModelMetadataFilter { + s.Value = &v + return s +} + +// One or more filters that searches for the specified resource or resources +// in a search. All resource objects that satisfy the expression's condition +// are included in the search results +type ModelMetadataSearchExpression struct { + _ struct{} `type:"structure"` + + // A list of filter objects. + Filters []*ModelMetadataFilter `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 ModelMetadataSearchExpression) 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 ModelMetadataSearchExpression) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ModelMetadataSearchExpression) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ModelMetadataSearchExpression"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 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 *ModelMetadataSearchExpression) SetFilters(v []*ModelMetadataFilter) *ModelMetadataSearchExpression { + s.Filters = v + return s +} + +// A summary of the model metadata. +type ModelMetadataSummary struct { + _ struct{} `type:"structure"` + + // The machine learning domain of the model. + // + // Domain is a required field + Domain *string `type:"string" required:"true"` + + // The machine learning framework of the model. + // + // Framework is a required field + Framework *string `type:"string" required:"true"` + + // The framework version of the model. + // + // FrameworkVersion is a required field + FrameworkVersion *string `type:"string" required:"true"` + + // The name of the model. + // + // Model is a required field + Model *string `type:"string" required:"true"` + + // The machine learning task of the model. + // + // Task is a required field + Task *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 ModelMetadataSummary) 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 ModelMetadataSummary) GoString() string { + return s.String() +} + +// SetDomain sets the Domain field's value. +func (s *ModelMetadataSummary) SetDomain(v string) *ModelMetadataSummary { + s.Domain = &v + return s +} + +// SetFramework sets the Framework field's value. +func (s *ModelMetadataSummary) SetFramework(v string) *ModelMetadataSummary { + s.Framework = &v + return s +} + +// SetFrameworkVersion sets the FrameworkVersion field's value. +func (s *ModelMetadataSummary) SetFrameworkVersion(v string) *ModelMetadataSummary { + s.FrameworkVersion = &v + return s +} + +// SetModel sets the Model field's value. +func (s *ModelMetadataSummary) SetModel(v string) *ModelMetadataSummary { + s.Model = &v + return s +} + +// SetTask sets the Task field's value. +func (s *ModelMetadataSummary) SetTask(v string) *ModelMetadataSummary { + s.Task = &v + return s +} + // Contains metrics captured from a model. type ModelMetrics struct { _ struct{} `type:"structure"` @@ -68146,6 +71963,9 @@ func (s *ModelMetrics) SetModelQuality(v *ModelQuality) *ModelMetrics { type ModelPackage struct { _ struct{} `type:"structure"` + // An array of additional Inference Specification objects. + AdditionalInferenceSpecifications []*AdditionalInferenceSpecificationDefinition `min:"1" type:"list"` + // A description provided when the model approval is set. ApprovalDescription *string `type:"string"` @@ -68156,7 +71976,7 @@ type ModelPackage struct { CertifyForMarketplace *bool `type:"boolean"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The time that the model package was created. @@ -68165,11 +71985,19 @@ type ModelPackage struct { // The metadata properties for the model package. CustomerMetadataProperties map[string]*string `min:"1" type:"map"` + // The machine learning domain of your model package and its components. Common + // machine learning domains include computer vision and natural language processing. + Domain *string `type:"string"` + + // Represents the drift check baselines that can be used when the model monitor + // is set using the model package. + DriftCheckBaselines *DriftCheckBaselines `type:"structure"` + // Defines how to perform inference generation after a training job is run. InferenceSpecification *InferenceSpecification `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The last time the model package was modified. @@ -68221,6 +72049,10 @@ type ModelPackage struct { // The version number of a versioned model. ModelPackageVersion *int64 `min:"1" type:"integer"` + // The Amazon Simple Storage Service path where the sample payload are stored. + // This path must point to a single gzip compressed tar archive (.tar.gz suffix). + SamplePayloadUrl *string `type:"string"` + // A list of algorithms that were used to create a model package. SourceAlgorithmSpecification *SourceAlgorithmSpecification `type:"structure"` @@ -68229,6 +72061,10 @@ type ModelPackage struct { // in the Amazon Web Services General Reference Guide. Tags []*Tag `type:"list"` + // The machine learning task your model package accomplishes. Common machine + // learning tasks include object detection and image classification. + Task *string `type:"string"` + // Specifies batch transform jobs that Amazon SageMaker runs to validate your // model package. ValidationSpecification *ModelPackageValidationSpecification `type:"structure"` @@ -68252,6 +72088,12 @@ func (s ModelPackage) GoString() string { return s.String() } +// SetAdditionalInferenceSpecifications sets the AdditionalInferenceSpecifications field's value. +func (s *ModelPackage) SetAdditionalInferenceSpecifications(v []*AdditionalInferenceSpecificationDefinition) *ModelPackage { + s.AdditionalInferenceSpecifications = v + return s +} + // SetApprovalDescription sets the ApprovalDescription field's value. func (s *ModelPackage) SetApprovalDescription(v string) *ModelPackage { s.ApprovalDescription = &v @@ -68282,6 +72124,18 @@ func (s *ModelPackage) SetCustomerMetadataProperties(v map[string]*string) *Mode return s } +// SetDomain sets the Domain field's value. +func (s *ModelPackage) SetDomain(v string) *ModelPackage { + s.Domain = &v + return s +} + +// SetDriftCheckBaselines sets the DriftCheckBaselines field's value. +func (s *ModelPackage) SetDriftCheckBaselines(v *DriftCheckBaselines) *ModelPackage { + s.DriftCheckBaselines = v + return s +} + // SetInferenceSpecification sets the InferenceSpecification field's value. func (s *ModelPackage) SetInferenceSpecification(v *InferenceSpecification) *ModelPackage { s.InferenceSpecification = v @@ -68360,6 +72214,12 @@ func (s *ModelPackage) SetModelPackageVersion(v int64) *ModelPackage { return s } +// SetSamplePayloadUrl sets the SamplePayloadUrl field's value. +func (s *ModelPackage) SetSamplePayloadUrl(v string) *ModelPackage { + s.SamplePayloadUrl = &v + return s +} + // SetSourceAlgorithmSpecification sets the SourceAlgorithmSpecification field's value. func (s *ModelPackage) SetSourceAlgorithmSpecification(v *SourceAlgorithmSpecification) *ModelPackage { s.SourceAlgorithmSpecification = v @@ -68372,6 +72232,12 @@ func (s *ModelPackage) SetTags(v []*Tag) *ModelPackage { return s } +// SetTask sets the Task field's value. +func (s *ModelPackage) SetTask(v string) *ModelPackage { + s.Task = &v + return s +} + // SetValidationSpecification sets the ValidationSpecification field's value. func (s *ModelPackage) SetValidationSpecification(v *ModelPackageValidationSpecification) *ModelPackage { s.ValidationSpecification = v @@ -68390,6 +72256,12 @@ type ModelPackageContainerDefinition struct { // support up to 16 entries in the map. Environment map[string]*string `type:"map"` + // The machine learning framework of the model package container image. + Framework *string `type:"string"` + + // The framework version of the Model Package Container Image. + FrameworkVersion *string `min:"3" type:"string"` + // The Amazon EC2 Container Registry (Amazon ECR) path where inference code // is stored. // @@ -68414,6 +72286,14 @@ type ModelPackageContainerDefinition struct { // the model package. ModelDataUrl *string `type:"string"` + // A structure with Model Input details. + ModelInput *ModelInput_ `type:"structure"` + + // The name of a pre-trained machine learning benchmarked by Amazon SageMaker + // Inference Recommender model that matches your model. You can find a list + // of benchmarked models by calling ListModelMetadata. + NearestModelName *string `type:"string"` + // The Amazon Web Services Marketplace product ID of the model package. ProductId *string `type:"string"` } @@ -68439,9 +72319,17 @@ func (s ModelPackageContainerDefinition) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ModelPackageContainerDefinition) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ModelPackageContainerDefinition"} + if s.FrameworkVersion != nil && len(*s.FrameworkVersion) < 3 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkVersion", 3)) + } if s.Image == nil { invalidParams.Add(request.NewErrParamRequired("Image")) } + if s.ModelInput != nil { + if err := s.ModelInput.Validate(); err != nil { + invalidParams.AddNested("ModelInput", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -68461,6 +72349,18 @@ func (s *ModelPackageContainerDefinition) SetEnvironment(v map[string]*string) * return s } +// SetFramework sets the Framework field's value. +func (s *ModelPackageContainerDefinition) SetFramework(v string) *ModelPackageContainerDefinition { + s.Framework = &v + return s +} + +// SetFrameworkVersion sets the FrameworkVersion field's value. +func (s *ModelPackageContainerDefinition) SetFrameworkVersion(v string) *ModelPackageContainerDefinition { + s.FrameworkVersion = &v + return s +} + // SetImage sets the Image field's value. func (s *ModelPackageContainerDefinition) SetImage(v string) *ModelPackageContainerDefinition { s.Image = &v @@ -68479,6 +72379,18 @@ func (s *ModelPackageContainerDefinition) SetModelDataUrl(v string) *ModelPackag return s } +// SetModelInput sets the ModelInput field's value. +func (s *ModelPackageContainerDefinition) SetModelInput(v *ModelInput_) *ModelPackageContainerDefinition { + s.ModelInput = v + return s +} + +// SetNearestModelName sets the NearestModelName field's value. +func (s *ModelPackageContainerDefinition) SetNearestModelName(v string) *ModelPackageContainerDefinition { + s.NearestModelName = &v + return s +} + // SetProductId sets the ProductId field's value. func (s *ModelPackageContainerDefinition) SetProductId(v string) *ModelPackageContainerDefinition { s.ProductId = &v @@ -68490,7 +72402,7 @@ type ModelPackageGroup struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The time that the model group was created. @@ -72783,6 +76695,12 @@ type PendingProductionVariantSummary struct { // The number of instances associated with the variant. CurrentInstanceCount *int64 `type:"integer"` + // The serverless configuration for the endpoint. + // + // Serverless Inference is in preview release for Amazon SageMaker and is subject + // to change. We do not recommend using this feature in production environments. + CurrentServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` + // The weight associated with the variant. CurrentWeight *float64 `type:"float"` @@ -72795,6 +76713,13 @@ type PendingProductionVariantSummary struct { // to the CreateEndpointConfig operation. DesiredInstanceCount *int64 `type:"integer"` + // The serverless configuration requested for this deployment, as specified + // in the endpoint configuration for the endpoint. + // + // Serverless Inference is in preview release for Amazon SageMaker and is subject + // to change. We do not recommend using this feature in production environments. + DesiredServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` + // The requested weight for the variant in this deployment, as specified in // the endpoint configuration for the endpoint. The value is taken from the // request to the CreateEndpointConfig operation. @@ -72843,6 +76768,12 @@ func (s *PendingProductionVariantSummary) SetCurrentInstanceCount(v int64) *Pend return s } +// SetCurrentServerlessConfig sets the CurrentServerlessConfig field's value. +func (s *PendingProductionVariantSummary) SetCurrentServerlessConfig(v *ProductionVariantServerlessConfig) *PendingProductionVariantSummary { + s.CurrentServerlessConfig = v + return s +} + // SetCurrentWeight sets the CurrentWeight field's value. func (s *PendingProductionVariantSummary) SetCurrentWeight(v float64) *PendingProductionVariantSummary { s.CurrentWeight = &v @@ -72861,6 +76792,12 @@ func (s *PendingProductionVariantSummary) SetDesiredInstanceCount(v int64) *Pend return s } +// SetDesiredServerlessConfig sets the DesiredServerlessConfig field's value. +func (s *PendingProductionVariantSummary) SetDesiredServerlessConfig(v *ProductionVariantServerlessConfig) *PendingProductionVariantSummary { + s.DesiredServerlessConfig = v + return s +} + // SetDesiredWeight sets the DesiredWeight field's value. func (s *PendingProductionVariantSummary) SetDesiredWeight(v float64) *PendingProductionVariantSummary { s.DesiredWeight = &v @@ -72885,19 +76822,85 @@ func (s *PendingProductionVariantSummary) SetVariantStatus(v []*ProductionVarian return s } +// Defines the traffic pattern. +type Phase struct { + _ struct{} `type:"structure"` + + // Specifies how long traffic phase should be. + DurationInSeconds *int64 `min:"1" type:"integer"` + + // Specifies how many concurrent users to start with. + InitialNumberOfUsers *int64 `min:"1" type:"integer"` + + // Specified how many new users to spawn in a minute. + SpawnRate *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 Phase) 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 Phase) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Phase) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Phase"} + if s.DurationInSeconds != nil && *s.DurationInSeconds < 1 { + invalidParams.Add(request.NewErrParamMinValue("DurationInSeconds", 1)) + } + if s.InitialNumberOfUsers != nil && *s.InitialNumberOfUsers < 1 { + invalidParams.Add(request.NewErrParamMinValue("InitialNumberOfUsers", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDurationInSeconds sets the DurationInSeconds field's value. +func (s *Phase) SetDurationInSeconds(v int64) *Phase { + s.DurationInSeconds = &v + return s +} + +// SetInitialNumberOfUsers sets the InitialNumberOfUsers field's value. +func (s *Phase) SetInitialNumberOfUsers(v int64) *Phase { + s.InitialNumberOfUsers = &v + return s +} + +// SetSpawnRate sets the SpawnRate field's value. +func (s *Phase) SetSpawnRate(v int64) *Phase { + s.SpawnRate = &v + return s +} + // A SageMaker Model Building Pipeline instance. type Pipeline struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The creation time of the pipeline. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The time that the pipeline was last modified. @@ -73023,7 +77026,7 @@ type PipelineExecution struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // The creation time of the pipeline execution. @@ -73033,7 +77036,7 @@ type PipelineExecution struct { FailureReason *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // The time that the pipeline execution was last modified. @@ -73246,6 +77249,28 @@ type PipelineExecutionStepMetadata struct { // generated token, and a list of output parameters. Callback *CallbackStepMetadata `type:"structure"` + // Container for the metadata for a Clarify check step. The configurations and + // outcomes of the check step execution. This includes: + // + // * The type of the check conducted, + // + // * The Amazon S3 URIs of baseline constraints and statistics files to be + // used for the drift check. + // + // * The Amazon S3 URIs of newly calculated baseline constraints and statistics. + // + // * The model package group name provided. + // + // * The Amazon S3 URI of the violation report if violations detected. + // + // * The Amazon Resource Name (ARN) of check processing job initiated by + // the step execution. + // + // * The boolean flags indicating if the drift check is skipped. + // + // * If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline. + ClarifyCheck *ClarifyCheckStepMetadata `type:"structure"` + // The outcome of the condition evaluation that was run by this step execution. Condition *ConditionStepMetadata `type:"structure"` @@ -73261,6 +77286,27 @@ type PipelineExecutionStepMetadata struct { // step execution. ProcessingJob *ProcessingJobStepMetadata `type:"structure"` + // The configurations and outcomes of the check step execution. This includes: + // + // * The type of the check conducted, + // + // * The Amazon S3 URIs of baseline constraints and statistics files to be + // used for the drift check. + // + // * The Amazon S3 URIs of newly calculated baseline constraints and statistics. + // + // * The model package group name provided. + // + // * The Amazon S3 URI of the violation report if violations detected. + // + // * The Amazon Resource Name (ARN) of check processing job initiated by + // the step execution. + // + // * The boolean flags indicating if the drift check is skipped. + // + // * If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline. + QualityCheck *QualityCheckStepMetadata `type:"structure"` + // The Amazon Resource Name (ARN) of the model package the model was registered // to by this step execution. RegisterModel *RegisterModelStepMetadata `type:"structure"` @@ -73302,6 +77348,12 @@ func (s *PipelineExecutionStepMetadata) SetCallback(v *CallbackStepMetadata) *Pi return s } +// SetClarifyCheck sets the ClarifyCheck field's value. +func (s *PipelineExecutionStepMetadata) SetClarifyCheck(v *ClarifyCheckStepMetadata) *PipelineExecutionStepMetadata { + s.ClarifyCheck = v + return s +} + // SetCondition sets the Condition field's value. func (s *PipelineExecutionStepMetadata) SetCondition(v *ConditionStepMetadata) *PipelineExecutionStepMetadata { s.Condition = v @@ -73326,6 +77378,12 @@ func (s *PipelineExecutionStepMetadata) SetProcessingJob(v *ProcessingJobStepMet return s } +// SetQualityCheck sets the QualityCheck field's value. +func (s *PipelineExecutionStepMetadata) SetQualityCheck(v *QualityCheckStepMetadata) *PipelineExecutionStepMetadata { + s.QualityCheck = v + return s +} + // SetRegisterModel sets the RegisterModel field's value. func (s *PipelineExecutionStepMetadata) SetRegisterModel(v *RegisterModelStepMetadata) *PipelineExecutionStepMetadata { s.RegisterModel = v @@ -74664,9 +78722,7 @@ type ProductionVariant struct { CoreDumpConfig *ProductionVariantCoreDumpConfig `type:"structure"` // Number of instances to launch initially. - // - // InitialInstanceCount is a required field - InitialInstanceCount *int64 `min:"1" type:"integer" required:"true"` + InitialInstanceCount *int64 `min:"1" type:"integer"` // Determines initial traffic distribution among all of the models that you // specify in the endpoint configuration. The traffic to a production variant @@ -74675,9 +78731,7 @@ type ProductionVariant struct { InitialVariantWeight *float64 `type:"float"` // The ML compute instance type. - // - // InstanceType is a required field - InstanceType *string `type:"string" required:"true" enum:"ProductionVariantInstanceType"` + InstanceType *string `type:"string" enum:"ProductionVariantInstanceType"` // The name of the model that you want to host. This is the name that you specified // when creating the model. @@ -74685,6 +78739,13 @@ type ProductionVariant struct { // ModelName is a required field ModelName *string `type:"string" required:"true"` + // The serverless configuration for an endpoint. Specifies a serverless endpoint + // configuration instead of an instance-based endpoint configuration. + // + // Serverless Inference is in preview release for Amazon SageMaker and is subject + // to change. We do not recommend using this feature in production environments. + ServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` + // The name of the production variant. // // VariantName is a required field @@ -74712,15 +78773,9 @@ func (s ProductionVariant) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ProductionVariant) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ProductionVariant"} - if s.InitialInstanceCount == nil { - invalidParams.Add(request.NewErrParamRequired("InitialInstanceCount")) - } if s.InitialInstanceCount != nil && *s.InitialInstanceCount < 1 { invalidParams.Add(request.NewErrParamMinValue("InitialInstanceCount", 1)) } - if s.InstanceType == nil { - invalidParams.Add(request.NewErrParamRequired("InstanceType")) - } if s.ModelName == nil { invalidParams.Add(request.NewErrParamRequired("ModelName")) } @@ -74732,6 +78787,11 @@ func (s *ProductionVariant) Validate() error { invalidParams.AddNested("CoreDumpConfig", err.(request.ErrInvalidParams)) } } + if s.ServerlessConfig != nil { + if err := s.ServerlessConfig.Validate(); err != nil { + invalidParams.AddNested("ServerlessConfig", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -74775,6 +78835,12 @@ func (s *ProductionVariant) SetModelName(v string) *ProductionVariant { return s } +// SetServerlessConfig sets the ServerlessConfig field's value. +func (s *ProductionVariant) SetServerlessConfig(v *ProductionVariantServerlessConfig) *ProductionVariant { + s.ServerlessConfig = v + return s +} + // SetVariantName sets the VariantName field's value. func (s *ProductionVariant) SetVariantName(v string) *ProductionVariant { s.VariantName = &v @@ -74864,6 +78930,79 @@ func (s *ProductionVariantCoreDumpConfig) SetKmsKeyId(v string) *ProductionVaria return s } +// +// Serverless Inference is in preview release for Amazon SageMaker and is subject +// to change. We do not recommend using this feature in production environments. +// +// Specifies the serverless configuration for an endpoint variant. +type ProductionVariantServerlessConfig struct { + _ struct{} `type:"structure"` + + // The maximum number of concurrent invocations your serverless endpoint can + // process. + // + // MaxConcurrency is a required field + MaxConcurrency *int64 `min:"1" type:"integer" required:"true"` + + // The memory size of your serverless endpoint. Valid values are in 1 GB increments: + // 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB. + // + // MemorySizeInMB is a required field + MemorySizeInMB *int64 `min:"1024" type:"integer" 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 ProductionVariantServerlessConfig) 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 ProductionVariantServerlessConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProductionVariantServerlessConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProductionVariantServerlessConfig"} + if s.MaxConcurrency == nil { + invalidParams.Add(request.NewErrParamRequired("MaxConcurrency")) + } + if s.MaxConcurrency != nil && *s.MaxConcurrency < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxConcurrency", 1)) + } + if s.MemorySizeInMB == nil { + invalidParams.Add(request.NewErrParamRequired("MemorySizeInMB")) + } + if s.MemorySizeInMB != nil && *s.MemorySizeInMB < 1024 { + invalidParams.Add(request.NewErrParamMinValue("MemorySizeInMB", 1024)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxConcurrency sets the MaxConcurrency field's value. +func (s *ProductionVariantServerlessConfig) SetMaxConcurrency(v int64) *ProductionVariantServerlessConfig { + s.MaxConcurrency = &v + return s +} + +// SetMemorySizeInMB sets the MemorySizeInMB field's value. +func (s *ProductionVariantServerlessConfig) SetMemorySizeInMB(v int64) *ProductionVariantServerlessConfig { + s.MemorySizeInMB = &v + return s +} + // Describes the status of the production variant. type ProductionVariantStatus struct { _ struct{} `type:"structure"` @@ -74938,6 +79077,12 @@ type ProductionVariantSummary struct { // The number of instances associated with the variant. CurrentInstanceCount *int64 `type:"integer"` + // The serverless configuration for the endpoint. + // + // Serverless Inference is in preview release for Amazon SageMaker and is subject + // to change. We do not recommend using this feature in production environments. + CurrentServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` + // The weight associated with the variant. CurrentWeight *float64 `type:"float"` @@ -74949,6 +79094,12 @@ type ProductionVariantSummary struct { // request. DesiredInstanceCount *int64 `type:"integer"` + // The serverless configuration requested for the endpoint update. + // + // Serverless Inference is in preview release for Amazon SageMaker and is subject + // to change. We do not recommend using this feature in production environments. + DesiredServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` + // The requested weight, as specified in the UpdateEndpointWeightsAndCapacities // request. DesiredWeight *float64 `type:"float"` @@ -74987,6 +79138,12 @@ func (s *ProductionVariantSummary) SetCurrentInstanceCount(v int64) *ProductionV return s } +// SetCurrentServerlessConfig sets the CurrentServerlessConfig field's value. +func (s *ProductionVariantSummary) SetCurrentServerlessConfig(v *ProductionVariantServerlessConfig) *ProductionVariantSummary { + s.CurrentServerlessConfig = v + return s +} + // SetCurrentWeight sets the CurrentWeight field's value. func (s *ProductionVariantSummary) SetCurrentWeight(v float64) *ProductionVariantSummary { s.CurrentWeight = &v @@ -75005,6 +79162,12 @@ func (s *ProductionVariantSummary) SetDesiredInstanceCount(v int64) *ProductionV return s } +// SetDesiredServerlessConfig sets the DesiredServerlessConfig field's value. +func (s *ProductionVariantSummary) SetDesiredServerlessConfig(v *ProductionVariantServerlessConfig) *ProductionVariantSummary { + s.DesiredServerlessConfig = v + return s +} + // SetDesiredWeight sets the DesiredWeight field's value. func (s *ProductionVariantSummary) SetDesiredWeight(v float64) *ProductionVariantSummary { s.DesiredWeight = &v @@ -75353,7 +79516,7 @@ type Project struct { CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // A timestamp container for when the project was last modified. @@ -76039,6 +80202,396 @@ func (s *PutModelPackageGroupPolicyOutput) SetModelPackageGroupArn(v string) *Pu return s } +// Container for the metadata for a Quality check step. For more information, +// see the topic on QualityCheck step (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-quality-check) +// in the Amazon SageMaker Developer Guide. +type QualityCheckStepMetadata struct { + _ struct{} `type:"structure"` + + // The Amazon S3 URI of the baseline constraints file used for the drift check. + BaselineUsedForDriftCheckConstraints *string `type:"string"` + + // The Amazon S3 URI of the baseline statistics file used for the drift check. + BaselineUsedForDriftCheckStatistics *string `type:"string"` + + // The Amazon S3 URI of the newly calculated baseline constraints file. + CalculatedBaselineConstraints *string `type:"string"` + + // The Amazon S3 URI of the newly calculated baseline statistics file. + CalculatedBaselineStatistics *string `type:"string"` + + // The Amazon Resource Name (ARN) of the Quality check processing job that was + // run by this step execution. + CheckJobArn *string `type:"string"` + + // The type of the Quality check step. + CheckType *string `type:"string"` + + // The model package group name. + ModelPackageGroupName *string `type:"string"` + + // This flag indicates if a newly calculated baseline can be accessed through + // step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. + // If it is set to False, the previous baseline of the configured check type + // must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints + // and BaselineUsedForDriftCheckStatistics properties. + RegisterNewBaseline *bool `type:"boolean"` + + // This flag indicates if the drift check against the previous baseline will + // be skipped or not. If it is set to False, the previous baseline of the configured + // check type must be available. + SkipCheck *bool `type:"boolean"` + + // The Amazon S3 URI of violation report if violations are detected. + ViolationReport *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 QualityCheckStepMetadata) 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 QualityCheckStepMetadata) GoString() string { + return s.String() +} + +// SetBaselineUsedForDriftCheckConstraints sets the BaselineUsedForDriftCheckConstraints field's value. +func (s *QualityCheckStepMetadata) SetBaselineUsedForDriftCheckConstraints(v string) *QualityCheckStepMetadata { + s.BaselineUsedForDriftCheckConstraints = &v + return s +} + +// SetBaselineUsedForDriftCheckStatistics sets the BaselineUsedForDriftCheckStatistics field's value. +func (s *QualityCheckStepMetadata) SetBaselineUsedForDriftCheckStatistics(v string) *QualityCheckStepMetadata { + s.BaselineUsedForDriftCheckStatistics = &v + return s +} + +// SetCalculatedBaselineConstraints sets the CalculatedBaselineConstraints field's value. +func (s *QualityCheckStepMetadata) SetCalculatedBaselineConstraints(v string) *QualityCheckStepMetadata { + s.CalculatedBaselineConstraints = &v + return s +} + +// SetCalculatedBaselineStatistics sets the CalculatedBaselineStatistics field's value. +func (s *QualityCheckStepMetadata) SetCalculatedBaselineStatistics(v string) *QualityCheckStepMetadata { + s.CalculatedBaselineStatistics = &v + return s +} + +// SetCheckJobArn sets the CheckJobArn field's value. +func (s *QualityCheckStepMetadata) SetCheckJobArn(v string) *QualityCheckStepMetadata { + s.CheckJobArn = &v + return s +} + +// SetCheckType sets the CheckType field's value. +func (s *QualityCheckStepMetadata) SetCheckType(v string) *QualityCheckStepMetadata { + s.CheckType = &v + return s +} + +// SetModelPackageGroupName sets the ModelPackageGroupName field's value. +func (s *QualityCheckStepMetadata) SetModelPackageGroupName(v string) *QualityCheckStepMetadata { + s.ModelPackageGroupName = &v + return s +} + +// SetRegisterNewBaseline sets the RegisterNewBaseline field's value. +func (s *QualityCheckStepMetadata) SetRegisterNewBaseline(v bool) *QualityCheckStepMetadata { + s.RegisterNewBaseline = &v + return s +} + +// SetSkipCheck sets the SkipCheck field's value. +func (s *QualityCheckStepMetadata) SetSkipCheck(v bool) *QualityCheckStepMetadata { + s.SkipCheck = &v + return s +} + +// SetViolationReport sets the ViolationReport field's value. +func (s *QualityCheckStepMetadata) SetViolationReport(v string) *QualityCheckStepMetadata { + s.ViolationReport = &v + return s +} + +// A set of filters to narrow the set of lineage entities connected to the StartArn(s) +// returned by the QueryLineage API action. +type QueryFilters struct { + _ struct{} `type:"structure"` + + // Filter the lineage entities connected to the StartArn(s) after the create + // date. + CreatedAfter *time.Time `type:"timestamp"` + + // Filter the lineage entities connected to the StartArn(s) by created date. + CreatedBefore *time.Time `type:"timestamp"` + + // Filter the lineage entities connected to the StartArn(s) by the type of the + // lineage entity. + LineageTypes []*string `type:"list"` + + // Filter the lineage entities connected to the StartArn(s) after the last modified + // date. + ModifiedAfter *time.Time `type:"timestamp"` + + // Filter the lineage entities connected to the StartArn(s) before the last + // modified date. + ModifiedBefore *time.Time `type:"timestamp"` + + // Filter the lineage entities connected to the StartArn(s) by a set if property + // key value pairs. If multiple pairs are provided, an entity will be included + // in the results if it matches any of the provided pairs. + Properties map[string]*string `type:"map"` + + // Filter the lineage entities connected to the StartArn by type. For example: + // DataSet, Model, Endpoint, or ModelDeployment. + Types []*string `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 QueryFilters) 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 QueryFilters) GoString() string { + return s.String() +} + +// SetCreatedAfter sets the CreatedAfter field's value. +func (s *QueryFilters) SetCreatedAfter(v time.Time) *QueryFilters { + s.CreatedAfter = &v + return s +} + +// SetCreatedBefore sets the CreatedBefore field's value. +func (s *QueryFilters) SetCreatedBefore(v time.Time) *QueryFilters { + s.CreatedBefore = &v + return s +} + +// SetLineageTypes sets the LineageTypes field's value. +func (s *QueryFilters) SetLineageTypes(v []*string) *QueryFilters { + s.LineageTypes = v + return s +} + +// SetModifiedAfter sets the ModifiedAfter field's value. +func (s *QueryFilters) SetModifiedAfter(v time.Time) *QueryFilters { + s.ModifiedAfter = &v + return s +} + +// SetModifiedBefore sets the ModifiedBefore field's value. +func (s *QueryFilters) SetModifiedBefore(v time.Time) *QueryFilters { + s.ModifiedBefore = &v + return s +} + +// SetProperties sets the Properties field's value. +func (s *QueryFilters) SetProperties(v map[string]*string) *QueryFilters { + s.Properties = v + return s +} + +// SetTypes sets the Types field's value. +func (s *QueryFilters) SetTypes(v []*string) *QueryFilters { + s.Types = v + return s +} + +type QueryLineageInput struct { + _ struct{} `type:"structure"` + + // Associations between lineage entities are directed. This parameter determines + // the direction from the StartArn(s) the query will look. + Direction *string `type:"string" enum:"Direction"` + + // A set of filtering parameters that allow you to specify which entities should + // be returned. + // + // * Properties - Key-value pairs to match on the lineage entities' properties. + // + // * LineageTypes - A set of lineage entity types to match on. For example: + // TrialComponent, Artifact, or Context. + // + // * CreatedBefore - Filter entities created before this date. + // + // * ModifiedBefore - Filter entities modified before this date. + // + // * ModifiedAfter - Filter entities modified after this date. + Filters *QueryFilters `type:"structure"` + + // Setting this value to True will retrieve not only the entities of interest + // but also the Associations (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) + // and lineage entities on the path. Set to False to only return lineage entities + // that match your query. + IncludeEdges *bool `type:"boolean"` + + // The maximum depth in lineage relationships from the StartArns that will be + // traversed. Depth is a measure of the number of Associations from the StartArn + // entity to the matched results. + MaxDepth *int64 `type:"integer"` + + // Limits the number of vertices in the results. Use the NextToken in a response + // to to retrieve the next page of results. + MaxResults *int64 `type:"integer"` + + // Limits the number of vertices in the request. Use the NextToken in a response + // to to retrieve the next page of results. + NextToken *string `type:"string"` + + // A list of resource Amazon Resource Name (ARN) that represent the starting + // point for your lineage query. + // + // StartArns is a required field + StartArns []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s QueryLineageInput) 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 QueryLineageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *QueryLineageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "QueryLineageInput"} + if s.StartArns == nil { + invalidParams.Add(request.NewErrParamRequired("StartArns")) + } + if s.StartArns != nil && len(s.StartArns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StartArns", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDirection sets the Direction field's value. +func (s *QueryLineageInput) SetDirection(v string) *QueryLineageInput { + s.Direction = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *QueryLineageInput) SetFilters(v *QueryFilters) *QueryLineageInput { + s.Filters = v + return s +} + +// SetIncludeEdges sets the IncludeEdges field's value. +func (s *QueryLineageInput) SetIncludeEdges(v bool) *QueryLineageInput { + s.IncludeEdges = &v + return s +} + +// SetMaxDepth sets the MaxDepth field's value. +func (s *QueryLineageInput) SetMaxDepth(v int64) *QueryLineageInput { + s.MaxDepth = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *QueryLineageInput) SetMaxResults(v int64) *QueryLineageInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *QueryLineageInput) SetNextToken(v string) *QueryLineageInput { + s.NextToken = &v + return s +} + +// SetStartArns sets the StartArns field's value. +func (s *QueryLineageInput) SetStartArns(v []*string) *QueryLineageInput { + s.StartArns = v + return s +} + +type QueryLineageOutput struct { + _ struct{} `type:"structure"` + + // A list of edges that connect vertices in the response. + Edges []*Edge `type:"list"` + + // Limits the number of vertices in the response. Use the NextToken in a response + // to to retrieve the next page of results. + NextToken *string `type:"string"` + + // A list of vertices connected to the start entity(ies) in the lineage graph. + Vertices []*Vertex `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 QueryLineageOutput) 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 QueryLineageOutput) GoString() string { + return s.String() +} + +// SetEdges sets the Edges field's value. +func (s *QueryLineageOutput) SetEdges(v []*Edge) *QueryLineageOutput { + s.Edges = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *QueryLineageOutput) SetNextToken(v string) *QueryLineageOutput { + s.NextToken = &v + return s +} + +// SetVertices sets the Vertices field's value. +func (s *QueryLineageOutput) SetVertices(v []*Vertex) *QueryLineageOutput { + s.Vertices = v + return s +} + // A collection of settings that apply to an RSessionGateway app. type RSessionAppSettings struct { _ struct{} `type:"structure"` @@ -76247,6 +80800,301 @@ func (s *RStudioServerProDomainSettingsForUpdate) SetDomainExecutionRoleArn(v st return s } +// The input configuration of the recommendation job. +type RecommendationJobInputConfig struct { + _ struct{} `type:"structure"` + + // Specifies the endpoint configuration to use for a job. + EndpointConfigurations []*EndpointInputConfiguration `min:"1" type:"list"` + + // Specifies the maximum duration of the job, in seconds.> + JobDurationInSeconds *int64 `min:"1" type:"integer"` + + // The Amazon Resource Name (ARN) of a versioned model package. + // + // ModelPackageVersionArn is a required field + ModelPackageVersionArn *string `min:"1" type:"string" required:"true"` + + // Defines the resource limit of the job. + ResourceLimit *RecommendationJobResourceLimit `type:"structure"` + + // Specifies the traffic pattern of the job. + TrafficPattern *TrafficPattern `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 RecommendationJobInputConfig) 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 RecommendationJobInputConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RecommendationJobInputConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RecommendationJobInputConfig"} + if s.EndpointConfigurations != nil && len(s.EndpointConfigurations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EndpointConfigurations", 1)) + } + if s.JobDurationInSeconds != nil && *s.JobDurationInSeconds < 1 { + invalidParams.Add(request.NewErrParamMinValue("JobDurationInSeconds", 1)) + } + if s.ModelPackageVersionArn == nil { + invalidParams.Add(request.NewErrParamRequired("ModelPackageVersionArn")) + } + if s.ModelPackageVersionArn != nil && len(*s.ModelPackageVersionArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelPackageVersionArn", 1)) + } + if s.EndpointConfigurations != nil { + for i, v := range s.EndpointConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "EndpointConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ResourceLimit != nil { + if err := s.ResourceLimit.Validate(); err != nil { + invalidParams.AddNested("ResourceLimit", err.(request.ErrInvalidParams)) + } + } + if s.TrafficPattern != nil { + if err := s.TrafficPattern.Validate(); err != nil { + invalidParams.AddNested("TrafficPattern", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndpointConfigurations sets the EndpointConfigurations field's value. +func (s *RecommendationJobInputConfig) SetEndpointConfigurations(v []*EndpointInputConfiguration) *RecommendationJobInputConfig { + s.EndpointConfigurations = v + return s +} + +// SetJobDurationInSeconds sets the JobDurationInSeconds field's value. +func (s *RecommendationJobInputConfig) SetJobDurationInSeconds(v int64) *RecommendationJobInputConfig { + s.JobDurationInSeconds = &v + return s +} + +// SetModelPackageVersionArn sets the ModelPackageVersionArn field's value. +func (s *RecommendationJobInputConfig) SetModelPackageVersionArn(v string) *RecommendationJobInputConfig { + s.ModelPackageVersionArn = &v + return s +} + +// SetResourceLimit sets the ResourceLimit field's value. +func (s *RecommendationJobInputConfig) SetResourceLimit(v *RecommendationJobResourceLimit) *RecommendationJobInputConfig { + s.ResourceLimit = v + return s +} + +// SetTrafficPattern sets the TrafficPattern field's value. +func (s *RecommendationJobInputConfig) SetTrafficPattern(v *TrafficPattern) *RecommendationJobInputConfig { + s.TrafficPattern = v + return s +} + +// Specifies the maximum number of jobs that can run in parallel and the maximum +// number of jobs that can run. +type RecommendationJobResourceLimit struct { + _ struct{} `type:"structure"` + + // Defines the maximum number of load tests. + MaxNumberOfTests *int64 `min:"1" type:"integer"` + + // Defines the maximum number of parallel load tests. + MaxParallelOfTests *int64 `min:"1" 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 RecommendationJobResourceLimit) 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 RecommendationJobResourceLimit) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RecommendationJobResourceLimit) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RecommendationJobResourceLimit"} + if s.MaxNumberOfTests != nil && *s.MaxNumberOfTests < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxNumberOfTests", 1)) + } + if s.MaxParallelOfTests != nil && *s.MaxParallelOfTests < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxParallelOfTests", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxNumberOfTests sets the MaxNumberOfTests field's value. +func (s *RecommendationJobResourceLimit) SetMaxNumberOfTests(v int64) *RecommendationJobResourceLimit { + s.MaxNumberOfTests = &v + return s +} + +// SetMaxParallelOfTests sets the MaxParallelOfTests field's value. +func (s *RecommendationJobResourceLimit) SetMaxParallelOfTests(v int64) *RecommendationJobResourceLimit { + s.MaxParallelOfTests = &v + return s +} + +// Specifies conditions for stopping a job. When a job reaches a stopping condition +// limit, SageMaker ends the job. +type RecommendationJobStoppingConditions struct { + _ struct{} `type:"structure"` + + // The maximum number of requests per minute expected for the endpoint. + MaxInvocations *int64 `type:"integer"` + + // The interval of time taken by a model to respond as viewed from SageMaker. + // The interval includes the local communication time taken to send the request + // and to fetch the response from the container of a model and the time taken + // to complete the inference in the container. + ModelLatencyThresholds []*ModelLatencyThreshold `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 RecommendationJobStoppingConditions) 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 RecommendationJobStoppingConditions) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RecommendationJobStoppingConditions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RecommendationJobStoppingConditions"} + if s.ModelLatencyThresholds != nil && len(s.ModelLatencyThresholds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelLatencyThresholds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxInvocations sets the MaxInvocations field's value. +func (s *RecommendationJobStoppingConditions) SetMaxInvocations(v int64) *RecommendationJobStoppingConditions { + s.MaxInvocations = &v + return s +} + +// SetModelLatencyThresholds sets the ModelLatencyThresholds field's value. +func (s *RecommendationJobStoppingConditions) SetModelLatencyThresholds(v []*ModelLatencyThreshold) *RecommendationJobStoppingConditions { + s.ModelLatencyThresholds = v + return s +} + +// The metrics of recommendations. +type RecommendationMetrics struct { + _ struct{} `type:"structure"` + + // Defines the cost per hour for the instance. + // + // CostPerHour is a required field + CostPerHour *float64 `type:"float" required:"true"` + + // Defines the cost per inference for the instance . + // + // CostPerInference is a required field + CostPerInference *float64 `type:"float" required:"true"` + + // The expected maximum number of requests per minute for the instance. + // + // MaxInvocations is a required field + MaxInvocations *int64 `type:"integer" required:"true"` + + // The expected model latency at maximum invocation per minute for the instance. + // + // ModelLatency is a required field + ModelLatency *int64 `type:"integer" 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 RecommendationMetrics) 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 RecommendationMetrics) GoString() string { + return s.String() +} + +// SetCostPerHour sets the CostPerHour field's value. +func (s *RecommendationMetrics) SetCostPerHour(v float64) *RecommendationMetrics { + s.CostPerHour = &v + return s +} + +// SetCostPerInference sets the CostPerInference field's value. +func (s *RecommendationMetrics) SetCostPerInference(v float64) *RecommendationMetrics { + s.CostPerInference = &v + return s +} + +// SetMaxInvocations sets the MaxInvocations field's value. +func (s *RecommendationMetrics) SetMaxInvocations(v int64) *RecommendationMetrics { + s.MaxInvocations = &v + return s +} + +// SetModelLatency sets the ModelLatency field's value. +func (s *RecommendationMetrics) SetModelLatency(v int64) *RecommendationMetrics { + s.ModelLatency = &v + return s +} + // Configuration for Redshift Dataset Definition input. type RedshiftDatasetDefinition struct { _ struct{} `type:"structure"` @@ -79669,6 +84517,77 @@ func (s StopHyperParameterTuningJobOutput) GoString() string { return s.String() } +type StopInferenceRecommendationsJobInput struct { + _ struct{} `type:"structure"` + + // The name of the job you want to stop. + // + // JobName is a required field + JobName *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 StopInferenceRecommendationsJobInput) 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 StopInferenceRecommendationsJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopInferenceRecommendationsJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopInferenceRecommendationsJobInput"} + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobName sets the JobName field's value. +func (s *StopInferenceRecommendationsJobInput) SetJobName(v string) *StopInferenceRecommendationsJobInput { + s.JobName = &v + return s +} + +type StopInferenceRecommendationsJobOutput 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 StopInferenceRecommendationsJobOutput) 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 StopInferenceRecommendationsJobOutput) GoString() string { + return s.String() +} + type StopLabelingJobInput struct { _ struct{} `type:"structure"` @@ -80725,6 +85644,70 @@ func (s *TensorBoardOutputConfig) SetS3OutputPath(v string) *TensorBoardOutputCo return s } +// Defines the traffic pattern of the load test. +type TrafficPattern struct { + _ struct{} `type:"structure"` + + // Defines the phases traffic specification. + Phases []*Phase `min:"1" type:"list"` + + // Defines the traffic patterns. + TrafficType *string `type:"string" enum:"TrafficType"` +} + +// 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 TrafficPattern) 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 TrafficPattern) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TrafficPattern) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TrafficPattern"} + if s.Phases != nil && len(s.Phases) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Phases", 1)) + } + if s.Phases != nil { + for i, v := range s.Phases { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Phases", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPhases sets the Phases field's value. +func (s *TrafficPattern) SetPhases(v []*Phase) *TrafficPattern { + s.Phases = v + return s +} + +// SetTrafficType sets the TrafficType field's value. +func (s *TrafficPattern) SetTrafficType(v string) *TrafficPattern { + s.TrafficType = &v + return s +} + // Defines the traffic routing strategy during an endpoint deployment to shift // traffic from the old fleet to the new fleet. type TrafficRoutingConfig struct { @@ -82851,7 +87834,7 @@ type Trial struct { ExperimentName *string `min:"1" type:"string"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // Who last modified the trial. @@ -82989,12 +87972,15 @@ type TrialComponent struct { InputArtifacts map[string]*TrialComponentArtifact `type:"map"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` // When the component was last modified. LastModifiedTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the lineage group resource. + LineageGroupArn *string `type:"string"` + // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *MetadataProperties `type:"structure"` @@ -83095,6 +88081,12 @@ func (s *TrialComponent) SetLastModifiedTime(v time.Time) *TrialComponent { return s } +// SetLineageGroupArn sets the LineageGroupArn field's value. +func (s *TrialComponent) SetLineageGroupArn(v string) *TrialComponent { + s.LineageGroupArn = &v + return s +} + // SetMetadataProperties sets the MetadataProperties field's value. func (s *TrialComponent) SetMetadataProperties(v *MetadataProperties) *TrialComponent { s.MetadataProperties = v @@ -83387,7 +88379,7 @@ type TrialComponentSimpleSummary struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // trial component, or project. + // trial component, lineage group, or project. CreatedBy *UserContext `type:"structure"` // When the component was created. @@ -85506,6 +90498,13 @@ func (s *UpdateImageOutput) SetImageArn(v string) *UpdateImageOutput { type UpdateModelPackageInput struct { _ struct{} `type:"structure"` + // An array of additional Inference Specification objects to be added to the + // existing array additional Inference Specification. Total number of additional + // Inference Specifications can not exceed 15. Each additional Inference Specification + // specifies artifacts based on this model package that can be used on inference + // endpoints. Generally used with SageMaker Neo to store the compiled artifacts. + AdditionalInferenceSpecificationsToAdd []*AdditionalInferenceSpecificationDefinition `min:"1" type:"list"` + // A description for the approval status of the model. ApprovalDescription *string `type:"string"` @@ -85545,6 +90544,9 @@ func (s UpdateModelPackageInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *UpdateModelPackageInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "UpdateModelPackageInput"} + if s.AdditionalInferenceSpecificationsToAdd != nil && len(s.AdditionalInferenceSpecificationsToAdd) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AdditionalInferenceSpecificationsToAdd", 1)) + } if s.CustomerMetadataProperties != nil && len(s.CustomerMetadataProperties) < 1 { invalidParams.Add(request.NewErrParamMinLen("CustomerMetadataProperties", 1)) } @@ -85554,6 +90556,16 @@ func (s *UpdateModelPackageInput) Validate() error { if s.ModelPackageArn != nil && len(*s.ModelPackageArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("ModelPackageArn", 1)) } + if s.AdditionalInferenceSpecificationsToAdd != nil { + for i, v := range s.AdditionalInferenceSpecificationsToAdd { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AdditionalInferenceSpecificationsToAdd", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -85561,6 +90573,12 @@ func (s *UpdateModelPackageInput) Validate() error { return nil } +// SetAdditionalInferenceSpecificationsToAdd sets the AdditionalInferenceSpecificationsToAdd field's value. +func (s *UpdateModelPackageInput) SetAdditionalInferenceSpecificationsToAdd(v []*AdditionalInferenceSpecificationDefinition) *UpdateModelPackageInput { + s.AdditionalInferenceSpecificationsToAdd = v + return s +} + // SetApprovalDescription sets the ApprovalDescription field's value. func (s *UpdateModelPackageInput) SetApprovalDescription(v string) *UpdateModelPackageInput { s.ApprovalDescription = &v @@ -87188,7 +92206,7 @@ func (s *UpdateWorkteamOutput) SetWorkteam(v *Workteam) *UpdateWorkteamOutput { } // Information about the user who created or modified an experiment, trial, -// trial component, or project. +// trial component, lineage group, or project. type UserContext struct { _ struct{} `type:"structure"` @@ -87494,6 +92512,57 @@ func (s *VariantProperty) SetVariantPropertyType(v string) *VariantProperty { return s } +// A lineage entity connected to the starting entity(ies). +type Vertex struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the lineage entity resource. + Arn *string `type:"string"` + + // The type of resource of the lineage entity. + LineageType *string `type:"string" enum:"LineageType"` + + // The type of the lineage entity resource. For example: DataSet, Model, Endpoint, + // etc... + Type *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Vertex) 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 Vertex) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Vertex) SetArn(v string) *Vertex { + s.Arn = &v + return s +} + +// SetLineageType sets the LineageType field's value. +func (s *Vertex) SetLineageType(v string) *Vertex { + s.LineageType = &v + return s +} + +// SetType sets the Type field's value. +func (s *Vertex) SetType(v string) *Vertex { + s.Type = &v + return s +} + // Specifies a VPC that your training jobs and hosted models have access to. // Control access to and from your training and model containers by configuring // the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual @@ -88903,6 +93972,26 @@ func DirectInternetAccess_Values() []string { } } +const ( + // DirectionBoth is a Direction enum value + DirectionBoth = "Both" + + // DirectionAscendants is a Direction enum value + DirectionAscendants = "Ascendants" + + // DirectionDescendants is a Direction enum value + DirectionDescendants = "Descendants" +) + +// Direction_Values returns all elements of the Direction enum +func Direction_Values() []string { + return []string{ + DirectionBoth, + DirectionAscendants, + DirectionDescendants, + } +} + const ( // DomainStatusDeleting is a DomainStatus enum value DomainStatusDeleting = "Deleting" @@ -89905,6 +94994,30 @@ func LabelingJobStatus_Values() []string { } } +const ( + // LineageTypeTrialComponent is a LineageType enum value + LineageTypeTrialComponent = "TrialComponent" + + // LineageTypeArtifact is a LineageType enum value + LineageTypeArtifact = "Artifact" + + // LineageTypeContext is a LineageType enum value + LineageTypeContext = "Context" + + // LineageTypeAction is a LineageType enum value + LineageTypeAction = "Action" +) + +// LineageType_Values returns all elements of the LineageType enum +func LineageType_Values() []string { + return []string{ + LineageTypeTrialComponent, + LineageTypeArtifact, + LineageTypeContext, + LineageTypeAction, + } +} + const ( // ListCompilationJobsSortByName is a ListCompilationJobsSortBy enum value ListCompilationJobsSortByName = "Name" @@ -89973,6 +95086,26 @@ func ListEdgePackagingJobsSortBy_Values() []string { } } +const ( + // ListInferenceRecommendationsJobsSortByName is a ListInferenceRecommendationsJobsSortBy enum value + ListInferenceRecommendationsJobsSortByName = "Name" + + // ListInferenceRecommendationsJobsSortByCreationTime is a ListInferenceRecommendationsJobsSortBy enum value + ListInferenceRecommendationsJobsSortByCreationTime = "CreationTime" + + // ListInferenceRecommendationsJobsSortByStatus is a ListInferenceRecommendationsJobsSortBy enum value + ListInferenceRecommendationsJobsSortByStatus = "Status" +) + +// ListInferenceRecommendationsJobsSortBy_Values returns all elements of the ListInferenceRecommendationsJobsSortBy enum +func ListInferenceRecommendationsJobsSortBy_Values() []string { + return []string{ + ListInferenceRecommendationsJobsSortByName, + ListInferenceRecommendationsJobsSortByCreationTime, + ListInferenceRecommendationsJobsSortByStatus, + } +} + const ( // ListLabelingJobsForWorkteamSortByOptionsCreationTime is a ListLabelingJobsForWorkteamSortByOptions enum value ListLabelingJobsForWorkteamSortByOptionsCreationTime = "CreationTime" @@ -90073,6 +95206,30 @@ func ModelCacheSetting_Values() []string { } } +const ( + // ModelMetadataFilterTypeDomain is a ModelMetadataFilterType enum value + ModelMetadataFilterTypeDomain = "Domain" + + // ModelMetadataFilterTypeFramework is a ModelMetadataFilterType enum value + ModelMetadataFilterTypeFramework = "Framework" + + // ModelMetadataFilterTypeTask is a ModelMetadataFilterType enum value + ModelMetadataFilterTypeTask = "Task" + + // ModelMetadataFilterTypeFrameworkVersion is a ModelMetadataFilterType enum value + ModelMetadataFilterTypeFrameworkVersion = "FrameworkVersion" +) + +// ModelMetadataFilterType_Values returns all elements of the ModelMetadataFilterType enum +func ModelMetadataFilterType_Values() []string { + return []string{ + ModelMetadataFilterTypeDomain, + ModelMetadataFilterTypeFramework, + ModelMetadataFilterTypeTask, + ModelMetadataFilterTypeFrameworkVersion, + } +} + const ( // ModelPackageGroupSortByName is a ModelPackageGroupSortBy enum value ModelPackageGroupSortByName = "Name" @@ -91369,6 +96526,54 @@ func RStudioServerProUserGroup_Values() []string { } } +const ( + // RecommendationJobStatusPending is a RecommendationJobStatus enum value + RecommendationJobStatusPending = "PENDING" + + // RecommendationJobStatusInProgress is a RecommendationJobStatus enum value + RecommendationJobStatusInProgress = "IN_PROGRESS" + + // RecommendationJobStatusCompleted is a RecommendationJobStatus enum value + RecommendationJobStatusCompleted = "COMPLETED" + + // RecommendationJobStatusFailed is a RecommendationJobStatus enum value + RecommendationJobStatusFailed = "FAILED" + + // RecommendationJobStatusStopping is a RecommendationJobStatus enum value + RecommendationJobStatusStopping = "STOPPING" + + // RecommendationJobStatusStopped is a RecommendationJobStatus enum value + RecommendationJobStatusStopped = "STOPPED" +) + +// RecommendationJobStatus_Values returns all elements of the RecommendationJobStatus enum +func RecommendationJobStatus_Values() []string { + return []string{ + RecommendationJobStatusPending, + RecommendationJobStatusInProgress, + RecommendationJobStatusCompleted, + RecommendationJobStatusFailed, + RecommendationJobStatusStopping, + RecommendationJobStatusStopped, + } +} + +const ( + // RecommendationJobTypeDefault is a RecommendationJobType enum value + RecommendationJobTypeDefault = "Default" + + // RecommendationJobTypeAdvanced is a RecommendationJobType enum value + RecommendationJobTypeAdvanced = "Advanced" +) + +// RecommendationJobType_Values returns all elements of the RecommendationJobType enum +func RecommendationJobType_Values() []string { + return []string{ + RecommendationJobTypeDefault, + RecommendationJobTypeAdvanced, + } +} + const ( // RecordWrapperNone is a RecordWrapper enum value RecordWrapperNone = "None" @@ -91835,6 +97040,22 @@ func SortExperimentsBy_Values() []string { } } +const ( + // SortLineageGroupsByName is a SortLineageGroupsBy enum value + SortLineageGroupsByName = "Name" + + // SortLineageGroupsByCreationTime is a SortLineageGroupsBy enum value + SortLineageGroupsByCreationTime = "CreationTime" +) + +// SortLineageGroupsBy_Values returns all elements of the SortLineageGroupsBy enum +func SortLineageGroupsBy_Values() []string { + return []string{ + SortLineageGroupsByName, + SortLineageGroupsByCreationTime, + } +} + const ( // SortOrderAscending is a SortOrder enum value SortOrderAscending = "Ascending" @@ -92223,6 +97444,18 @@ func TrafficRoutingConfigType_Values() []string { } } +const ( + // TrafficTypePhases is a TrafficType enum value + TrafficTypePhases = "PHASES" +) + +// TrafficType_Values returns all elements of the TrafficType enum +func TrafficType_Values() []string { + return []string{ + TrafficTypePhases, + } +} + // The training input mode that the algorithm supports. For more information // about input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). // diff --git a/service/sagemaker/sagemakeriface/interface.go b/service/sagemaker/sagemakeriface/interface.go index c078bca4900..46c79e6e5a6 100644 --- a/service/sagemaker/sagemakeriface/interface.go +++ b/service/sagemaker/sagemakeriface/interface.go @@ -164,6 +164,10 @@ type SageMakerAPI interface { CreateImageVersionWithContext(aws.Context, *sagemaker.CreateImageVersionInput, ...request.Option) (*sagemaker.CreateImageVersionOutput, error) CreateImageVersionRequest(*sagemaker.CreateImageVersionInput) (*request.Request, *sagemaker.CreateImageVersionOutput) + CreateInferenceRecommendationsJob(*sagemaker.CreateInferenceRecommendationsJobInput) (*sagemaker.CreateInferenceRecommendationsJobOutput, error) + CreateInferenceRecommendationsJobWithContext(aws.Context, *sagemaker.CreateInferenceRecommendationsJobInput, ...request.Option) (*sagemaker.CreateInferenceRecommendationsJobOutput, error) + CreateInferenceRecommendationsJobRequest(*sagemaker.CreateInferenceRecommendationsJobInput) (*request.Request, *sagemaker.CreateInferenceRecommendationsJobOutput) + CreateLabelingJob(*sagemaker.CreateLabelingJobInput) (*sagemaker.CreateLabelingJobOutput, error) CreateLabelingJobWithContext(aws.Context, *sagemaker.CreateLabelingJobInput, ...request.Option) (*sagemaker.CreateLabelingJobOutput, error) CreateLabelingJobRequest(*sagemaker.CreateLabelingJobInput) (*request.Request, *sagemaker.CreateLabelingJobOutput) @@ -504,10 +508,18 @@ type SageMakerAPI interface { DescribeImageVersionWithContext(aws.Context, *sagemaker.DescribeImageVersionInput, ...request.Option) (*sagemaker.DescribeImageVersionOutput, error) DescribeImageVersionRequest(*sagemaker.DescribeImageVersionInput) (*request.Request, *sagemaker.DescribeImageVersionOutput) + DescribeInferenceRecommendationsJob(*sagemaker.DescribeInferenceRecommendationsJobInput) (*sagemaker.DescribeInferenceRecommendationsJobOutput, error) + DescribeInferenceRecommendationsJobWithContext(aws.Context, *sagemaker.DescribeInferenceRecommendationsJobInput, ...request.Option) (*sagemaker.DescribeInferenceRecommendationsJobOutput, error) + DescribeInferenceRecommendationsJobRequest(*sagemaker.DescribeInferenceRecommendationsJobInput) (*request.Request, *sagemaker.DescribeInferenceRecommendationsJobOutput) + DescribeLabelingJob(*sagemaker.DescribeLabelingJobInput) (*sagemaker.DescribeLabelingJobOutput, error) DescribeLabelingJobWithContext(aws.Context, *sagemaker.DescribeLabelingJobInput, ...request.Option) (*sagemaker.DescribeLabelingJobOutput, error) DescribeLabelingJobRequest(*sagemaker.DescribeLabelingJobInput) (*request.Request, *sagemaker.DescribeLabelingJobOutput) + DescribeLineageGroup(*sagemaker.DescribeLineageGroupInput) (*sagemaker.DescribeLineageGroupOutput, error) + DescribeLineageGroupWithContext(aws.Context, *sagemaker.DescribeLineageGroupInput, ...request.Option) (*sagemaker.DescribeLineageGroupOutput, error) + DescribeLineageGroupRequest(*sagemaker.DescribeLineageGroupInput) (*request.Request, *sagemaker.DescribeLineageGroupOutput) + DescribeModel(*sagemaker.DescribeModelInput) (*sagemaker.DescribeModelOutput, error) DescribeModelWithContext(aws.Context, *sagemaker.DescribeModelInput, ...request.Option) (*sagemaker.DescribeModelOutput, error) DescribeModelRequest(*sagemaker.DescribeModelInput) (*request.Request, *sagemaker.DescribeModelOutput) @@ -616,6 +628,10 @@ type SageMakerAPI interface { GetDeviceFleetReportWithContext(aws.Context, *sagemaker.GetDeviceFleetReportInput, ...request.Option) (*sagemaker.GetDeviceFleetReportOutput, error) GetDeviceFleetReportRequest(*sagemaker.GetDeviceFleetReportInput) (*request.Request, *sagemaker.GetDeviceFleetReportOutput) + GetLineageGroupPolicy(*sagemaker.GetLineageGroupPolicyInput) (*sagemaker.GetLineageGroupPolicyOutput, error) + GetLineageGroupPolicyWithContext(aws.Context, *sagemaker.GetLineageGroupPolicyInput, ...request.Option) (*sagemaker.GetLineageGroupPolicyOutput, error) + GetLineageGroupPolicyRequest(*sagemaker.GetLineageGroupPolicyInput) (*request.Request, *sagemaker.GetLineageGroupPolicyOutput) + GetModelPackageGroupPolicy(*sagemaker.GetModelPackageGroupPolicyInput) (*sagemaker.GetModelPackageGroupPolicyOutput, error) GetModelPackageGroupPolicyWithContext(aws.Context, *sagemaker.GetModelPackageGroupPolicyInput, ...request.Option) (*sagemaker.GetModelPackageGroupPolicyOutput, error) GetModelPackageGroupPolicyRequest(*sagemaker.GetModelPackageGroupPolicyInput) (*request.Request, *sagemaker.GetModelPackageGroupPolicyOutput) @@ -803,6 +819,13 @@ type SageMakerAPI interface { ListImagesPages(*sagemaker.ListImagesInput, func(*sagemaker.ListImagesOutput, bool) bool) error ListImagesPagesWithContext(aws.Context, *sagemaker.ListImagesInput, func(*sagemaker.ListImagesOutput, bool) bool, ...request.Option) error + ListInferenceRecommendationsJobs(*sagemaker.ListInferenceRecommendationsJobsInput) (*sagemaker.ListInferenceRecommendationsJobsOutput, error) + ListInferenceRecommendationsJobsWithContext(aws.Context, *sagemaker.ListInferenceRecommendationsJobsInput, ...request.Option) (*sagemaker.ListInferenceRecommendationsJobsOutput, error) + ListInferenceRecommendationsJobsRequest(*sagemaker.ListInferenceRecommendationsJobsInput) (*request.Request, *sagemaker.ListInferenceRecommendationsJobsOutput) + + ListInferenceRecommendationsJobsPages(*sagemaker.ListInferenceRecommendationsJobsInput, func(*sagemaker.ListInferenceRecommendationsJobsOutput, bool) bool) error + ListInferenceRecommendationsJobsPagesWithContext(aws.Context, *sagemaker.ListInferenceRecommendationsJobsInput, func(*sagemaker.ListInferenceRecommendationsJobsOutput, bool) bool, ...request.Option) error + ListLabelingJobs(*sagemaker.ListLabelingJobsInput) (*sagemaker.ListLabelingJobsOutput, error) ListLabelingJobsWithContext(aws.Context, *sagemaker.ListLabelingJobsInput, ...request.Option) (*sagemaker.ListLabelingJobsOutput, error) ListLabelingJobsRequest(*sagemaker.ListLabelingJobsInput) (*request.Request, *sagemaker.ListLabelingJobsOutput) @@ -817,6 +840,13 @@ type SageMakerAPI interface { ListLabelingJobsForWorkteamPages(*sagemaker.ListLabelingJobsForWorkteamInput, func(*sagemaker.ListLabelingJobsForWorkteamOutput, bool) bool) error ListLabelingJobsForWorkteamPagesWithContext(aws.Context, *sagemaker.ListLabelingJobsForWorkteamInput, func(*sagemaker.ListLabelingJobsForWorkteamOutput, bool) bool, ...request.Option) error + ListLineageGroups(*sagemaker.ListLineageGroupsInput) (*sagemaker.ListLineageGroupsOutput, error) + ListLineageGroupsWithContext(aws.Context, *sagemaker.ListLineageGroupsInput, ...request.Option) (*sagemaker.ListLineageGroupsOutput, error) + ListLineageGroupsRequest(*sagemaker.ListLineageGroupsInput) (*request.Request, *sagemaker.ListLineageGroupsOutput) + + ListLineageGroupsPages(*sagemaker.ListLineageGroupsInput, func(*sagemaker.ListLineageGroupsOutput, bool) bool) error + ListLineageGroupsPagesWithContext(aws.Context, *sagemaker.ListLineageGroupsInput, func(*sagemaker.ListLineageGroupsOutput, bool) bool, ...request.Option) error + ListModelBiasJobDefinitions(*sagemaker.ListModelBiasJobDefinitionsInput) (*sagemaker.ListModelBiasJobDefinitionsOutput, error) ListModelBiasJobDefinitionsWithContext(aws.Context, *sagemaker.ListModelBiasJobDefinitionsInput, ...request.Option) (*sagemaker.ListModelBiasJobDefinitionsOutput, error) ListModelBiasJobDefinitionsRequest(*sagemaker.ListModelBiasJobDefinitionsInput) (*request.Request, *sagemaker.ListModelBiasJobDefinitionsOutput) @@ -831,6 +861,13 @@ type SageMakerAPI interface { ListModelExplainabilityJobDefinitionsPages(*sagemaker.ListModelExplainabilityJobDefinitionsInput, func(*sagemaker.ListModelExplainabilityJobDefinitionsOutput, bool) bool) error ListModelExplainabilityJobDefinitionsPagesWithContext(aws.Context, *sagemaker.ListModelExplainabilityJobDefinitionsInput, func(*sagemaker.ListModelExplainabilityJobDefinitionsOutput, bool) bool, ...request.Option) error + ListModelMetadata(*sagemaker.ListModelMetadataInput) (*sagemaker.ListModelMetadataOutput, error) + ListModelMetadataWithContext(aws.Context, *sagemaker.ListModelMetadataInput, ...request.Option) (*sagemaker.ListModelMetadataOutput, error) + ListModelMetadataRequest(*sagemaker.ListModelMetadataInput) (*request.Request, *sagemaker.ListModelMetadataOutput) + + ListModelMetadataPages(*sagemaker.ListModelMetadataInput, func(*sagemaker.ListModelMetadataOutput, bool) bool) error + ListModelMetadataPagesWithContext(aws.Context, *sagemaker.ListModelMetadataInput, func(*sagemaker.ListModelMetadataOutput, bool) bool, ...request.Option) error + ListModelPackageGroups(*sagemaker.ListModelPackageGroupsInput) (*sagemaker.ListModelPackageGroupsOutput, error) ListModelPackageGroupsWithContext(aws.Context, *sagemaker.ListModelPackageGroupsInput, ...request.Option) (*sagemaker.ListModelPackageGroupsOutput, error) ListModelPackageGroupsRequest(*sagemaker.ListModelPackageGroupsInput) (*request.Request, *sagemaker.ListModelPackageGroupsOutput) @@ -1010,6 +1047,13 @@ type SageMakerAPI interface { PutModelPackageGroupPolicyWithContext(aws.Context, *sagemaker.PutModelPackageGroupPolicyInput, ...request.Option) (*sagemaker.PutModelPackageGroupPolicyOutput, error) PutModelPackageGroupPolicyRequest(*sagemaker.PutModelPackageGroupPolicyInput) (*request.Request, *sagemaker.PutModelPackageGroupPolicyOutput) + QueryLineage(*sagemaker.QueryLineageInput) (*sagemaker.QueryLineageOutput, error) + QueryLineageWithContext(aws.Context, *sagemaker.QueryLineageInput, ...request.Option) (*sagemaker.QueryLineageOutput, error) + QueryLineageRequest(*sagemaker.QueryLineageInput) (*request.Request, *sagemaker.QueryLineageOutput) + + QueryLineagePages(*sagemaker.QueryLineageInput, func(*sagemaker.QueryLineageOutput, bool) bool) error + QueryLineagePagesWithContext(aws.Context, *sagemaker.QueryLineageInput, func(*sagemaker.QueryLineageOutput, bool) bool, ...request.Option) error + RegisterDevices(*sagemaker.RegisterDevicesInput) (*sagemaker.RegisterDevicesOutput, error) RegisterDevicesWithContext(aws.Context, *sagemaker.RegisterDevicesInput, ...request.Option) (*sagemaker.RegisterDevicesOutput, error) RegisterDevicesRequest(*sagemaker.RegisterDevicesInput) (*request.Request, *sagemaker.RegisterDevicesOutput) @@ -1065,6 +1109,10 @@ type SageMakerAPI interface { StopHyperParameterTuningJobWithContext(aws.Context, *sagemaker.StopHyperParameterTuningJobInput, ...request.Option) (*sagemaker.StopHyperParameterTuningJobOutput, error) StopHyperParameterTuningJobRequest(*sagemaker.StopHyperParameterTuningJobInput) (*request.Request, *sagemaker.StopHyperParameterTuningJobOutput) + StopInferenceRecommendationsJob(*sagemaker.StopInferenceRecommendationsJobInput) (*sagemaker.StopInferenceRecommendationsJobOutput, error) + StopInferenceRecommendationsJobWithContext(aws.Context, *sagemaker.StopInferenceRecommendationsJobInput, ...request.Option) (*sagemaker.StopInferenceRecommendationsJobOutput, error) + StopInferenceRecommendationsJobRequest(*sagemaker.StopInferenceRecommendationsJobInput) (*request.Request, *sagemaker.StopInferenceRecommendationsJobOutput) + StopLabelingJob(*sagemaker.StopLabelingJobInput) (*sagemaker.StopLabelingJobOutput, error) StopLabelingJobWithContext(aws.Context, *sagemaker.StopLabelingJobInput, ...request.Option) (*sagemaker.StopLabelingJobOutput, error) StopLabelingJobRequest(*sagemaker.StopLabelingJobInput) (*request.Request, *sagemaker.StopLabelingJobOutput) diff --git a/service/sagemakerruntime/api.go b/service/sagemakerruntime/api.go index bb835618e6c..f5c0a5c9483 100644 --- a/service/sagemakerruntime/api.go +++ b/service/sagemakerruntime/api.go @@ -65,9 +65,9 @@ func (c *SageMakerRuntime) InvokeEndpointRequest(input *InvokeEndpointInput) (re // Amazon SageMaker might add additional headers. You should not rely on the // behavior of headers outside those enumerated in the request syntax. // -// Calls to InvokeEndpoint are authenticated by using AWS Signature Version -// 4. For information, see Authenticating Requests (AWS Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature +// Version 4. For information, see Authenticating Requests (Amazon Web Services +// Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) // in the Amazon S3 API Reference. // // A customer's model containers must respond to requests within 60 seconds. @@ -100,6 +100,15 @@ func (c *SageMakerRuntime) InvokeEndpointRequest(input *InvokeEndpointInput) (re // Model (owned by the customer in the container) returned 4xx or 5xx error // code. // +// * InternalDependencyException +// Your request caused an exception with an internal dependency. Contact customer +// support. +// +// * ModelNotReadyException +// Either a serverless endpoint variant's resources are still being provisioned, +// or a multi-model endpoint is still downloading or loading the target model. +// Wait and try your request again. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.sagemaker-2017-05-13/InvokeEndpoint func (c *SageMakerRuntime) InvokeEndpoint(input *InvokeEndpointInput) (*InvokeEndpointOutput, error) { req, out := c.InvokeEndpointRequest(input) @@ -180,9 +189,9 @@ func (c *SageMakerRuntime) InvokeEndpointAsyncRequest(input *InvokeEndpointAsync // Amazon SageMaker might add additional headers. You should not rely on the // behavior of headers outside those enumerated in the request syntax. // -// Calls to InvokeEndpointAsync are authenticated by using AWS Signature Version -// 4. For information, see Authenticating Requests (AWS Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services +// Signature Version 4. For information, see Authenticating Requests (Amazon +// Web Services Signature Version 4) (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) // in the Amazon S3 API Reference. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -224,6 +233,71 @@ func (c *SageMakerRuntime) InvokeEndpointAsyncWithContext(ctx aws.Context, input return out, req.Send() } +// Your request caused an exception with an internal dependency. Contact customer +// support. +type InternalDependencyException 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 InternalDependencyException) 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 InternalDependencyException) GoString() string { + return s.String() +} + +func newErrorInternalDependencyException(v protocol.ResponseMetadata) error { + return &InternalDependencyException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalDependencyException) Code() string { + return "InternalDependencyException" +} + +// Message returns the exception's message. +func (s *InternalDependencyException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalDependencyException) OrigErr() error { + return nil +} + +func (s *InternalDependencyException) 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 *InternalDependencyException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalDependencyException) RequestID() string { + return s.RespMetadata.RequestID +} + // An internal failure occurred. type InternalFailure struct { _ struct{} `type:"structure"` @@ -312,8 +386,8 @@ type InvokeEndpointAsyncInput struct { // the trace ID, your model can prepend the custom attribute with Trace ID: // in your post-processing function. // - // This feature is currently supported in the AWS SDKs but not in the Amazon - // SageMaker Python SDK. + // This feature is currently supported in the Amazon Web Services SDKs but not + // in the Amazon SageMaker Python SDK. // // CustomAttributes is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by InvokeEndpointAsyncInput's @@ -508,8 +582,8 @@ type InvokeEndpointInput struct { // the trace ID, your model can prepend the custom attribute with Trace ID: // in your post-processing function. // - // This feature is currently supported in the AWS SDKs but not in the Amazon - // SageMaker Python SDK. + // This feature is currently supported in the Amazon Web Services SDKs but not + // in the Amazon SageMaker Python SDK. // // CustomAttributes is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by InvokeEndpointInput's @@ -677,8 +751,8 @@ type InvokeEndpointOutput struct { // the trace ID, your model can prepend the custom attribute with Trace ID: // in your post-processing function. // - // This feature is currently supported in the AWS SDKs but not in the Amazon - // SageMaker Python SDK. + // This feature is currently supported in the Amazon Web Services SDKs but not + // in the Amazon SageMaker Python SDK. // // CustomAttributes is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by InvokeEndpointOutput's @@ -805,6 +879,72 @@ func (s *ModelError) RequestID() string { return s.RespMetadata.RequestID } +// Either a serverless endpoint variant's resources are still being provisioned, +// or a multi-model endpoint is still downloading or loading the target model. +// Wait and try your request again. +type ModelNotReadyException 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 ModelNotReadyException) 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 ModelNotReadyException) GoString() string { + return s.String() +} + +func newErrorModelNotReadyException(v protocol.ResponseMetadata) error { + return &ModelNotReadyException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ModelNotReadyException) Code() string { + return "ModelNotReadyException" +} + +// Message returns the exception's message. +func (s *ModelNotReadyException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ModelNotReadyException) OrigErr() error { + return nil +} + +func (s *ModelNotReadyException) 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 *ModelNotReadyException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ModelNotReadyException) RequestID() string { + return s.RespMetadata.RequestID +} + // The service is unavailable. Try your call again. type ServiceUnavailable struct { _ struct{} `type:"structure"` diff --git a/service/sagemakerruntime/errors.go b/service/sagemakerruntime/errors.go index 664c8e3bd8b..014e55c2116 100644 --- a/service/sagemakerruntime/errors.go +++ b/service/sagemakerruntime/errors.go @@ -8,6 +8,13 @@ import ( const ( + // ErrCodeInternalDependencyException for service response error code + // "InternalDependencyException". + // + // Your request caused an exception with an internal dependency. Contact customer + // support. + ErrCodeInternalDependencyException = "InternalDependencyException" + // ErrCodeInternalFailure for service response error code // "InternalFailure". // @@ -21,6 +28,14 @@ const ( // code. ErrCodeModelError = "ModelError" + // ErrCodeModelNotReadyException for service response error code + // "ModelNotReadyException". + // + // Either a serverless endpoint variant's resources are still being provisioned, + // or a multi-model endpoint is still downloading or loading the target model. + // Wait and try your request again. + ErrCodeModelNotReadyException = "ModelNotReadyException" + // ErrCodeServiceUnavailable for service response error code // "ServiceUnavailable". // @@ -35,8 +50,10 @@ const ( ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ - "InternalFailure": newErrorInternalFailure, - "ModelError": newErrorModelError, - "ServiceUnavailable": newErrorServiceUnavailable, - "ValidationError": newErrorValidationError, + "InternalDependencyException": newErrorInternalDependencyException, + "InternalFailure": newErrorInternalFailure, + "ModelError": newErrorModelError, + "ModelNotReadyException": newErrorModelNotReadyException, + "ServiceUnavailable": newErrorServiceUnavailable, + "ValidationError": newErrorValidationError, } diff --git a/service/shield/api.go b/service/shield/api.go index ebe617a0256..489bca2ce53 100644 --- a/service/shield/api.go +++ b/service/shield/api.go @@ -64,8 +64,8 @@ func (c *Shield) AssociateDRTLogBucketRequest(input *AssociateDRTLogBucketInput) // 10 Amazon S3 buckets with your subscription. // // To use the services of the SRT and make an AssociateDRTLogBucket request, -// you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) -// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). +// you must be subscribed to the Business Support plan (https://docs.aws.amazon.com/premiumsupport/business-support/) +// or the Enterprise Support plan (https://docs.aws.amazon.com/premiumsupport/enterprise-support/). // // 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 @@ -185,11 +185,11 @@ func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *req // role, the new RoleArn will replace the existing RoleArn. // // Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy -// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) -// managed policy to the role you will specify in the request. For more information -// see Attaching and Detaching IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). +// managed policy to the role that you'll specify in the request. You can access +// this policy in the IAM console at AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy). +// For more information see Adding and removing IAM identity permissions (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). // The role must also trust the service principal drt.shield.amazonaws.com. -// For more information, see IAM JSON Policy Elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). +// For more information, see IAM JSON policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). // // The SRT will have access only to your WAF and Shield resources. By submitting // this request, you authorize the SRT to inspect your WAF and Shield configuration @@ -197,12 +197,12 @@ func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *req // these actions only if explicitly authorized by you. // // You must have the iam:PassRole permission to make an AssociateDRTRole request. -// For more information, see Granting a User Permissions to Pass a Role to an -// Amazon Web Services Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). +// For more information, see Granting a user permissions to pass a role to an +// Amazon Web Services service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). // // To use the services of the SRT and make an AssociateDRTRole request, you -// must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) -// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). +// must be subscribed to the Business Support plan (https://docs.aws.amazon.com/premiumsupport/business-support/) +// or the Enterprise Support plan (https://docs.aws.amazon.com/premiumsupport/enterprise-support/). // // 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 @@ -309,7 +309,7 @@ func (c *Shield) AssociateHealthCheckRequest(input *AssociateHealthCheckInput) ( // Adds health-based detection to the Shield Advanced protection for a resource. // Shield Advanced health-based detection uses the health of your Amazon Web // Services resource to improve responsiveness and accuracy in attack detection -// and mitigation. +// and response. // // You define the health check in Route 53 and then associate it with your Shield // Advanced protection. For more information, see Shield Advanced Health-Based @@ -343,6 +343,10 @@ func (c *Shield) AssociateHealthCheckRequest(input *AssociateHealthCheckInput) ( // Exception that indicates that the resource state has been modified by another // client. Retrieve the resource and then retry your request. // +// * InvalidResourceException +// Exception that indicates that the resource is invalid. You might not have +// access to the resource, or the resource might not exist. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateHealthCheck func (c *Shield) AssociateHealthCheck(input *AssociateHealthCheckInput) (*AssociateHealthCheckOutput, error) { req, out := c.AssociateHealthCheckRequest(input) @@ -527,11 +531,11 @@ func (c *Shield) CreateProtectionRequest(input *CreateProtectionInput) (req *req // Amazon Route 53 hosted zone. // // You can add protection to only a single resource with each CreateProtection -// request. If you want to add protection to multiple resources at once, use -// the WAF console (https://console.aws.amazon.com/waf/). For more information -// see Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) -// and Add Shield Advanced Protection to more Amazon Web Services Resources -// (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html). +// request. You can add protection to multiple resources at once through the +// Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ +// (https://console.aws.amazon.com/wafv2/shieldv2#/). For more information see +// Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) +// and Adding Shield Advanced protection to Amazon Web Services resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1668,6 +1672,105 @@ func (c *Shield) DescribeSubscriptionWithContext(ctx aws.Context, input *Describ return out, req.Send() } +const opDisableApplicationLayerAutomaticResponse = "DisableApplicationLayerAutomaticResponse" + +// DisableApplicationLayerAutomaticResponseRequest generates a "aws/request.Request" representing the +// client's request for the DisableApplicationLayerAutomaticResponse 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 DisableApplicationLayerAutomaticResponse for more information on using the DisableApplicationLayerAutomaticResponse +// 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 DisableApplicationLayerAutomaticResponseRequest method. +// req, resp := client.DisableApplicationLayerAutomaticResponseRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableApplicationLayerAutomaticResponse +func (c *Shield) DisableApplicationLayerAutomaticResponseRequest(input *DisableApplicationLayerAutomaticResponseInput) (req *request.Request, output *DisableApplicationLayerAutomaticResponseOutput) { + op := &request.Operation{ + Name: opDisableApplicationLayerAutomaticResponse, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DisableApplicationLayerAutomaticResponseInput{} + } + + output = &DisableApplicationLayerAutomaticResponseOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DisableApplicationLayerAutomaticResponse API operation for AWS Shield. +// +// Disable the Shield Advanced automatic application layer DDoS mitigation feature +// for the resource. This stops Shield Advanced from creating, verifying, and +// applying WAF rules for attacks that it detects for the 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 AWS Shield's +// API operation DisableApplicationLayerAutomaticResponse for usage and error information. +// +// Returned Error Types: +// * InternalErrorException +// Exception that indicates that a problem occurred with the service infrastructure. +// You can retry the request. +// +// * InvalidParameterException +// Exception that indicates that the parameters passed to the API are invalid. +// If available, this exception includes details in additional properties. +// +// * ResourceNotFoundException +// Exception indicating the specified resource does not exist. If available, +// this exception includes details in additional properties. +// +// * OptimisticLockException +// Exception that indicates that the resource state has been modified by another +// client. Retrieve the resource and then retry your request. +// +// * InvalidOperationException +// Exception that indicates that the operation would not cause any change to +// occur. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableApplicationLayerAutomaticResponse +func (c *Shield) DisableApplicationLayerAutomaticResponse(input *DisableApplicationLayerAutomaticResponseInput) (*DisableApplicationLayerAutomaticResponseOutput, error) { + req, out := c.DisableApplicationLayerAutomaticResponseRequest(input) + return out, req.Send() +} + +// DisableApplicationLayerAutomaticResponseWithContext is the same as DisableApplicationLayerAutomaticResponse with the addition of +// the ability to pass a context and additional request options. +// +// See DisableApplicationLayerAutomaticResponse 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 *Shield) DisableApplicationLayerAutomaticResponseWithContext(ctx aws.Context, input *DisableApplicationLayerAutomaticResponseInput, opts ...request.Option) (*DisableApplicationLayerAutomaticResponseOutput, error) { + req, out := c.DisableApplicationLayerAutomaticResponseRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDisableProactiveEngagement = "DisableProactiveEngagement" // DisableProactiveEngagementRequest generates a "aws/request.Request" representing the @@ -1814,13 +1917,6 @@ func (c *Shield) DisassociateDRTLogBucketRequest(input *DisassociateDRTLogBucket // Removes the Shield Response Team's (SRT) access to the specified Amazon S3 // bucket containing the logs that you shared previously. // -// To make a DisassociateDRTLogBucket request, you must be subscribed to the -// Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) -// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). -// However, if you are not subscribed to one of these support plans, but had -// been previously and had granted the SRT access to your account, you can submit -// a DisassociateDRTLogBucket request to remove this access. -// // 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. @@ -1925,13 +2021,6 @@ func (c *Shield) DisassociateDRTRoleRequest(input *DisassociateDRTRoleInput) (re // Removes the Shield Response Team's (SRT) access to your Amazon Web Services // account. // -// To make a DisassociateDRTRole request, you must be subscribed to the Business -// Support plan (https://aws.amazon.com/premiumsupport/business-support/) or -// the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). -// However, if you are not subscribed to one of these support plans, but had -// been previously and had granted the SRT access to your account, you can submit -// a DisassociateDRTRole request to remove this access. -// // 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. @@ -2026,7 +2115,7 @@ func (c *Shield) DisassociateHealthCheckRequest(input *DisassociateHealthCheckIn // Removes health-based detection from the Shield Advanced protection for a // resource. Shield Advanced health-based detection uses the health of your // Amazon Web Services resource to improve responsiveness and accuracy in attack -// detection and mitigation. +// detection and response. // // You define the health check in Route 53 and then associate or disassociate // it with your Shield Advanced protection. For more information, see Shield @@ -2057,6 +2146,10 @@ func (c *Shield) DisassociateHealthCheckRequest(input *DisassociateHealthCheckIn // Exception that indicates that the resource state has been modified by another // client. Retrieve the resource and then retry your request. // +// * InvalidResourceException +// Exception that indicates that the resource is invalid. You might not have +// access to the resource, or the resource might not exist. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateHealthCheck func (c *Shield) DisassociateHealthCheck(input *DisassociateHealthCheckInput) (*DisassociateHealthCheckOutput, error) { req, out := c.DisassociateHealthCheckRequest(input) @@ -2079,6 +2172,129 @@ func (c *Shield) DisassociateHealthCheckWithContext(ctx aws.Context, input *Disa return out, req.Send() } +const opEnableApplicationLayerAutomaticResponse = "EnableApplicationLayerAutomaticResponse" + +// EnableApplicationLayerAutomaticResponseRequest generates a "aws/request.Request" representing the +// client's request for the EnableApplicationLayerAutomaticResponse 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 EnableApplicationLayerAutomaticResponse for more information on using the EnableApplicationLayerAutomaticResponse +// 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 EnableApplicationLayerAutomaticResponseRequest method. +// req, resp := client.EnableApplicationLayerAutomaticResponseRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableApplicationLayerAutomaticResponse +func (c *Shield) EnableApplicationLayerAutomaticResponseRequest(input *EnableApplicationLayerAutomaticResponseInput) (req *request.Request, output *EnableApplicationLayerAutomaticResponseOutput) { + op := &request.Operation{ + Name: opEnableApplicationLayerAutomaticResponse, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &EnableApplicationLayerAutomaticResponseInput{} + } + + output = &EnableApplicationLayerAutomaticResponseOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// EnableApplicationLayerAutomaticResponse API operation for AWS Shield. +// +// Enable the Shield Advanced automatic application layer DDoS mitigation for +// the resource. +// +// This feature is available for Amazon CloudFront distributions only. +// +// This causes Shield Advanced to create, verify, and apply WAF rules for DDoS +// attacks that it detects for the resource. Shield Advanced applies the rules +// in a Shield rule group inside the web ACL that you've associated with the +// resource. For information about how automatic mitigation works and the requirements +// for using it, see Shield Advanced automatic application layer DDoS mitigation +// (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html). +// +// Don't use this action to make changes to automatic mitigation settings when +// it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse. +// +// To use this feature, you must associate a web ACL with the protected resource. +// The web ACL must be created using the latest version of WAF (v2). You can +// associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ +// (https://console.aws.amazon.com/wafv2/shieldv2#/). For more information, +// see Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html). +// +// You can also do this through the WAF console or the WAF API, but you must +// manage Shield Advanced automatic mitigation through Shield Advanced. For +// information about WAF, see WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// +// 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 Shield's +// API operation EnableApplicationLayerAutomaticResponse for usage and error information. +// +// Returned Error Types: +// * LimitsExceededException +// Exception that indicates that the operation would exceed a limit. +// +// * InternalErrorException +// Exception that indicates that a problem occurred with the service infrastructure. +// You can retry the request. +// +// * ResourceNotFoundException +// Exception indicating the specified resource does not exist. If available, +// this exception includes details in additional properties. +// +// * InvalidParameterException +// Exception that indicates that the parameters passed to the API are invalid. +// If available, this exception includes details in additional properties. +// +// * OptimisticLockException +// Exception that indicates that the resource state has been modified by another +// client. Retrieve the resource and then retry your request. +// +// * InvalidOperationException +// Exception that indicates that the operation would not cause any change to +// occur. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableApplicationLayerAutomaticResponse +func (c *Shield) EnableApplicationLayerAutomaticResponse(input *EnableApplicationLayerAutomaticResponseInput) (*EnableApplicationLayerAutomaticResponseOutput, error) { + req, out := c.EnableApplicationLayerAutomaticResponseRequest(input) + return out, req.Send() +} + +// EnableApplicationLayerAutomaticResponseWithContext is the same as EnableApplicationLayerAutomaticResponse with the addition of +// the ability to pass a context and additional request options. +// +// See EnableApplicationLayerAutomaticResponse 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 *Shield) EnableApplicationLayerAutomaticResponseWithContext(ctx aws.Context, input *EnableApplicationLayerAutomaticResponseInput, opts ...request.Option) (*EnableApplicationLayerAutomaticResponseOutput, error) { + req, out := c.EnableApplicationLayerAutomaticResponseRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opEnableProactiveEngagement = "EnableProactiveEngagement" // EnableProactiveEngagementRequest generates a "aws/request.Request" representing the @@ -2475,7 +2691,8 @@ func (c *Shield) ListProtectionGroupsRequest(input *ListProtectionGroupsInput) ( // // * InvalidPaginationTokenException // Exception that indicates that the NextToken specified in the request is invalid. -// Submit the request using the NextToken value that was returned in the response. +// Submit the request using the NextToken value that was returned in the prior +// response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionGroups func (c *Shield) ListProtectionGroups(input *ListProtectionGroupsInput) (*ListProtectionGroupsOutput, error) { @@ -2621,7 +2838,8 @@ func (c *Shield) ListProtectionsRequest(input *ListProtectionsInput) (req *reque // // * InvalidPaginationTokenException // Exception that indicates that the NextToken specified in the request is invalid. -// Submit the request using the NextToken value that was returned in the response. +// Submit the request using the NextToken value that was returned in the prior +// response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections func (c *Shield) ListProtections(input *ListProtectionsInput) (*ListProtectionsOutput, error) { @@ -2767,7 +2985,8 @@ func (c *Shield) ListResourcesInProtectionGroupRequest(input *ListResourcesInPro // // * InvalidPaginationTokenException // Exception that indicates that the NextToken specified in the request is invalid. -// Submit the request using the NextToken value that was returned in the response. +// Submit the request using the NextToken value that was returned in the prior +// response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListResourcesInProtectionGroup func (c *Shield) ListResourcesInProtectionGroup(input *ListResourcesInProtectionGroupInput) (*ListResourcesInProtectionGroupOutput, error) { @@ -3118,6 +3337,104 @@ func (c *Shield) UntagResourceWithContext(ctx aws.Context, input *UntagResourceI return out, req.Send() } +const opUpdateApplicationLayerAutomaticResponse = "UpdateApplicationLayerAutomaticResponse" + +// UpdateApplicationLayerAutomaticResponseRequest generates a "aws/request.Request" representing the +// client's request for the UpdateApplicationLayerAutomaticResponse 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 UpdateApplicationLayerAutomaticResponse for more information on using the UpdateApplicationLayerAutomaticResponse +// 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 UpdateApplicationLayerAutomaticResponseRequest method. +// req, resp := client.UpdateApplicationLayerAutomaticResponseRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateApplicationLayerAutomaticResponse +func (c *Shield) UpdateApplicationLayerAutomaticResponseRequest(input *UpdateApplicationLayerAutomaticResponseInput) (req *request.Request, output *UpdateApplicationLayerAutomaticResponseOutput) { + op := &request.Operation{ + Name: opUpdateApplicationLayerAutomaticResponse, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateApplicationLayerAutomaticResponseInput{} + } + + output = &UpdateApplicationLayerAutomaticResponseOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateApplicationLayerAutomaticResponse API operation for AWS Shield. +// +// Updates an existing Shield Advanced automatic application layer DDoS mitigation +// configuration for the specified 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 AWS Shield's +// API operation UpdateApplicationLayerAutomaticResponse for usage and error information. +// +// Returned Error Types: +// * InternalErrorException +// Exception that indicates that a problem occurred with the service infrastructure. +// You can retry the request. +// +// * ResourceNotFoundException +// Exception indicating the specified resource does not exist. If available, +// this exception includes details in additional properties. +// +// * InvalidParameterException +// Exception that indicates that the parameters passed to the API are invalid. +// If available, this exception includes details in additional properties. +// +// * OptimisticLockException +// Exception that indicates that the resource state has been modified by another +// client. Retrieve the resource and then retry your request. +// +// * InvalidOperationException +// Exception that indicates that the operation would not cause any change to +// occur. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateApplicationLayerAutomaticResponse +func (c *Shield) UpdateApplicationLayerAutomaticResponse(input *UpdateApplicationLayerAutomaticResponseInput) (*UpdateApplicationLayerAutomaticResponseOutput, error) { + req, out := c.UpdateApplicationLayerAutomaticResponseRequest(input) + return out, req.Send() +} + +// UpdateApplicationLayerAutomaticResponseWithContext is the same as UpdateApplicationLayerAutomaticResponse with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateApplicationLayerAutomaticResponse 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 *Shield) UpdateApplicationLayerAutomaticResponseWithContext(ctx aws.Context, input *UpdateApplicationLayerAutomaticResponseInput, opts ...request.Option) (*UpdateApplicationLayerAutomaticResponseOutput, error) { + req, out := c.UpdateApplicationLayerAutomaticResponseRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateEmergencyContactSettings = "UpdateEmergencyContactSettings" // UpdateEmergencyContactSettingsRequest generates a "aws/request.Request" representing the @@ -3542,6 +3859,60 @@ func (s *AccessDeniedForDependencyException) RequestID() string { return s.RespMetadata.RequestID } +// The automatic application layer DDoS mitigation settings for a Protection. +// This configuration determines whether Shield Advanced automatically manages +// rules in the web ACL in order to respond to application layer events that +// Shield Advanced determines to be DDoS attacks. +type ApplicationLayerAutomaticResponseConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies the action setting that Shield Advanced should use in the WAF rules + // that it creates on behalf of the protected resource in response to DDoS attacks. + // You specify this as part of the configuration for the automatic application + // layer DDoS mitigation feature, when you enable or update automatic mitigation. + // Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, + // inside the web ACL that you have associated with the resource. + // + // Action is a required field + Action *ResponseAction `type:"structure" required:"true"` + + // Indicates whether automatic application layer DDoS mitigation is enabled + // for the protection. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"ApplicationLayerAutomaticResponseStatus"` +} + +// 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 ApplicationLayerAutomaticResponseConfiguration) 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 ApplicationLayerAutomaticResponseConfiguration) GoString() string { + return s.String() +} + +// SetAction sets the Action field's value. +func (s *ApplicationLayerAutomaticResponseConfiguration) SetAction(v *ResponseAction) *ApplicationLayerAutomaticResponseConfiguration { + s.Action = v + return s +} + +// SetStatus sets the Status field's value. +func (s *ApplicationLayerAutomaticResponseConfiguration) SetStatus(v string) *ApplicationLayerAutomaticResponseConfiguration { + s.Status = &v + return s +} + type AssociateDRTLogBucketInput struct { _ struct{} `type:"structure"` @@ -3703,7 +4074,7 @@ type AssociateHealthCheckInput struct { // association to. // // ProtectionId is a required field - ProtectionId *string `min:"1" type:"string" required:"true"` + ProtectionId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -3736,8 +4107,8 @@ func (s *AssociateHealthCheckInput) Validate() error { if s.ProtectionId == nil { invalidParams.Add(request.NewErrParamRequired("ProtectionId")) } - if s.ProtectionId != nil && len(*s.ProtectionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 1)) + if s.ProtectionId != nil && len(*s.ProtectionId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 36)) } if invalidParams.Len() > 0 { @@ -3879,14 +4250,13 @@ type AttackDetail struct { // The array of objects that provide details of the Shield event. // - // For infrastructure layer events (L3 and L4 events) after January 25, 2021, - // you can view metrics for top contributors in Amazon CloudWatch metrics. For - // more information, see Shield metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) + // For infrastructure layer events (L3 and L4 events), you can view metrics + // for top contributors in Amazon CloudWatch metrics. For more information, + // see Shield metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) // in the WAF Developer Guide. AttackProperties []*AttackProperty `type:"list"` - // The time the attack ended, in Unix time in seconds. For more information - // see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The time the attack ended, in Unix time in seconds. EndTime *time.Time `type:"timestamp"` // List of mitigation actions taken for the attack. @@ -3895,8 +4265,7 @@ type AttackDetail struct { // The ARN (Amazon Resource Name) of the resource that was attacked. ResourceArn *string `min:"1" type:"string"` - // The time the attack started, in Unix time in seconds. For more information - // see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The time the attack started, in Unix time in seconds. StartTime *time.Time `type:"timestamp"` // If applicable, additional detail about the resource being attacked, for example, @@ -3977,9 +4346,9 @@ type AttackProperty struct { // The type of Shield event that was observed. NETWORK indicates layer 3 and // layer 4 events and APPLICATION indicates layer 7 events. // - // For infrastructure layer events (L3 and L4 events) after January 25, 2021, - // you can view metrics for top contributors in Amazon CloudWatch metrics. For - // more information, see Shield metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) + // For infrastructure layer events (L3 and L4 events), you can view metrics + // for top contributors in Amazon CloudWatch metrics. For more information, + // see Shield metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) // in the WAF Developer Guide. AttackLayer *string `type:"string" enum:"AttackLayer"` @@ -3988,7 +4357,9 @@ type AttackProperty struct { // pingback events. AttackPropertyIdentifier *string `type:"string" enum:"AttackPropertyIdentifier"` - // Contributor objects for the top five contributors to a Shield event. + // Contributor objects for the top five contributors to a Shield event. A contributor + // is a source of traffic that Shield Advanced identifies as responsible for + // some or all of an event. TopContributors []*Contributor `type:"list"` // The total contributions made to this Shield event by all contributors. @@ -4103,15 +4474,13 @@ type AttackSummary struct { // The list of attacks for a specified time period. AttackVectors []*AttackVectorDescription `type:"list"` - // The end time of the attack, in Unix time in seconds. For more information - // see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The end time of the attack, in Unix time in seconds. EndTime *time.Time `type:"timestamp"` // The ARN (Amazon Resource Name) of the resource that was attacked. ResourceArn *string `type:"string"` - // The start time of the attack, in Unix time in seconds. For more information - // see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The start time of the attack, in Unix time in seconds. StartTime *time.Time `type:"timestamp"` } @@ -4323,13 +4692,42 @@ func (s *AttackVolumeStatistics) SetMax(v float64) *AttackVolumeStatistics { return s } +// Specifies that Shield Advanced should configure its WAF rules with the WAF +// Block action. +// +// This is only used in the context of the ResponseAction setting. +// +// JSON specification: "Block": {} +type BlockAction 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 BlockAction) 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 BlockAction) GoString() string { + return s.String() +} + // A contributor to the attack and their contribution. type Contributor struct { _ struct{} `type:"structure"` - // The name of the contributor. This is dependent on the AttackPropertyIdentifier. - // For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name - // could be United States. + // The name of the contributor. The type of name that you'll find here depends + // on the AttackPropertyIdentifier setting in the AttackProperty where this + // contributor is defined. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, + // the Name could be United States. Name *string `type:"string"` // The contribution of this contributor expressed in Protection units. For example @@ -4367,6 +4765,34 @@ func (s *Contributor) SetValue(v int64) *Contributor { return s } +// Specifies that Shield Advanced should configure its WAF rules with the WAF +// Count action. +// +// This is only used in the context of the ResponseAction setting. +// +// JSON specification: "Count": {} +type CountAction 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 CountAction) 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 CountAction) GoString() string { + return s.String() +} + type CreateProtectionGroupInput struct { _ struct{} `type:"structure"` @@ -4631,7 +5057,7 @@ type CreateProtectionOutput struct { _ struct{} `type:"structure"` // The unique identifier (ID) for the Protection object that is created. - ProtectionId *string `min:"1" type:"string"` + ProtectionId *string `min:"36" type:"string"` } // String returns the string representation. @@ -4781,7 +5207,7 @@ type DeleteProtectionInput struct { // The unique identifier (ID) for the Protection object to be deleted. // // ProtectionId is a required field - ProtectionId *string `min:"1" type:"string" required:"true"` + ProtectionId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -4808,8 +5234,8 @@ func (s *DeleteProtectionInput) Validate() error { if s.ProtectionId == nil { invalidParams.Add(request.NewErrParamRequired("ProtectionId")) } - if s.ProtectionId != nil && len(*s.ProtectionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 1)) + if s.ProtectionId != nil && len(*s.ProtectionId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 36)) } if invalidParams.Len() > 0 { @@ -4895,7 +5321,7 @@ func (s DeleteSubscriptionOutput) GoString() string { type DescribeAttackInput struct { _ struct{} `type:"structure"` - // The unique identifier (ID) for the attack that to be described. + // The unique identifier (ID) for the attack. // // AttackId is a required field AttackId *string `min:"1" type:"string" required:"true"` @@ -5248,7 +5674,7 @@ type DescribeProtectionInput struct { // The unique identifier (ID) for the Protection object that is described. When // submitting the DescribeProtection request you must provide either the ResourceArn // or the ProtectionID, but not both. - ProtectionId *string `min:"1" type:"string"` + ProtectionId *string `min:"36" type:"string"` // The ARN (Amazon Resource Name) of the Amazon Web Services resource for the // Protection object that is described. When submitting the DescribeProtection @@ -5278,8 +5704,8 @@ func (s DescribeProtectionInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeProtectionInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeProtectionInput"} - if s.ProtectionId != nil && len(*s.ProtectionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 1)) + if s.ProtectionId != nil && len(*s.ProtectionId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 36)) } if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) @@ -5387,6 +5813,77 @@ func (s *DescribeSubscriptionOutput) SetSubscription(v *Subscription) *DescribeS return s } +type DisableApplicationLayerAutomaticResponseInput struct { + _ struct{} `type:"structure"` + + // The ARN (Amazon Resource Name) of the resource. + // + // ResourceArn is a required field + ResourceArn *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 DisableApplicationLayerAutomaticResponseInput) 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 DisableApplicationLayerAutomaticResponseInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisableApplicationLayerAutomaticResponseInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisableApplicationLayerAutomaticResponseInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *DisableApplicationLayerAutomaticResponseInput) SetResourceArn(v string) *DisableApplicationLayerAutomaticResponseInput { + s.ResourceArn = &v + return s +} + +type DisableApplicationLayerAutomaticResponseOutput 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 DisableApplicationLayerAutomaticResponseOutput) 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 DisableApplicationLayerAutomaticResponseOutput) GoString() string { + return s.String() +} + type DisableProactiveEngagementInput struct { _ struct{} `type:"structure"` } @@ -5559,7 +6056,7 @@ type DisassociateHealthCheckInput struct { // check association from. // // ProtectionId is a required field - ProtectionId *string `min:"1" type:"string" required:"true"` + ProtectionId *string `min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -5592,8 +6089,8 @@ func (s *DisassociateHealthCheckInput) Validate() error { if s.ProtectionId == nil { invalidParams.Add(request.NewErrParamRequired("ProtectionId")) } - if s.ProtectionId != nil && len(*s.ProtectionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 1)) + if s.ProtectionId != nil && len(*s.ProtectionId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ProtectionId", 36)) } if invalidParams.Len() > 0 { @@ -5712,6 +6209,96 @@ func (s *EmergencyContact) SetPhoneNumber(v string) *EmergencyContact { return s } +type EnableApplicationLayerAutomaticResponseInput struct { + _ struct{} `type:"structure"` + + // Specifies the action setting that Shield Advanced should use in the WAF rules + // that it creates on behalf of the protected resource in response to DDoS attacks. + // You specify this as part of the configuration for the automatic application + // layer DDoS mitigation feature, when you enable or update automatic mitigation. + // Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, + // inside the web ACL that you have associated with the resource. + // + // Action is a required field + Action *ResponseAction `type:"structure" required:"true"` + + // The ARN (Amazon Resource Name) of the resource. + // + // ResourceArn is a required field + ResourceArn *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 EnableApplicationLayerAutomaticResponseInput) 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 EnableApplicationLayerAutomaticResponseInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EnableApplicationLayerAutomaticResponseInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnableApplicationLayerAutomaticResponseInput"} + if s.Action == nil { + invalidParams.Add(request.NewErrParamRequired("Action")) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAction sets the Action field's value. +func (s *EnableApplicationLayerAutomaticResponseInput) SetAction(v *ResponseAction) *EnableApplicationLayerAutomaticResponseInput { + s.Action = v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *EnableApplicationLayerAutomaticResponseInput) SetResourceArn(v string) *EnableApplicationLayerAutomaticResponseInput { + s.ResourceArn = &v + return s +} + +type EnableApplicationLayerAutomaticResponseOutput 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 EnableApplicationLayerAutomaticResponseOutput) 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 EnableApplicationLayerAutomaticResponseOutput) GoString() string { + return s.String() +} + type EnableProactiveEngagementInput struct { _ struct{} `type:"structure"` } @@ -5942,7 +6529,8 @@ func (s *InvalidOperationException) RequestID() string { } // Exception that indicates that the NextToken specified in the request is invalid. -// Submit the request using the NextToken value that was returned in the response. +// Submit the request using the NextToken value that was returned in the prior +// response. type InvalidPaginationTokenException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6257,33 +6845,45 @@ type ListAttacksInput struct { _ struct{} `type:"structure"` // The end of the time period for the attacks. This is a timestamp type. The - // sample request above indicates a number type because the default used by - // WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types) - // is allowed. + // request syntax listing for this call indicates a number type, but you can + // provide the time in any valid timestamp format (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) + // setting. EndTime *TimeRange `type:"structure"` - // The maximum number of AttackSummary objects to return. If you leave this - // blank, Shield Advanced returns the first 20 results. + // The greatest number of objects that you want Shield Advanced to return to + // the list request. Shield Advanced might return fewer objects than you indicate + // in this setting, even if more objects are available. If there are more objects + // remaining, Shield Advanced will always also return a NextToken value in the + // response. // - // This is a maximum value. Shield Advanced might return the results in smaller - // batches. That is, the number of objects returned could be less than MaxResults, - // even if there are still more objects yet to return. If there are more objects - // to return, Shield Advanced returns a value in NextToken that you can use - // in your next request, to get the next batch of objects. + // The default setting is 20. MaxResults *int64 `type:"integer"` - // The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. - // Pass null if this is the first call. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string `min:"1" type:"string"` - // The ARN (Amazon Resource Name) of the resource that was attacked. If this - // is left blank, all applicable resources for this account will be included. + // The ARNs (Amazon Resource Names) of the resources that were attacked. If + // you leave this blank, all applicable resources for this account will be included. ResourceArns []*string `type:"list"` // The start of the time period for the attacks. This is a timestamp type. The - // sample request above indicates a number type because the default used by - // WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types) - // is allowed. + // request syntax listing for this call indicates a number type, but you can + // provide the time in any valid timestamp format (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) + // setting. StartTime *TimeRange `type:"structure"` } @@ -6354,14 +6954,19 @@ type ListAttacksOutput struct { // The attack information for the specified time range. AttackSummaries []*AttackSummary `type:"list"` - // The token returned by a previous call to indicate that there is more data - // available. If not null, more results are available. Pass this value for the - // NextMarker parameter in a subsequent call to ListAttacks to retrieve the - // next set of items. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. // - // Shield Advanced might return the list of AttackSummary objects in batches - // smaller than the number specified by MaxResults. If there are more attack - // summary objects to return, Shield Advanced will always also return a NextToken. + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. NextToken *string `min:"1" type:"string"` } @@ -6398,18 +7003,30 @@ func (s *ListAttacksOutput) SetNextToken(v string) *ListAttacksOutput { type ListProtectionGroupsInput struct { _ struct{} `type:"structure"` - // The maximum number of ProtectionGroup objects to return. If you leave this - // blank, Shield Advanced returns the first 20 results. + // The greatest number of objects that you want Shield Advanced to return to + // the list request. Shield Advanced might return fewer objects than you indicate + // in this setting, even if more objects are available. If there are more objects + // remaining, Shield Advanced will always also return a NextToken value in the + // response. // - // This is a maximum value. Shield Advanced might return the results in smaller - // batches. That is, the number of objects returned could be less than MaxResults, - // even if there are still more objects yet to return. If there are more objects - // to return, Shield Advanced returns a value in NextToken that you can use - // in your next request, to get the next batch of objects. + // The default setting is 20. MaxResults *int64 `type:"integer"` - // The next token value from a previous call to ListProtectionGroups. Pass null - // if this is the first call. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string `min:"1" type:"string"` } @@ -6459,9 +7076,19 @@ func (s *ListProtectionGroupsInput) SetNextToken(v string) *ListProtectionGroups type ListProtectionGroupsOutput struct { _ struct{} `type:"structure"` - // If you specify a value for MaxResults and you have more protection groups - // than the value of MaxResults, Shield Advanced returns this token that you - // can use in your next request, to get the next batch of objects. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. NextToken *string `min:"1" type:"string"` // ProtectionGroups is a required field @@ -6501,18 +7128,30 @@ func (s *ListProtectionGroupsOutput) SetProtectionGroups(v []*ProtectionGroup) * type ListProtectionsInput struct { _ struct{} `type:"structure"` - // The maximum number of Protection objects to return. If you leave this blank, - // Shield Advanced returns the first 20 results. + // The greatest number of objects that you want Shield Advanced to return to + // the list request. Shield Advanced might return fewer objects than you indicate + // in this setting, even if more objects are available. If there are more objects + // remaining, Shield Advanced will always also return a NextToken value in the + // response. // - // This is a maximum value. Shield Advanced might return the results in smaller - // batches. That is, the number of objects returned could be less than MaxResults, - // even if there are still more objects yet to return. If there are more objects - // to return, Shield Advanced returns a value in NextToken that you can use - // in your next request, to get the next batch of objects. + // The default setting is 20. MaxResults *int64 `type:"integer"` - // The ListProtectionsRequest.NextToken value from a previous call to ListProtections. - // Pass null if this is the first call. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string `min:"1" type:"string"` } @@ -6562,15 +7201,19 @@ func (s *ListProtectionsInput) SetNextToken(v string) *ListProtectionsInput { type ListProtectionsOutput struct { _ struct{} `type:"structure"` - // If you specify a value for MaxResults and you have more Protections than - // the value of MaxResults, Shield Advanced returns a NextToken value in the - // response that allows you to list another group of Protections. For the second - // and subsequent ListProtections requests, specify the value of NextToken from - // the previous response to get information about another batch of Protections. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. // - // Shield Advanced might return the list of Protection objects in batches smaller - // than the number specified by MaxResults. If there are more Protection objects - // to return, Shield Advanced will always also return a NextToken. + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. NextToken *string `min:"1" type:"string"` // The array of enabled Protection objects. @@ -6610,18 +7253,30 @@ func (s *ListProtectionsOutput) SetProtections(v []*Protection) *ListProtections type ListResourcesInProtectionGroupInput struct { _ struct{} `type:"structure"` - // The maximum number of resource ARN objects to return. If you leave this blank, - // Shield Advanced returns the first 20 results. + // The greatest number of objects that you want Shield Advanced to return to + // the list request. Shield Advanced might return fewer objects than you indicate + // in this setting, even if more objects are available. If there are more objects + // remaining, Shield Advanced will always also return a NextToken value in the + // response. // - // This is a maximum value. Shield Advanced might return the results in smaller - // batches. That is, the number of objects returned could be less than MaxResults, - // even if there are still more objects yet to return. If there are more objects - // to return, Shield Advanced returns a value in NextToken that you can use - // in your next request, to get the next batch of objects. + // The default setting is 20. MaxResults *int64 `type:"integer"` - // The next token value from a previous call to ListResourcesInProtectionGroup. - // Pass null if this is the first call. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string `min:"1" type:"string"` // The name of the protection group. You use this to identify the protection @@ -6690,9 +7345,19 @@ func (s *ListResourcesInProtectionGroupInput) SetProtectionGroupId(v string) *Li type ListResourcesInProtectionGroupOutput struct { _ struct{} `type:"structure"` - // If you specify a value for MaxResults and you have more resources in the - // protection group than the value of MaxResults, Shield Advanced returns this - // token that you can use in your next request, to get the next batch of objects. + // When you request a list of objects from Shield Advanced, if the response + // does not include all of the remaining available objects, Shield Advanced + // includes a NextToken value in the response. You can retrieve the next batch + // of objects by requesting the list again and providing the token that was + // returned by the prior call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced + // to return for a single call with the MaxResults setting. Shield Advanced + // will not return more than MaxResults objects, but may return fewer, even + // if more objects are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to + // you, the response will include a NextToken value. NextToken *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of the resources that are included in the @@ -7044,12 +7709,18 @@ func (s *OptimisticLockException) RequestID() string { type Protection struct { _ struct{} `type:"structure"` + // The automatic application layer DDoS mitigation settings for the protection. + // This configuration determines whether Shield Advanced automatically manages + // rules in the web ACL in order to respond to application layer events that + // Shield Advanced determines to be DDoS attacks. + ApplicationLayerAutomaticResponseConfiguration *ApplicationLayerAutomaticResponseConfiguration `type:"structure"` + // The unique identifier (ID) for the Route 53 health check that's associated // with the protection. HealthCheckIds []*string `type:"list"` // The unique identifier (ID) of the protection. - Id *string `min:"1" type:"string"` + Id *string `min:"36" type:"string"` // The name of the protection. For example, My CloudFront distributions. Name *string `min:"1" type:"string"` @@ -7080,6 +7751,12 @@ func (s Protection) GoString() string { return s.String() } +// SetApplicationLayerAutomaticResponseConfiguration sets the ApplicationLayerAutomaticResponseConfiguration field's value. +func (s *Protection) SetApplicationLayerAutomaticResponseConfiguration(v *ApplicationLayerAutomaticResponseConfiguration) *Protection { + s.ApplicationLayerAutomaticResponseConfiguration = v + return s +} + // SetHealthCheckIds sets the HealthCheckIds field's value. func (s *Protection) SetHealthCheckIds(v []*string) *Protection { s.HealthCheckIds = v @@ -7505,6 +8182,58 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// Specifies the action setting that Shield Advanced should use in the WAF rules +// that it creates on behalf of the protected resource in response to DDoS attacks. +// You specify this as part of the configuration for the automatic application +// layer DDoS mitigation feature, when you enable or update automatic mitigation. +// Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, +// inside the web ACL that you have associated with the resource. +type ResponseAction struct { + _ struct{} `type:"structure"` + + // Specifies that Shield Advanced should configure its WAF rules with the WAF + // Block action. + // + // You must specify exactly one action, either Block or Count. + Block *BlockAction `type:"structure"` + + // Specifies that Shield Advanced should configure its WAF rules with the WAF + // Count action. + // + // You must specify exactly one action, either Block or Count. + Count *CountAction `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 ResponseAction) 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 ResponseAction) GoString() string { + return s.String() +} + +// SetBlock sets the Block field's value. +func (s *ResponseAction) SetBlock(v *BlockAction) *ResponseAction { + s.Block = v + return s +} + +// SetCount sets the Count field's value. +func (s *ResponseAction) SetCount(v *CountAction) *ResponseAction { + s.Count = v + return s +} + // The attack information for the specified SubResource. type SubResourceSummary struct { _ struct{} `type:"structure"` @@ -7594,8 +8323,7 @@ type Subscription struct { // or to initiate proactive customer support. ProactiveEngagementStatus *string `type:"string" enum:"ProactiveEngagementStatus"` - // The start time of the subscription, in Unix time in seconds. For more information - // see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The start time of the subscription, in Unix time in seconds. StartTime *time.Time `type:"timestamp"` // The ARN (Amazon Resource Name) of the subscription. @@ -8005,12 +8733,10 @@ func (s TagResourceOutput) GoString() string { type TimeRange struct { _ struct{} `type:"structure"` - // The start time, in Unix time in seconds. For more information see timestamp - // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The start time, in Unix time in seconds. FromInclusive *time.Time `type:"timestamp"` - // The end time, in Unix time in seconds. For more information see timestamp - // (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types). + // The end time, in Unix time in seconds. ToExclusive *time.Time `type:"timestamp"` } @@ -8130,6 +8856,96 @@ func (s UntagResourceOutput) GoString() string { return s.String() } +type UpdateApplicationLayerAutomaticResponseInput struct { + _ struct{} `type:"structure"` + + // Specifies the action setting that Shield Advanced should use in the WAF rules + // that it creates on behalf of the protected resource in response to DDoS attacks. + // You specify this as part of the configuration for the automatic application + // layer DDoS mitigation feature, when you enable or update automatic mitigation. + // Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, + // inside the web ACL that you have associated with the resource. + // + // Action is a required field + Action *ResponseAction `type:"structure" required:"true"` + + // The ARN (Amazon Resource Name) of the resource. + // + // ResourceArn is a required field + ResourceArn *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 UpdateApplicationLayerAutomaticResponseInput) 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 UpdateApplicationLayerAutomaticResponseInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateApplicationLayerAutomaticResponseInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateApplicationLayerAutomaticResponseInput"} + if s.Action == nil { + invalidParams.Add(request.NewErrParamRequired("Action")) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAction sets the Action field's value. +func (s *UpdateApplicationLayerAutomaticResponseInput) SetAction(v *ResponseAction) *UpdateApplicationLayerAutomaticResponseInput { + s.Action = v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UpdateApplicationLayerAutomaticResponseInput) SetResourceArn(v string) *UpdateApplicationLayerAutomaticResponseInput { + s.ResourceArn = &v + return s +} + +type UpdateApplicationLayerAutomaticResponseOutput 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 UpdateApplicationLayerAutomaticResponseOutput) 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 UpdateApplicationLayerAutomaticResponseOutput) GoString() string { + return s.String() +} + type UpdateEmergencyContactSettingsInput struct { _ struct{} `type:"structure"` @@ -8452,6 +9268,22 @@ func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { return s } +const ( + // ApplicationLayerAutomaticResponseStatusEnabled is a ApplicationLayerAutomaticResponseStatus enum value + ApplicationLayerAutomaticResponseStatusEnabled = "ENABLED" + + // ApplicationLayerAutomaticResponseStatusDisabled is a ApplicationLayerAutomaticResponseStatus enum value + ApplicationLayerAutomaticResponseStatusDisabled = "DISABLED" +) + +// ApplicationLayerAutomaticResponseStatus_Values returns all elements of the ApplicationLayerAutomaticResponseStatus enum +func ApplicationLayerAutomaticResponseStatus_Values() []string { + return []string{ + ApplicationLayerAutomaticResponseStatusEnabled, + ApplicationLayerAutomaticResponseStatusDisabled, + } +} + const ( // AttackLayerNetwork is a AttackLayer enum value AttackLayerNetwork = "NETWORK" diff --git a/service/shield/errors.go b/service/shield/errors.go index ca8e544aad7..7a732c12d45 100644 --- a/service/shield/errors.go +++ b/service/shield/errors.go @@ -43,7 +43,8 @@ const ( // "InvalidPaginationTokenException". // // Exception that indicates that the NextToken specified in the request is invalid. - // Submit the request using the NextToken value that was returned in the response. + // Submit the request using the NextToken value that was returned in the prior + // response. ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException" // ErrCodeInvalidParameterException for service response error code diff --git a/service/shield/shieldiface/interface.go b/service/shield/shieldiface/interface.go index 2e662e2d1fb..2c0ebddc0af 100644 --- a/service/shield/shieldiface/interface.go +++ b/service/shield/shieldiface/interface.go @@ -128,6 +128,10 @@ type ShieldAPI interface { DescribeSubscriptionWithContext(aws.Context, *shield.DescribeSubscriptionInput, ...request.Option) (*shield.DescribeSubscriptionOutput, error) DescribeSubscriptionRequest(*shield.DescribeSubscriptionInput) (*request.Request, *shield.DescribeSubscriptionOutput) + DisableApplicationLayerAutomaticResponse(*shield.DisableApplicationLayerAutomaticResponseInput) (*shield.DisableApplicationLayerAutomaticResponseOutput, error) + DisableApplicationLayerAutomaticResponseWithContext(aws.Context, *shield.DisableApplicationLayerAutomaticResponseInput, ...request.Option) (*shield.DisableApplicationLayerAutomaticResponseOutput, error) + DisableApplicationLayerAutomaticResponseRequest(*shield.DisableApplicationLayerAutomaticResponseInput) (*request.Request, *shield.DisableApplicationLayerAutomaticResponseOutput) + DisableProactiveEngagement(*shield.DisableProactiveEngagementInput) (*shield.DisableProactiveEngagementOutput, error) DisableProactiveEngagementWithContext(aws.Context, *shield.DisableProactiveEngagementInput, ...request.Option) (*shield.DisableProactiveEngagementOutput, error) DisableProactiveEngagementRequest(*shield.DisableProactiveEngagementInput) (*request.Request, *shield.DisableProactiveEngagementOutput) @@ -144,6 +148,10 @@ type ShieldAPI interface { DisassociateHealthCheckWithContext(aws.Context, *shield.DisassociateHealthCheckInput, ...request.Option) (*shield.DisassociateHealthCheckOutput, error) DisassociateHealthCheckRequest(*shield.DisassociateHealthCheckInput) (*request.Request, *shield.DisassociateHealthCheckOutput) + EnableApplicationLayerAutomaticResponse(*shield.EnableApplicationLayerAutomaticResponseInput) (*shield.EnableApplicationLayerAutomaticResponseOutput, error) + EnableApplicationLayerAutomaticResponseWithContext(aws.Context, *shield.EnableApplicationLayerAutomaticResponseInput, ...request.Option) (*shield.EnableApplicationLayerAutomaticResponseOutput, error) + EnableApplicationLayerAutomaticResponseRequest(*shield.EnableApplicationLayerAutomaticResponseInput) (*request.Request, *shield.EnableApplicationLayerAutomaticResponseOutput) + EnableProactiveEngagement(*shield.EnableProactiveEngagementInput) (*shield.EnableProactiveEngagementOutput, error) EnableProactiveEngagementWithContext(aws.Context, *shield.EnableProactiveEngagementInput, ...request.Option) (*shield.EnableProactiveEngagementOutput, error) EnableProactiveEngagementRequest(*shield.EnableProactiveEngagementInput) (*request.Request, *shield.EnableProactiveEngagementOutput) @@ -192,6 +200,10 @@ type ShieldAPI interface { UntagResourceWithContext(aws.Context, *shield.UntagResourceInput, ...request.Option) (*shield.UntagResourceOutput, error) UntagResourceRequest(*shield.UntagResourceInput) (*request.Request, *shield.UntagResourceOutput) + UpdateApplicationLayerAutomaticResponse(*shield.UpdateApplicationLayerAutomaticResponseInput) (*shield.UpdateApplicationLayerAutomaticResponseOutput, error) + UpdateApplicationLayerAutomaticResponseWithContext(aws.Context, *shield.UpdateApplicationLayerAutomaticResponseInput, ...request.Option) (*shield.UpdateApplicationLayerAutomaticResponseOutput, error) + UpdateApplicationLayerAutomaticResponseRequest(*shield.UpdateApplicationLayerAutomaticResponseInput) (*request.Request, *shield.UpdateApplicationLayerAutomaticResponseOutput) + UpdateEmergencyContactSettings(*shield.UpdateEmergencyContactSettingsInput) (*shield.UpdateEmergencyContactSettingsOutput, error) UpdateEmergencyContactSettingsWithContext(aws.Context, *shield.UpdateEmergencyContactSettingsInput, ...request.Option) (*shield.UpdateEmergencyContactSettingsOutput, error) UpdateEmergencyContactSettingsRequest(*shield.UpdateEmergencyContactSettingsInput) (*request.Request, *shield.UpdateEmergencyContactSettingsOutput)