The type of configurations contained in the profile. AppConfig supports\n feature flags and freeform configurations. We recommend you\n create feature flag configurations to enable or disable new features and freeform\n configurations to distribute configurations to an application. When calling this API, enter\n one of the following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The Amazon Resource Name of the Key Management Service key to encrypt new configuration data\n versions in the AppConfig hosted configuration store. This\n attribute is only used for hosted configuration types. To encrypt data managed\n in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
" + } } } }, @@ -1833,6 +1845,12 @@ "traits": { "smithy.api#documentation": "The type of configurations contained in the profile. AppConfig supports\n feature flags and freeform configurations. We recommend you\n create feature flag configurations to enable or disable new features and freeform\n configurations to distribute configurations to an application. When calling this API, enter\n one of the following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The identifier for an Key Management Service key to encrypt new configuration\n data versions in the AppConfig hosted configuration store. This attribute is only\n used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias.\n To encrypt data managed in other configuration stores, see the documentation for how to\n specify an KMS key for that particular service.
A name for the extension. Each extension name in your account must be unique. Extension\n versions use the same name.
", "smithy.api#required": {} @@ -2840,9 +2858,9 @@ } }, "KmsKeyIdentifier": { - "target": "com.amazonaws.appconfig#Identifier", + "target": "com.amazonaws.appconfig#KmsKeyIdentifier", "traits": { - "smithy.api#documentation": "The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
" + "smithy.api#documentation": "The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
" } }, "VersionLabel": { @@ -3413,6 +3431,12 @@ } } }, + "com.amazonaws.appconfig#ExtensionOrParameterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\/#:\\n]{1,64}$" + } + }, "com.amazonaws.appconfig#ExtensionSummaries": { "type": "list", "member": { @@ -4145,6 +4169,13 @@ "smithy.api#documentation": "A user-defined label for an AppConfig hosted configuration version.
", "smithy.api#httpHeader": "VersionLabel" } + }, + "KmsKeyArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the Key Management Service key that was used to encrypt this\n specific version of the configuration data in the AppConfig hosted configuration\n store.
", + "smithy.api#httpHeader": "KmsKeyArn" + } } } }, @@ -4187,6 +4218,12 @@ "traits": { "smithy.api#documentation": "A user-defined label for an AppConfig hosted configuration version.
" } + }, + "KmsKeyArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the Key Management Service key that was used to encrypt this\n specific version of the configuration data in the AppConfig hosted configuration\n store.
" + } } }, "traits": { @@ -4300,6 +4337,18 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.appconfig#KmsKeyIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$" + } + }, + "com.amazonaws.appconfig#KmsKeyIdentifierOrEmpty": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\s{0,1}|[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$" + } + }, "com.amazonaws.appconfig#ListApplications": { "type": "operation", "input": { @@ -5093,7 +5142,7 @@ "com.amazonaws.appconfig#ParameterMap": { "type": "map", "key": { - "target": "com.amazonaws.appconfig#Name" + "target": "com.amazonaws.appconfig#ExtensionOrParameterName" }, "value": { "target": "com.amazonaws.appconfig#Parameter" @@ -5108,7 +5157,7 @@ "com.amazonaws.appconfig#ParameterValueMap": { "type": "map", "key": { - "target": "com.amazonaws.appconfig#Name" + "target": "com.amazonaws.appconfig#ExtensionOrParameterName" }, "value": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And2048" @@ -5229,7 +5278,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of one more AppConfig resources exceeds the maximum allowed. Verify that your\n environment doesn't exceed the following service quotas:
\nApplications: 100 max
\nDeployment strategies: 20 max
\nConfiguration profiles: 100 max per application
\nEnvironments: 20 max per application
\nTo resolve this issue, you can delete one or more resources and try again. Or, you\n can request a quota increase. For more information about quotas and to request an increase,\n see Service quotas for AppConfig in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The number of one more AppConfig resources exceeds the maximum allowed. Verify that your\n environment doesn't exceed the following service quotas:
\nApplications: 100 max
\nDeployment strategies: 20 max
\nConfiguration profiles: 100 max per application
\nEnvironments: 20 max per application
\nTo resolve this issue, you can delete one or more resources and try again. Or, you can\n request a quota increase. For more information about quotas and to request an increase, see\n Service quotas for AppConfig in the Amazon Web Services General Reference.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5318,7 +5367,7 @@ } }, "KmsKeyIdentifier": { - "target": "com.amazonaws.appconfig#Identifier", + "target": "com.amazonaws.appconfig#KmsKeyIdentifier", "traits": { "smithy.api#documentation": "The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
" } @@ -5809,6 +5858,12 @@ "traits": { "smithy.api#documentation": "A list of methods for validating the configuration.
" } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.appconfig#KmsKeyIdentifierOrEmpty", + "traits": { + "smithy.api#documentation": "The identifier for a Key Management Service key to encrypt new configuration\n data versions in the AppConfig hosted configuration store. This attribute is only\n used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias.\n To encrypt data managed in other configuration stores, see the documentation for how to\n specify an KMS key for that particular service.
The content of the flow.
" + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
" } }, "Tags": { @@ -3604,7 +3604,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowModuleContent", "traits": { - "smithy.api#documentation": "The content of the flow module.
" + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
" } }, "Description": { @@ -4405,7 +4405,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowContent", "traits": { - "smithy.api#documentation": "The content of the flow.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", "smithy.api#required": {} } }, @@ -5553,7 +5553,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nCreates a security profile.
", + "smithy.api#documentation": "Creates a security profile.
", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{InstanceId}", @@ -6238,7 +6238,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new view with the possible status of SAVED or PUBLISHED.
The views will have a unique name for each connect instance.
\nIt performs basic content validation if the status is SAVED or full content validation if the status \n is set to PUBLISHED. An error is returned if validation fails. It associates either \n the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the \n provided view content based on the status. The view is idempotent if ClientToken is provided.
Creates a new view with the possible status of SAVED or\n PUBLISHED.
The views will have a unique name for each connect instance.
\nIt performs basic content validation if the status is SAVED or full content\n validation if the status is set to PUBLISHED. An error is returned if validation\n fails. It associates either the $SAVED qualifier or both of the $SAVED\n and $LATEST qualifiers with the provided view content based on the status. The view\n is idempotent if ClientToken is provided.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of \n the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6261,20 +6261,20 @@ "ClientToken": { "target": "com.amazonaws.connect#ViewsClientToken", "traits": { - "smithy.api#documentation": "A unique Id for each create view request to avoid duplicate view creation. For example, the view \n is idempotent ClientToken is provided.
" + "smithy.api#documentation": "A unique Id for each create view request to avoid duplicate view creation. For example, the\n view is idempotent ClientToken is provided.
" } }, "Status": { "target": "com.amazonaws.connect#ViewStatus", "traits": { - "smithy.api#documentation": "Indicates the view status as either SAVED or PUBLISHED. The \n PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content.
View content containing all content necessary to render a view except for runtime input data.
\nThe total uncompressed content has a maximum file size of 400kB.
", + "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime input\n data.
\nThe total uncompressed content has a maximum file size of 400kB.
", "smithy.api#required": {} } }, @@ -6294,7 +6294,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags associated with the view resource (not specific to view version).These tags can be used \n to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags associated with the view resource (not specific to view version).These tags can be\n used to organize, track, or control access for this resource. For example, { \"tags\":\n {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6351,7 +6351,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes a new version of the view identifier.
\nVersions are immutable and monotonically increasing.
\nIt returns the highest version if there is no change in content compared to that version. An error \n is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the \n $LATEST alias.
Publishes a new version of the view identifier.
\nVersions are immutable and monotonically increasing.
\nIt returns the highest version if there is no change in content compared to that version. An\n error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of\n the $LATEST alias.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6374,7 +6374,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
This API is in preview release for Amazon Connect and is subject to change.
\nDeletes a security profile.
", + "smithy.api#documentation": "Deletes a security profile.
", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", @@ -8049,7 +8049,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
", + "smithy.api#documentation": "Deletes the view entirely. It deletes the view and all associated qualifiers (versions and\n aliases).
", "smithy.api#http": { "method": "DELETE", "uri": "/views/{InstanceId}/{ViewId}", @@ -8063,7 +8063,7 @@ "InstanceId": { "target": "com.amazonaws.connect#ViewsInstanceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8071,7 +8071,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8142,7 +8142,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
This API is in preview release for Amazon Connect and is subject to change.
\nGets basic information about the security profle.
", + "smithy.api#documentation": "Gets basic information about the security profle.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", @@ -9786,7 +9786,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the view for the specified Amazon Connect instance and view identifier.
\nThe view identifier can be supplied as a ViewId or ARN.
\n\n $SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, $SAVED | $LATEST. \n If it is not supplied, then $LATEST is assumed for customer managed views and an error is \n returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
Retrieves the view for the specified Amazon Connect instance and view identifier.
\nThe view identifier can be supplied as a ViewId or ARN.
\n\n $SAVED needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example,\n $SAVED | $LATEST. If it is not supplied, then\n $LATEST is assumed for customer managed views and an error is returned if there is\n no published content available. Version 1 is assumed for Amazon Web Services managed views.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12815,7 +12815,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 35 days, in 24-hour\n intervals.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator's Guide.
Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator's Guide.
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be before the end time timestamp. The time\n range between the start and end time must be less than 24 hours. The start time cannot be earlier\n than 35 days before the time of the request. Historical metrics are available for 35 days.
", + "smithy.api#documentation": "The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be before the end time timestamp. The start\n and end time depends on the IntervalPeriod selected. By default the time range between\n start and end time is 35 days. Historical metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time timestamp. It\n cannot be later than the current timestamp.
\nThe time range between the start and end time must be less than 24 hours.
", + "smithy.api#documentation": "The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time timestamp. It\n cannot be later than the current timestamp.
", "smithy.api#required": {} } }, + "Interval": { + "target": "com.amazonaws.connect#IntervalDetails", + "traits": { + "smithy.api#documentation": "The interval period and timezone to apply to returned metrics.
\n\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and\n EndTime based on which IntervalPeriod is requested.
\n FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3\n days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and\n EndTime must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and\n EndTime must be less than 35 days.
\n TOTAL: The difference between StartTime and\n EndTime must be less than 35 days.
\n TimeZone: The timezone applied to requested metrics.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThe Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe timezone applied to requested metrics.
" + } + }, + "IntervalPeriod": { + "target": "com.amazonaws.connect#IntervalPeriod", + "traits": { + "smithy.api#documentation": "\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime\n based on what IntervalPeriod is requested.
\n FIFTEEN_MIN: The\n difference between StartTime and EndTime must be less than 3\n days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and EndTime\n must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and EndTime\n must be less than 35 days.
\n TOTAL: The difference between StartTime and EndTime\n must be less than 35 days.
Information about the interval period to use for returning results.
" + } + }, + "com.amazonaws.connect#IntervalPeriod": { + "type": "enum", + "members": { + "FIFTEEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MIN" + } + }, + "THIRTY_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRTY_MIN" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL" + } + } + } + }, "com.amazonaws.connect#InvalidContactFlowException": { "type": "structure", "members": { @@ -17674,7 +17741,7 @@ "Applications": { "target": "com.amazonaws.connect#Applications", "traits": { - "smithy.api#documentation": "A list of the third party application's metadata.
" + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nA list of the third party application's metadata.
" } }, "NextToken": { @@ -17714,7 +17781,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nLists the permissions granted to a security profile.
", + "smithy.api#documentation": "Lists the permissions granted to a security profile.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles-permissions/{InstanceId}/{SecurityProfileId}", @@ -18533,7 +18600,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns all the available versions for the specified Amazon Connect instance and view identifier.
\nResults will be sorted from highest to lowest.
", + "smithy.api#documentation": "Returns all the available versions for the specified Amazon Connect instance and view\n identifier.
\nResults will be sorted from highest to lowest.
", "smithy.api#http": { "method": "GET", "uri": "/views/{InstanceId}/{ViewId}/versions", @@ -18553,7 +18620,7 @@ "InstanceId": { "target": "com.amazonaws.connect#ViewsInstanceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18561,7 +18628,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
The token for the next set of results. Use the value returned in the previous response in the next request to \n retrieve the next set of results.
", + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -18598,7 +18665,7 @@ "NextToken": { "target": "com.amazonaws.connect#ViewsNextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to \n retrieve the next set of results.
" + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" } } }, @@ -18655,7 +18722,7 @@ "InstanceId": { "target": "com.amazonaws.connect#ViewsInstanceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18670,7 +18737,7 @@ "NextToken": { "target": "com.amazonaws.connect#ViewsNextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to \n retrieve the next set of results.
", + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -18699,7 +18766,7 @@ "NextToken": { "target": "com.amazonaws.connect#ViewsNextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to \n retrieve the next set of results.
" + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" } } }, @@ -18881,6 +18948,13 @@ "traits": { "smithy.api#documentation": "The values to use for filtering data.
\nValid metric filter values for INITIATION_METHOD: INBOUND |\n OUTBOUND | TRANSFER | QUEUE_TRANSFER |\n CALLBACK | API\n
Valid metric filter values for DISCONNECT_REASON:\n CUSTOMER_DISCONNECT | AGENT_DISCONNECT |\n THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |\n CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED |\n API\n
The flag to use to filter on requested metric filter values or to not filter on requested\n metric filter values. By default the negate is false, which indicates to filter on\n the requested metric filter.
The interval period provided in the API request.
" + } + }, + "StartTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp, in UNIX Epoch time format. Start time is based on the interval period\n selected.
" + } + }, + "EndTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp, in UNIX Epoch time format. End time is based on the interval period selected.\n For example, If IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime in the API request differs by 1 day, then 48\n results are returned in the response. Each result is aggregated by the 30 minutes period, with\n each StartTime and EndTime differing by 30 minutes.
The interval period with the start and end time for the metrics.
" + } + }, "com.amazonaws.connect#MetricNameV2": { "type": "string" }, @@ -18923,6 +19023,12 @@ "smithy.api#documentation": "The dimension for the metrics.
" } }, + "MetricInterval": { + "target": "com.amazonaws.connect#MetricInterval", + "traits": { + "smithy.api#documentation": "The interval period with the start and end time for the metrics.
" + } + }, "Collections": { "target": "com.amazonaws.connect#MetricDataCollectionsV2", "traits": { @@ -23231,7 +23337,7 @@ "SendNotificationAction": { "target": "com.amazonaws.connect#SendNotificationActionDefinition", "traits": { - "smithy.api#documentation": "Information about the send notification action.
\nSupported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |\n OnMetricDataUpdate\n
Information about the send notification action.
\nSupported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |\n OnMetricDataUpdate\n
The JSON string that represents flow's content. For an example, see Example\n contact flow in Amazon Connect Flow language.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", "smithy.api#required": {} } } @@ -27792,7 +27898,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowModuleContent", "traits": { - "smithy.api#documentation": "The content of the flow module.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
", "smithy.api#required": {} } } @@ -29667,7 +29773,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nUpdates a security profile.
", + "smithy.api#documentation": "Updates a security profile.
", "smithy.api#http": { "method": "POST", "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", @@ -30474,7 +30580,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the view content of the given view identifier in the specified Amazon Connect instance.
\nIt performs content validation if Status is set to SAVED and performs full content validation if \n Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, \n but the $LATEST alias' content will only be updated if Status is PUBLISHED.
Updates the view content of the given view identifier in the specified Amazon Connect\n instance.
\nIt performs content validation if Status is set to SAVED and\n performs full content validation if Status is PUBLISHED. Note that the\n $SAVED alias' content will always be updated, but the $LATEST alias'\n content will only be updated if Status is PUBLISHED.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -30496,7 +30602,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
Indicates the view status as either SAVED or PUBLISHED. The \n PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content.
View content containing all content necessary to render a view except for runtime input data \n and the runtime input schema, which is auto-generated by this operation.
\nThe total uncompressed content has a maximum file size of 400kB.
", + "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime input data\n and the runtime input schema, which is auto-generated by this operation.
\nThe total uncompressed content has a maximum file size of 400kB.
", "smithy.api#required": {} } } @@ -30569,7 +30675,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the view metadata. Note that either Name or Description \n must be provided.
Updates the view metadata. Note that either Name or Description\n must be provided.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -30591,7 +30697,7 @@ "ViewId": { "target": "com.amazonaws.connect#ViewId", "traits": { - "smithy.api#documentation": "The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the view. Both ViewArn and ViewId can be\n used.
Indicates the view status as either SAVED or PUBLISHED. The \n PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content.
View content containing all content necessary to render a view except for runtime input data.
" + "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime input\n data.
" } }, "Tags": { @@ -31289,7 +31395,7 @@ "LastModifiedTime": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
Latest timestamp of the UpdateViewContent or CreateViewVersion\n operations.
View content containing all content necessary to render a view except for runtime input data.
" + "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime input\n data.
" } }, "com.amazonaws.connect#ViewContentSha256": { @@ -31393,7 +31499,7 @@ } }, "traits": { - "smithy.api#documentation": "View content containing all content necessary to render a view except \n for runtime input data and the runtime input schema, which is auto-generated \n by this operation.
" + "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime input data\n and the runtime input schema, which is auto-generated by this operation.
" } }, "com.amazonaws.connect#ViewInputSchema": { @@ -31460,7 +31566,7 @@ "Status": { "target": "com.amazonaws.connect#ViewStatus", "traits": { - "smithy.api#documentation": "Indicates the view status as either SAVED or PUBLISHED. The \n PUBLISHED status will initiate validation on the content.
Indicates the view status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content.
Specifies the target (for example, a column name) where a prediction can be\n accepted.
" + } + }, + "predictionChoice": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Specifies the prediction (aka, the automatically generated piece of metadata) that can\n be accepted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the prediction (aka, the automatically generated piece of metadata) and the\n target (for example, a column name) that can be accepted.
" + } + }, + "com.amazonaws.datazone#AcceptChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AcceptChoice" + } + }, + "com.amazonaws.datazone#AcceptPredictions": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AcceptPredictionsInput" + }, + "output": { + "target": "com.amazonaws.datazone#AcceptPredictionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts automatically generated business-friendly metadata for your Amazon DataZone\n assets.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/accept-predictions" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#AcceptPredictionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpQuery": "revision" + } + }, + "acceptRule": { + "target": "com.amazonaws.datazone#AcceptRule", + "traits": { + "smithy.api#documentation": "Specifies the rule (or the conditions) under which a prediction can be accepted.
" + } + }, + "acceptChoices": { + "target": "com.amazonaws.datazone#AcceptChoices", + "traits": { + "smithy.api#documentation": "" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request. This field is\n automatically populated if not provided.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#AcceptPredictionsOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AcceptRule": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.datazone#AcceptRuleBehavior", + "traits": { + "smithy.api#documentation": "Specifies whether you want to accept the top prediction for all targets or none.
" + } + }, + "threshold": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The confidence score that specifies the condition at which a prediction can be\n accepted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the rule and the threshold under which a prediction can be accepted.
" + } + }, + "com.amazonaws.datazone#AcceptRuleBehavior": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.datazone#AcceptSubscriptionRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AcceptSubscriptionRequestInput" + }, + "output": { + "target": "com.amazonaws.datazone#AcceptSubscriptionRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts a subscription request to a specific asset.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}/accept" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#AcceptSubscriptionRequestInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The Amazon DataZone domain where the specified subscription request is being accepted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the subscription request that is to be accepted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "A description that specifies the reason for accepting the specified subscription\n request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#AcceptSubscriptionRequestOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "Specifies the Amazon DataZone user that accepted the specified subscription request.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "Specifies the Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone domain where the specified subscription request\n was accepted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "Specifies the status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp that specifies when the subscription request was accepted.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "Specifies the timestamp when subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "Specifies the reason for requesting a subscription to the asset.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipals", + "traits": { + "smithy.api#documentation": "Specifies the Amazon DataZone users who are subscribed to the asset specified in the\n subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "Specifies the asset for which the subscription request was created.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifes the ID of the Amazon DataZone user who reviewed the subscription request.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "Specifies the reason for accepting the subscription request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.datazone#ActionLink": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#ApplicableAssetTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#TypeName" + } + }, + "com.amazonaws.datazone#Asset": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier" + } + }, + "properties": { + "id": { + "target": "com.amazonaws.datazone#AssetId" + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "revision": { + "target": "com.amazonaws.datazone#Revision" + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier" + }, + "listing": { + "target": "com.amazonaws.datazone#AssetListingDetails" + }, + "name": { + "target": "com.amazonaws.datazone#AssetName" + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier" + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms" + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList" + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList" + }, + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList" + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateAsset" + }, + "read": { + "target": "com.amazonaws.datazone#GetAsset" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteAsset" + }, + "operations": [ + { + "target": "com.amazonaws.datazone#CreateAssetRevision" + } + ] + }, + "com.amazonaws.datazone#AssetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#AssetIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#AssetItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the inventory asset exists.
", + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "the identifier of the Amazon DataZone inventory asset.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone inventory asset.
", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the asset type of the specified Amazon DataZone inventory asset.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the inventory asset type.
", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "The external identifier of the Amazon DataZone inventory asset.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of an Amazon DataZone inventory asset.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the Amazon DataZone inventory asset was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the inventory asset.
" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the first revision of the inventory asset was created.
" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the first revision of the inventory asset.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms attached to the Amazon DataZone inventory asset.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project that owns the inventory asset.
", + "smithy.api#required": {} + } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#AssetItemAdditionalAttributes", + "traits": { + "smithy.api#documentation": "The additional attributes of a Amazon DataZone inventory asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A Amazon DataZone inventory asset.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.datazone#Asset" + } + ] + } + }, + "com.amazonaws.datazone#AssetItemAdditionalAttributes": { + "type": "structure", + "members": { + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The forms included in the additional attributes of an inventory asset.
" + } + }, + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The read-only forms included in the additional attributes of an inventory asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The additional attributes of an inventory asset.
" + } + }, + "com.amazonaws.datazone#AssetListing": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of an asset published in an Amazon DataZone catalog.
" + } + }, + "assetRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of an asset published in an Amazon DataZone catalog.
" + } + }, + "assetType": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The type of an asset published in an Amazon DataZone catalog.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when an asset published in an Amazon DataZone catalog was created.
" + } + }, + "forms": { + "target": "com.amazonaws.datazone#Forms", + "traits": { + "smithy.api#documentation": "The metadata forms attached to an asset published in an Amazon DataZone catalog.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms attached to an asset published in an Amazon DataZone catalog.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project where an asset published in an Amazon DataZone catalog exists.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "An asset published in an Amazon DataZone catalog.
" + } + }, + "com.amazonaws.datazone#AssetListingDetails": { + "type": "structure", + "members": { + "listingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of an asset published in an Amazon DataZone catalog.
", + "smithy.api#required": {} + } + }, + "listingStatus": { + "target": "com.amazonaws.datazone#ListingStatus", + "traits": { + "smithy.api#documentation": "The status of an asset published in an Amazon DataZone catalog.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an asset published in an Amazon DataZone catalog.
" + } + }, + "com.amazonaws.datazone#AssetListingItem": { + "type": "structure", + "members": { + "listingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the listing (asset published in Amazon DataZone catalog).
" + } + }, + "listingRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the listing (asset published in Amazon DataZone catalog).
" + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "The name of the inventory asset.
" + } + }, + "entityId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the inventory asset.
" + } + }, + "entityRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the inventory asset.
" + } + }, + "entityType": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The type of the inventory asset.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of an asset published in an Amazon DataZone catalog.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when an asset published in an Amazon DataZone catalog was created.
" + } + }, + "listingCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the listing.
" + } + }, + "listingUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the listing.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerms", + "traits": { + "smithy.api#documentation": "Glossary terms attached to the inventory asset.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that owns the inventory asset.
" + } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#AssetListingItemAdditionalAttributes", + "traits": { + "smithy.api#documentation": "The additional attributes of an asset published in an Amazon DataZone catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an asset published in an Amazon DataZone catalog.
" + } + }, + "com.amazonaws.datazone#AssetListingItemAdditionalAttributes": { + "type": "structure", + "members": { + "forms": { + "target": "com.amazonaws.datazone#Forms", + "traits": { + "smithy.api#documentation": "The metadata forms that form additional attributes of the metadata asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional attributes of an inventory asset.
" + } + }, + "com.amazonaws.datazone#AssetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#AssetRevision": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the inventory asset.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the inventory asset revision.
" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision details of the inventory asset.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the asset revision.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when an inventory asset revison was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The revision of an inventory asset.
" + } + }, + "com.amazonaws.datazone#AssetRevisions": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AssetRevision" + } + }, + "com.amazonaws.datazone#AssetTargetNameMap": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the inventory asset.
", + "smithy.api#required": {} + } + }, + "targetName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The target name in the asset target name map.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.datazone#AssetTargetNames": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AssetTargetNameMap" + } + }, + "com.amazonaws.datazone#AssetType": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier" + }, + "revision": { + "target": "com.amazonaws.datazone#Revision" + } + }, + "properties": { + "name": { + "target": "com.amazonaws.datazone#TypeName" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormsInputMap" + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateAssetType" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.datazone#DeleteAssetType" + }, + { + "target": "com.amazonaws.datazone#GetAssetType" + } + ] + }, + "com.amazonaws.datazone#AssetTypeIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 385 + }, + "smithy.api#pattern": "^(?!\\.)[\\w\\.]*\\w$" + } + }, + "com.amazonaws.datazone#AssetTypeItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain where the asset type exists.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The name of the asset type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the asset type.
" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap", + "traits": { + "smithy.api#documentation": "The forms included in the details of the asset type.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project that owns the asset type.
", + "smithy.api#required": {} + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain where the asset type was originally\n created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project where the asset type exists.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset type was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the asset type.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset type was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the asset type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the asset type.
" + } + }, + "com.amazonaws.datazone#Attribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.datazone#AuthType": { + "type": "enum", + "members": { + "IAM_IDC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_IDC" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#AuthorizedPrincipalIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9:/_-]*$" + } + }, + "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.datazone#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.datazone#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$" + } + }, + "com.amazonaws.datazone#BusinessNameGenerationConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the business name generation is enabled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the business name generation.
" + } + }, + "com.amazonaws.datazone#CancelSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CancelSubscriptionInput" + }, + "output": { + "target": "com.amazonaws.datazone#CancelSubscriptionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels the subscription to the specified asset.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CancelSubscriptionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone domain where the subscription request is being\n cancelled.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the subscription that is being cancelled.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CancelSubscriptionOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "Specifies the Amazon DataZone user who is cancelling the subscription.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user that cancelled the subscription.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone domain where the subscription is being\n cancelled.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "The status of the request to cancel the subscription.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp that specifies when the request to cancel the subscription was\n created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp that specifies when the subscription was cancelled.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipal": { + "target": "com.amazonaws.datazone#SubscribedPrincipal", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who is made a subscriber to the specified asset by the subscription\n that is being cancelled.
", + "smithy.api#required": {} + } + }, + "subscribedListing": { + "target": "com.amazonaws.datazone#SubscribedListing", + "traits": { + "smithy.api#documentation": "The asset to which a subscription is being cancelled.
", + "smithy.api#required": {} + } + }, + "subscriptionRequestId": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The unique ID of the subscripton request for the subscription that is being\n cancelled.
" + } + }, + "retainPermissions": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the permissions to the asset are retained after the subscription is\n cancelled.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ChangeAction": { + "type": "enum", + "members": { + "PUBLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISH" + } + }, + "UNPUBLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNPUBLISH" + } + } + } + }, + "com.amazonaws.datazone#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\x21-\\x7E]+$" + } + }, + "com.amazonaws.datazone#CloudFormationProperties": { + "type": "structure", + "members": { + "templateUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The template URL of the cloud formation provisioning properties of the environment\n blueprint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the provisioning properties of the environment blueprint.
" + } + }, + "com.amazonaws.datazone#ConfigurableActionParameter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key of the configurable action parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the configurable action parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the parameters for the configurable environment action.
" + } + }, + "com.amazonaws.datazone#ConfigurableActionParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ConfigurableActionParameter" + } + }, + "com.amazonaws.datazone#ConfigurableActionTypeAuthorization": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + } + } + }, + "com.amazonaws.datazone#ConfigurableEnvironmentAction": { + "type": "structure", + "members": { + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of a configurable action in a Amazon DataZone environment.
", + "smithy.api#required": {} + } + }, + "auth": { + "target": "com.amazonaws.datazone#ConfigurableActionTypeAuthorization", + "traits": { + "smithy.api#documentation": "The authentication type of a configurable action of a Amazon DataZone environment.
" + } + }, + "parameters": { + "target": "com.amazonaws.datazone#ConfigurableActionParameterList", + "traits": { + "smithy.api#documentation": "The parameters of a configurable action in a Amazon DataZone environment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configurable action of a Amazon DataZone environment.
" + } + }, + "com.amazonaws.datazone#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "There is a conflict while performing this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.datazone#CreateAsset": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAssetInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAssetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an asset in Amazon DataZone catalog.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/assets" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateAssetInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "Asset name.
", + "smithy.api#required": {} + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "Amazon DataZone domain where the asset is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "" + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of this asset's type.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of this asset's type.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "Asset description.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "Glossary terms attached to the asset.
" + } + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList", + "traits": { + "smithy.api#documentation": "Metadata forms attached to the asset.
" + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The unique identifier of the project that owns this asset.
", + "smithy.api#required": {} + } + }, + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the automatically generated business-friendly metadata for the\n asset.
", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateAssetOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created asset.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "The name of the created asset.
", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the created asset type.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision type of the asset.
", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the created asset.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user that created this asset in the catalog.
" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the first revision of the asset took place.
" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user that made the first revision of the asset.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that are attached to the created asset.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project that owns the created asset.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset was created.
", + "smithy.api#required": {} + } + }, + "listing": { + "target": "com.amazonaws.datazone#AssetListingDetails", + "traits": { + "smithy.api#documentation": "" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata forms that are attached to the created asset.
", + "smithy.api#required": {} + } + }, + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The read-only metadata forms that are attached to the created asset.
" + } + }, + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the automatically generated business-friendly metadata for the\n asset.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateAssetRevision": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAssetRevisionInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAssetRevisionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a revision of the asset.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/revisions" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateAssetRevisionInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "Te revised name of the asset.
", + "smithy.api#required": {} + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the domain where the asset is being revised.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the asset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision type of the asset.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The revised description of the asset.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms to be attached to the asset as part of asset revision.
" + } + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormInputList", + "traits": { + "smithy.api#documentation": "The metadata forms to be attached to the asset as part of asset revision.
" + } + }, + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the automatically generated business-friendly metadata for the\n asset.
", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateAssetRevisionOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the asset revision.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "The revised name of the asset.
", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the revision type.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision type of the asset.
", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The revised asset description.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset revision occured.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who performed the asset revision.
" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the first asset revision occured.
" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who performed the first asset revision.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that were attached to the asset as part of asset revision.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The unique identifier of the revised project that owns the asset.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone domain where the asset was revised.
", + "smithy.api#required": {} + } + }, + "listing": { + "target": "com.amazonaws.datazone#AssetListingDetails", + "traits": { + "smithy.api#documentation": "" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata forms that were attached to the asset as part of the asset revision.
", + "smithy.api#required": {} + } + }, + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The read-only metadata forms that were attached to the asset as part of the asset\n revision.
" + } + }, + "predictionConfiguration": { + "target": "com.amazonaws.datazone#PredictionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the automatically generated business-friendly metadata for the\n asset.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateAssetType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAssetTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAssetTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom asset type.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/asset-types" + } + } + }, + "com.amazonaws.datazone#CreateAssetTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone domain where the custom asset type is being\n created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The name of the custom asset type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The descripton of the custom asset type.
" + } + }, + "formsInput": { + "target": "com.amazonaws.datazone#FormsInputMap", + "traits": { + "smithy.api#documentation": "The metadata forms that are to be attached to the custom asset type.
", + "smithy.api#required": {} + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project that is to own the custom asset type.
", + "smithy.api#property": { + "name": "owningProjectId" + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateAssetTypeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset type was created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The name of the asset type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the custom asset type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the custom asset type.
" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap", + "traits": { + "smithy.api#documentation": "The metadata forms that are attached to the asset type.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project that currently owns this asset type.
" + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where the asset type was originally created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project where the asset type was originally created.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset type is to be created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who creates this custom asset type.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the custom type was created.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user that created the custom asset type.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateDataSourceInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateDataSourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon DataZone data source.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/data-sources" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateDataSourceInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where the data source is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project in which you want to add this data\n source.
", + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone environment to which the data source publishes\n assets.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.datazone#DataSourceConfigurationInput", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the data source. It can be set to either\n glueRunConfiguration or redshiftRunConfiguration.
Specifies whether the business name generation is to be enabled for this data\n source.
" + } + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting", + "traits": { + "smithy.api#documentation": "Specifies whether the data source is enabled.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule of the data source runs.
" + } + }, + "publishOnImport": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.
" + } + }, + "assetFormsInput": { + "target": "com.amazonaws.datazone#FormInputList", + "traits": { + "smithy.api#documentation": "The metadata forms that are to be attached to the assets that this data source works\n with.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateDataSourceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source is created.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project to which the data source is added.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Amazon DataZone environment to which the data source publishes\n assets.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the data source. It can be set to either\n glueRunConfiguration or redshiftRunConfiguration.
Specifies whether the business name generation is to be enabled for this data\n source.
" + } + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting", + "traits": { + "smithy.api#documentation": "Specifies whether the data source is enabled.
" + } + }, + "publishOnImport": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.
" + } + }, + "assetFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata forms attached to the assets that this data source creates.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule of the data source runs.
" + } + }, + "lastRunStatus": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the last run of this data source.
" + } + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp that specifies when the data source was last run.
" + } + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateDomainInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateDomainOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon DataZone domain.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#CreateDomainInput": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone domain.
" + } + }, + "singleSignOn": { + "target": "com.amazonaws.datazone#SingleSignOn", + "traits": { + "smithy.api#documentation": "The single-sign on configuration of the Amazon DataZone domain.
" + } + }, + "domainExecutionRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The domain execution role that is created when an Amazon DataZone domain is created. The\n domain execution role is created in the Amazon Web Services account that houses the\n Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.datazone#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.
" + } + }, + "tags": { + "target": "com.amazonaws.datazone#Tags", + "traits": { + "smithy.api#documentation": "The tags specified for the Amazon DataZone domain.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateDomainOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone domain.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone domain.
" + } + }, + "singleSignOn": { + "target": "com.amazonaws.datazone#SingleSignOn", + "traits": { + "smithy.api#documentation": "The single-sign on configuration of the Amazon DataZone domain.
" + } + }, + "domainExecutionRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The domain execution role that is created when an Amazon DataZone domain is created. The\n domain execution role is created in the Amazon Web Services account that houses the\n Amazon DataZone domain.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon DataZone domain.
" + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.datazone#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#DomainStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon DataZone domain.
" + } + }, + "portalUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL of the data portal for this Amazon DataZone domain.
" + } + }, + "tags": { + "target": "com.amazonaws.datazone#Tags", + "traits": { + "smithy.api#documentation": "The tags specified for the Amazon DataZone domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create an Amazon DataZone environment.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentInput": { + "type": "structure", + "members": { + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project in which this environment is created.
", + "smithy.api#required": {} + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the environment is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone environment.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone environment.
", + "smithy.api#required": {} + } + }, + "environmentProfileIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile that is used to create this Amazon DataZone\n environment.
", + "smithy.api#required": {} + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentParametersList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone environment.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that can be used in this Amazon DataZone environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateEnvironmentOutput": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project in which this environment is created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of this Amazon DataZone environment.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the environment is created.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created this environment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of this environment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone environment.
" + } + }, + "environmentProfileId": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of the environment profile with which this Amazon DataZone environment was\n created.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account in which the Amazon DataZone environment is created.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region in which the Amazon DataZone environment is created.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of this Amazon DataZone environment.
", + "smithy.api#required": {} + } + }, + "provisionedResources": { + "target": "com.amazonaws.datazone#ResourceList", + "traits": { + "smithy.api#documentation": "The provisioned resources of this Amazon DataZone environment.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of this Amazon DataZone environment.
" + } + }, + "environmentActions": { + "target": "com.amazonaws.datazone#EnvironmentActionList", + "traits": { + "smithy.api#documentation": "The configurable actions of this Amazon DataZone environment.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that can be used in this Amazon DataZone environment.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone environment.
" + } + }, + "lastDeployment": { + "target": "com.amazonaws.datazone#Deployment", + "traits": { + "smithy.api#documentation": "The details of the last deployment of this Amazon DataZone environment.
" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of this Amazon DataZone environment.
" + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "The deployment properties of this Amazon DataZone environment.
" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint with which this Amazon DataZone environment was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateEnvironmentProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon DataZone environment profile.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environment-profiles" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this environment profile is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone environment profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone environment profile.
" + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint with which this environment profile is created.
", + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project in which to create the environment profile.
", + "smithy.api#required": {} + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#EnvironmentParametersList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone environment profile.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account in which the Amazon DataZone environment is created.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region in which this environment profile is created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateEnvironmentProfileOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of this Amazon DataZone environment profile.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this environment profile is created.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID in which this Amazon DataZone environment profile is\n created.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region in which this Amazon DataZone environment profile is\n created.
" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created this environment profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment profile was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment profile was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone environment profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone environment profile.
" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint with which this environment profile is created.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project in which this environment profile is created.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone environment profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateFormType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateFormTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateFormTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a metadata form type.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/form-types" + } + } + }, + "com.amazonaws.datazone#CreateFormTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this metadata form type is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone metadata form type.
", + "smithy.api#required": {} + } + }, + "model": { + "target": "com.amazonaws.datazone#Model", + "traits": { + "smithy.api#documentation": "The model of this Amazon DataZone metadata form type.
", + "smithy.api#required": {} + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project that owns this metadata form type.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#FormTypeStatus", + "traits": { + "smithy.api#documentation": "The status of this Amazon DataZone metadata form type.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone metadata form type.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateFormTypeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this metadata form type is created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone metadata form type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of this Amazon DataZone metadata form type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone metadata form type.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that owns this Amazon DataZone metadata form type.
" + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this metadata form type was originally\n created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project in which this Amazon DataZone metadata form type was originally\n created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateGlossary": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateGlossaryInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateGlossaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon DataZone business glossary.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/glossaries" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateGlossaryInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name of this business glossary.
", + "smithy.api#required": {} + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that currently owns business glossary.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription", + "traits": { + "smithy.api#documentation": "The description of this business glossary.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryStatus", + "traits": { + "smithy.api#documentation": "The status of this business glossary.
" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateGlossaryOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary is created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of this business glossary.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name of this business glossary.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that currently owns this business glossary.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription", + "traits": { + "smithy.api#documentation": "The description of this business glossary.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryStatus", + "traits": { + "smithy.api#documentation": "The status of this business glossary.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateGlossaryTerm": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateGlossaryTermInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateGlossaryTermOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a business glossary term.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/glossary-terms" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateGlossaryTermInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary term is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "glossaryIdentifier": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary in which this term is created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name of this business glossary term.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryTermStatus", + "traits": { + "smithy.api#documentation": "The status of this business glossary term.
" + } + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription", + "traits": { + "smithy.api#documentation": "The short description of this business glossary term.
" + } + }, + "longDescription": { + "target": "com.amazonaws.datazone#LongDescription", + "traits": { + "smithy.api#documentation": "The long description of this business glossary term.
" + } + }, + "termRelations": { + "target": "com.amazonaws.datazone#TermRelations", + "traits": { + "smithy.api#documentation": "The term relations of this business glossary term.
" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateGlossaryTermOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The ID of this business glossary term.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary term is created.
", + "smithy.api#required": {} + } + }, + "glossaryId": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary in which this term is created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name of this business glossary term.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryTermStatus", + "traits": { + "smithy.api#documentation": "The status of this business glossary term.
", + "smithy.api#required": {} + } + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription", + "traits": { + "smithy.api#documentation": "The short description of this business glossary term.
" + } + }, + "longDescription": { + "target": "com.amazonaws.datazone#LongDescription", + "traits": { + "smithy.api#documentation": "The long description of this business glossary term.
" + } + }, + "termRelations": { + "target": "com.amazonaws.datazone#TermRelations", + "traits": { + "smithy.api#documentation": "The term relations of this business glossary term.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateGroupProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateGroupProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateGroupProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a group profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/group-profiles" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#CreateGroupProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the group profile is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the group for which the group profile is created.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateGroupProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the group profile is created.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#GroupProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the group profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GroupProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the group profile.
" + } + }, + "groupName": { + "target": "com.amazonaws.datazone#GroupProfileName", + "traits": { + "smithy.api#documentation": "The name of the group for which group profile is created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateListingChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateListingChangeSetInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateListingChangeSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/listings/change-set" + } + } + }, + "com.amazonaws.datazone#CreateListingChangeSetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "com.amazonaws.datazone#EntityId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#EntityType", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "entityRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "" + } + }, + "action": { + "target": "com.amazonaws.datazone#ChangeAction", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateListingChangeSetOutput": { + "type": "structure", + "members": { + "listingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "listingRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#ListingStatus", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateProjectInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon DataZone project.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/projects" + } + } + }, + "com.amazonaws.datazone#CreateProjectInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this project is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone project.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that can be used in this Amazon DataZone project.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateProjectMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateProjectMembershipInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateProjectMembershipOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a project membership in Amazon DataZone.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/createMembership" + } + } + }, + "com.amazonaws.datazone#CreateProjectMembershipInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which project membership is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project for which this project membership was created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "member": { + "target": "com.amazonaws.datazone#Member", + "traits": { + "smithy.api#documentation": "The project member whose project membership was created.
", + "smithy.api#required": {} + } + }, + "designation": { + "target": "com.amazonaws.datazone#UserDesignation", + "traits": { + "smithy.api#documentation": "The designation of the project membership.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateProjectMembershipOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateProjectOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the project was created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the project.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms that can be used in the project.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateSubscriptionGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateSubscriptionGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a subsscription grant in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/subscription-grants" + } + } + }, + "com.amazonaws.datazone#CreateSubscriptionGrantInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription grant is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetIdentifier": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntityInput", + "traits": { + "smithy.api#documentation": "The entity to which the subscription is to be granted.
", + "smithy.api#required": {} + } + }, + "assetTargetNames": { + "target": "com.amazonaws.datazone#AssetTargetNames", + "traits": { + "smithy.api#documentation": "The names of the assets for which the subscription grant is created.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionGrantOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription grant.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription grant.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "A timestamp of when the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "A timestamp of when the subscription grant was updated.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntity", + "traits": { + "smithy.api#documentation": "The entity to which the subscription is granted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantOverallStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription grant.
", + "smithy.api#required": {} + } + }, + "assets": { + "target": "com.amazonaws.datazone#SubscribedAssets", + "traits": { + "smithy.api#documentation": "The assets for which the subscription grant is created.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription grant.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateSubscriptionRequestInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateSubscriptionRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a subscription request in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests" + } + } + }, + "com.amazonaws.datazone#CreateSubscriptionRequestInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription request is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipalInputs", + "traits": { + "smithy.api#documentation": "The Amazon DataZone principals for whom the subscription request is created.
", + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListingInputs", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the subscription request.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionRequestOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The ID of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription request.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in whcih the subscription request is created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "A timestamp of when the subscription request is created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the subscription request.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipals", + "traits": { + "smithy.api#documentation": "The subscribed principals of the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the reviewer of the subscription request.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the subscription request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateSubscriptionTargetInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateSubscriptionTargetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a subscription target in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets" + } + } + }, + "com.amazonaws.datazone#CreateSubscriptionTargetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which subscription target is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which subscription target is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name of the subscription target.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the subscription target.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetConfig": { + "target": "com.amazonaws.datazone#SubscriptionTargetForms", + "traits": { + "smithy.api#documentation": "The configuration of the subscription target.
", + "smithy.api#required": {} + } + }, + "authorizedPrincipals": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", + "traits": { + "smithy.api#documentation": "The authorized principals of the subscription target.
", + "smithy.api#required": {} + } + }, + "manageAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The manage access role that is used to create the subscription target.
", + "smithy.api#required": {} + } + }, + "applicableAssetTypes": { + "target": "com.amazonaws.datazone#ApplicableAssetTypes", + "traits": { + "smithy.api#documentation": "The asset types that can be included in the subscription target.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the subscription target.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateSubscriptionTargetOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target.
", + "smithy.api#required": {} + } + }, + "authorizedPrincipals": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", + "traits": { + "smithy.api#documentation": "The authorised principals of the subscription target.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription target was created.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "???
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the subscription target was created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name of the subscription target.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the subscription target.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription target.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription target.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was updated.
" + } + }, + "manageAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The manage access role with which the subscription target was created.
", + "smithy.api#required": {} + } + }, + "applicableAssetTypes": { + "target": "com.amazonaws.datazone#ApplicableAssetTypes", + "traits": { + "smithy.api#documentation": "The asset types that can be included in the subscription target.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetConfig": { + "target": "com.amazonaws.datazone#SubscriptionTargetForms", + "traits": { + "smithy.api#documentation": "The configuration of the subscription target.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the subscription target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateUserProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateUserProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a user profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/user-profiles" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#CreateUserProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a user profile is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the user for which the user profile is created.
", + "smithy.api#required": {} + } + }, + "userType": { + "target": "com.amazonaws.datazone#UserType", + "traits": { + "smithy.api#documentation": "The user type of the user for which the user profile is created.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateUserProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a user profile is created.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#UserProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the user profile.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the user profile.
" + } + }, + "details": { + "target": "com.amazonaws.datazone#UserProfileDetails" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreatedAt": { + "type": "timestamp" + }, + "com.amazonaws.datazone#CreatedBy": { + "type": "string" + }, + "com.amazonaws.datazone#CronString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\\)" + } + }, + "com.amazonaws.datazone#CustomParameter": { + "type": "structure", + "members": { + "keyName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key name of the parameter.
", + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the parameter.
" + } + }, + "fieldType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The filed type of the parameter.
", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The default value of the parameter.
" + } + }, + "isEditable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the parameter is editable.
" + } + }, + "isOptional": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the custom parameter is optional.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of user parameters of an environment blueprint.
" + } + }, + "com.amazonaws.datazone#CustomParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#CustomParameter" + } + }, + "com.amazonaws.datazone#DataAssetActivityStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PUBLISHING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHING_FAILED" + } + }, + "SUCCEEDED_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED_CREATED" + } + }, + "SUCCEEDED_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED_UPDATED" + } + }, + "SKIPPED_ALREADY_IMPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED_ALREADY_IMPORTED" + } + }, + "SKIPPED_ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED_ARCHIVED" + } + }, + "SKIPPED_NO_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED_NO_ACCESS" + } + }, + "UNCHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNCHANGED" + } + } + } + }, + "com.amazonaws.datazone#DataProductDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DataProductId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#DataProductItem": { + "type": "structure", + "members": { + "itemId": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.datazone#DataProductItems": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DataProductItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.datazone#DataProductName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DataProductSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#DataProductId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DataProductName", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DataProductDescription", + "traits": { + "smithy.api#documentation": "" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "" + } + }, + "dataProductItems": { + "target": "com.amazonaws.datazone#DataProductItems", + "traits": { + "smithy.api#documentation": "" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.datazone#DataSource": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#DataSourceId" + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + } + }, + "properties": { + "id": { + "target": "com.amazonaws.datazone#DataSourceId" + }, + "name": { + "target": "com.amazonaws.datazone#Name" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId" + }, + "projectIdentifier": { + "target": "smithy.api#String" + }, + "environmentIdentifier": { + "target": "smithy.api#String" + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType" + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus" + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting" + }, + "publishOnImport": { + "target": "smithy.api#Boolean" + }, + "recommendation": { + "target": "com.amazonaws.datazone#RecommendationConfiguration" + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration" + }, + "assetFormsInput": { + "target": "com.amazonaws.datazone#FormInputList" + }, + "assetFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList" + }, + "lastRunStatus": { + "target": "com.amazonaws.datazone#DataSourceRunStatus" + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime" + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "lastRunAssetCount": { + "target": "smithy.api#Integer" + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateDataSource" + }, + "read": { + "target": "com.amazonaws.datazone#GetDataSource" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateDataSource" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteDataSource" + }, + "list": { + "target": "com.amazonaws.datazone#ListDataSources" + } + }, + "com.amazonaws.datazone#DataSourceConfigurationInput": { + "type": "union", + "members": { + "glueRunConfiguration": { + "target": "com.amazonaws.datazone#GlueRunConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Web Services Glue data source.
" + } + }, + "redshiftRunConfiguration": { + "target": "com.amazonaws.datazone#RedshiftRunConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Redshift data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the data source.
" + } + }, + "com.amazonaws.datazone#DataSourceConfigurationOutput": { + "type": "union", + "members": { + "glueRunConfiguration": { + "target": "com.amazonaws.datazone#GlueRunConfigurationOutput", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Web Services Glue data source.
" + } + }, + "redshiftRunConfiguration": { + "target": "com.amazonaws.datazone#RedshiftRunConfigurationOutput", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Redshift data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the data source.
" + } + }, + "com.amazonaws.datazone#DataSourceErrorMessage": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.datazone#DataSourceErrorType", + "traits": { + "smithy.api#documentation": "The type of the error message that is returned if the operation cannot be successfully\n completed.
", + "smithy.api#required": {} + } + }, + "errorDetail": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The details of the error message that is returned if the operation cannot be\n successfully completed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the error message that is returned if the operation cannot be\n successfully completed.
" + } + }, + "com.amazonaws.datazone#DataSourceErrorType": { + "type": "enum", + "members": { + "ACCESS_DENIED_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED_EXCEPTION" + } + }, + "CONFLICT_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT_EXCEPTION" + } + }, + "INTERNAL_SERVER_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_EXCEPTION" + } + }, + "RESOURCE_NOT_FOUND_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND_EXCEPTION" + } + }, + "SERVICE_QUOTA_EXCEEDED_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_QUOTA_EXCEEDED_EXCEPTION" + } + }, + "THROTTLING_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROTTLING_EXCEPTION" + } + }, + "VALIDATION_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_EXCEPTION" + } + } + } + }, + "com.amazonaws.datazone#DataSourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#DataSourceRun": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#DataSourceRunId" + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + } + }, + "properties": { + "id": { + "target": "com.amazonaws.datazone#DataSourceRunId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "dataSourceIdentifier": { + "target": "com.amazonaws.datazone#DataSourceId" + }, + "dataSourceId": { + "target": "com.amazonaws.datazone#DataSourceId" + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceRunType" + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceRunStatus" + }, + "dataSourceConfigurationSnapshot": { + "target": "smithy.api#String" + }, + "runStatisticsForAssets": { + "target": "com.amazonaws.datazone#RunStatisticsForAssets" + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime" + }, + "startedAt": { + "target": "com.amazonaws.datazone#DateTime" + }, + "stoppedAt": { + "target": "com.amazonaws.datazone#DateTime" + } + }, + "create": { + "target": "com.amazonaws.datazone#StartDataSourceRun" + }, + "read": { + "target": "com.amazonaws.datazone#GetDataSourceRun" + }, + "list": { + "target": "com.amazonaws.datazone#ListDataSourceRuns" + } + }, + "com.amazonaws.datazone#DataSourceRunActivities": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DataSourceRunActivity" + } + }, + "com.amazonaws.datazone#DataSourceRunActivity": { + "type": "structure", + "members": { + "database": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The database included in the data source run activity.
", + "smithy.api#required": {} + } + }, + "dataSourceRunId": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The identifier of the data source for the data source run activity.
", + "smithy.api#required": {} + } + }, + "technicalName": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The technical name included in the data source run activity.
", + "smithy.api#required": {} + } + }, + "dataAssetStatus": { + "target": "com.amazonaws.datazone#DataAssetActivityStatus", + "traits": { + "smithy.api#documentation": "The status of the asset included in the data source run activity.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The project ID included in the data source run activity.
", + "smithy.api#required": {} + } + }, + "dataAssetId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the asset included in the data source run activity.
" + } + }, + "technicalDescription": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The technical description included in the data source run activity.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when data source run activity was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when data source run activity was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The activity details of the data source run.
" + } + }, + "com.amazonaws.datazone#DataSourceRunId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#DataSourceRunStatus": { + "type": "enum", + "members": { + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUESTED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PARTIALLY_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_SUCCEEDED" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, + "com.amazonaws.datazone#DataSourceRunSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DataSourceRunSummary" + } + }, + "com.amazonaws.datazone#DataSourceRunSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The identifier of the data source run.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source of the data source run.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceRunType", + "traits": { + "smithy.api#documentation": "The type of the data source run.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the data source run.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The project ID of the data source run.
", + "smithy.api#required": {} + } + }, + "runStatisticsForAssets": { + "target": "com.amazonaws.datazone#RunStatisticsForAssets" + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when a data source run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when a data source run was updated.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when a data source run was started.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when a data source run was stopped.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a data source run.
" + } + }, + "com.amazonaws.datazone#DataSourceRunType": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZED" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + } + } + }, + "com.amazonaws.datazone#DataSourceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED_CREATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_CREATION" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_UPDATE" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_DELETION" + } + } + } + }, + "com.amazonaws.datazone#DataSourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DataSourceSummary" + } + }, + "com.amazonaws.datazone#DataSourceSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source exists.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the data source exists.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The ID of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting", + "traits": { + "smithy.api#documentation": "Specifies whether the data source is enabled.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration" + }, + "lastRunStatus": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the last data source run.
" + } + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source run was last performed.
" + } + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage" + }, + "lastRunAssetCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The count of the assets created during the last data source run.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the data source.
" + } + }, + "com.amazonaws.datazone#DataSourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.datazone#DataZone": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.datazone#AcceptPredictions" + }, + { + "target": "com.amazonaws.datazone#AcceptSubscriptionRequest" + }, + { + "target": "com.amazonaws.datazone#CancelSubscription" + }, + { + "target": "com.amazonaws.datazone#CreateEnvironment" + }, + { + "target": "com.amazonaws.datazone#CreateEnvironmentProfile" + }, + { + "target": "com.amazonaws.datazone#CreateGroupProfile" + }, + { + "target": "com.amazonaws.datazone#CreateListingChangeSet" + }, + { + "target": "com.amazonaws.datazone#CreateProject" + }, + { + "target": "com.amazonaws.datazone#CreateProjectMembership" + }, + { + "target": "com.amazonaws.datazone#CreateSubscriptionGrant" + }, + { + "target": "com.amazonaws.datazone#CreateSubscriptionRequest" + }, + { + "target": "com.amazonaws.datazone#CreateSubscriptionTarget" + }, + { + "target": "com.amazonaws.datazone#CreateUserProfile" + }, + { + "target": "com.amazonaws.datazone#DeleteEnvironment" + }, + { + "target": "com.amazonaws.datazone#DeleteEnvironmentProfile" + }, + { + "target": "com.amazonaws.datazone#DeleteProject" + }, + { + "target": "com.amazonaws.datazone#DeleteProjectMembership" + }, + { + "target": "com.amazonaws.datazone#DeleteSubscriptionGrant" + }, + { + "target": "com.amazonaws.datazone#DeleteSubscriptionRequest" + }, + { + "target": "com.amazonaws.datazone#DeleteSubscriptionTarget" + }, + { + "target": "com.amazonaws.datazone#GetEnvironment" + }, + { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprint" + }, + { + "target": "com.amazonaws.datazone#GetEnvironmentProfile" + }, + { + "target": "com.amazonaws.datazone#GetGroupProfile" + }, + { + "target": "com.amazonaws.datazone#GetIamPortalLoginUrl" + }, + { + "target": "com.amazonaws.datazone#GetProject" + }, + { + "target": "com.amazonaws.datazone#GetSubscription" + }, + { + "target": "com.amazonaws.datazone#GetSubscriptionGrant" + }, + { + "target": "com.amazonaws.datazone#GetSubscriptionRequestDetails" + }, + { + "target": "com.amazonaws.datazone#GetSubscriptionTarget" + }, + { + "target": "com.amazonaws.datazone#GetUserProfile" + }, + { + "target": "com.amazonaws.datazone#ListAssetRevisions" + }, + { + "target": "com.amazonaws.datazone#ListDataSourceRunActivities" + }, + { + "target": "com.amazonaws.datazone#ListEnvironmentBlueprints" + }, + { + "target": "com.amazonaws.datazone#ListEnvironmentProfiles" + }, + { + "target": "com.amazonaws.datazone#ListEnvironments" + }, + { + "target": "com.amazonaws.datazone#ListNotifications" + }, + { + "target": "com.amazonaws.datazone#ListProjectMemberships" + }, + { + "target": "com.amazonaws.datazone#ListProjects" + }, + { + "target": "com.amazonaws.datazone#ListSubscriptionGrants" + }, + { + "target": "com.amazonaws.datazone#ListSubscriptionRequests" + }, + { + "target": "com.amazonaws.datazone#ListSubscriptions" + }, + { + "target": "com.amazonaws.datazone#ListSubscriptionTargets" + }, + { + "target": "com.amazonaws.datazone#ListTagsForResource" + }, + { + "target": "com.amazonaws.datazone#RejectPredictions" + }, + { + "target": "com.amazonaws.datazone#RejectSubscriptionRequest" + }, + { + "target": "com.amazonaws.datazone#RevokeSubscription" + }, + { + "target": "com.amazonaws.datazone#Search" + }, + { + "target": "com.amazonaws.datazone#SearchGroupProfiles" + }, + { + "target": "com.amazonaws.datazone#SearchListings" + }, + { + "target": "com.amazonaws.datazone#SearchTypes" + }, + { + "target": "com.amazonaws.datazone#SearchUserProfiles" + }, + { + "target": "com.amazonaws.datazone#TagResource" + }, + { + "target": "com.amazonaws.datazone#UntagResource" + }, + { + "target": "com.amazonaws.datazone#UpdateEnvironment" + }, + { + "target": "com.amazonaws.datazone#UpdateEnvironmentProfile" + }, + { + "target": "com.amazonaws.datazone#UpdateGroupProfile" + }, + { + "target": "com.amazonaws.datazone#UpdateProject" + }, + { + "target": "com.amazonaws.datazone#UpdateSubscriptionGrantStatus" + }, + { + "target": "com.amazonaws.datazone#UpdateSubscriptionRequest" + }, + { + "target": "com.amazonaws.datazone#UpdateSubscriptionTarget" + }, + { + "target": "com.amazonaws.datazone#UpdateUserProfile" + } + ], + "resources": [ + { + "target": "com.amazonaws.datazone#Asset" + }, + { + "target": "com.amazonaws.datazone#AssetType" + }, + { + "target": "com.amazonaws.datazone#DataSource" + }, + { + "target": "com.amazonaws.datazone#DataSourceRun" + }, + { + "target": "com.amazonaws.datazone#Domain" + }, + { + "target": "com.amazonaws.datazone#EnvironmentBlueprintConfiguration" + }, + { + "target": "com.amazonaws.datazone#FormType" + }, + { + "target": "com.amazonaws.datazone#Glossary" + }, + { + "target": "com.amazonaws.datazone#GlossaryTerm" + }, + { + "target": "com.amazonaws.datazone#Listing" + } + ], + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#UnauthorizedException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "DataZone", + "arnNamespace": "datazone", + "serviceName": "datazone", + "cloudTrailEventSource": "datazone.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "datazone" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "origin": "*", + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amzn-requestid", + "x-amz-apigw-id", + "date" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Amazon DataZone is a data management service that enables you to catalog, discover,\n govern, share, and analyze your data. With Amazon DataZone, you can share and access your\n data across accounts and supported regions. Amazon DataZone simplifies your experience\n across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon\n Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#title": "Amazon DataZone", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://datazone-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://datazone.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://datazone-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://datazone.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://datazone.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.datazone#DateTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.datazone#DecisionComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DeleteAsset": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteAssetInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteAssetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delets an asset in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteAssetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the asset that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteAssetOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteAssetType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteAssetTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteAssetTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an asset type in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/asset-types/{identifier}" + } + } + }, + "com.amazonaws.datazone#DeleteAssetTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset type is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the asset type that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteAssetTypeOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteDataSourceInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteDataSourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data source in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteDataSourceInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteDataSourceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The ID of the data source that is deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of this data source.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of this data source.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source that is deleted.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the data source that is deleted.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source is deleted.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project in which this data source exists and from which it's\n deleted.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environemnt associated with this data source.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", + "traits": { + "smithy.api#documentation": "The configuration of the data source that is deleted.
", + "smithy.api#notProperty": {} + } + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting", + "traits": { + "smithy.api#documentation": "The enable setting of the data source that specifies whether the data source is enabled\n or disabled.
" + } + }, + "publishOnImport": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.
" + } + }, + "assetFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The asset data forms associated with this data source.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule of runs for this data source.
" + } + }, + "lastRunStatus": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the last run of this data source.
" + } + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was last run.
" + } + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when this data source was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when this data source was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteDomainInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteDomainOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Amazon DataZone domain.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/v2/domains/{identifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#DeleteDomainInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services domain that is to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteDomainOutput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.datazone#DomainStatus", + "traits": { + "smithy.api#documentation": "The status of the domain.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an environment in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfigurationInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the blueprint configuration in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfigurationInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint the configuration of which is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfigurationOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment that is to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentProfileInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an environment profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environment-profiles/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment profile is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of the environment profile that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteFormType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteFormTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteFormTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delets and metadata form type in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/form-types/{formTypeIdentifier}" + } + } + }, + "com.amazonaws.datazone#DeleteFormTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the metadata form type is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "formTypeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the metadata form type that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteFormTypeOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteGlossary": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteGlossaryInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteGlossaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a business glossary in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/glossaries/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteGlossaryInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the business glossary is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteGlossaryOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteGlossaryTerm": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteGlossaryTermInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteGlossaryTermOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a business glossary term in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/glossary-terms/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteGlossaryTermInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the business glossary term is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary term that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteGlossaryTermOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteListingInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteListingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/listings/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteListingInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteListingOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteProjectInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a project in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/projects/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteProjectInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the project is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that is to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteProjectMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteProjectMembershipInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteProjectMembershipOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes project membership in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/deleteMembership" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteProjectMembershipInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where project membership is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project the membership to which is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "member": { + "target": "com.amazonaws.datazone#Member", + "traits": { + "smithy.api#documentation": "The project member whose project membership is deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteProjectMembershipOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteProjectOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteSubscriptionGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteSubscriptionGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteSubscriptionGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes and subscription grant in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/subscription-grants/{identifier}" + } + } + }, + "com.amazonaws.datazone#DeleteSubscriptionGrantInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where the subscription grant is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteSubscriptionGrantOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant that is deleted.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription grant that is deleted.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription grant that is deleted.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription grant is deleted.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant that is deleted was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant that is deleted was updated.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target associated with the subscription grant that is\n deleted.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntity", + "traits": { + "smithy.api#documentation": "The entity to which the subscription is deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantOverallStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription grant that is deleted.
", + "smithy.api#required": {} + } + }, + "assets": { + "target": "com.amazonaws.datazone#SubscribedAssets", + "traits": { + "smithy.api#documentation": "The assets for which the subsctiption grant that is deleted gave access.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subsctiption whose subscription grant is to be deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteSubscriptionRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteSubscriptionRequestInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a subscription request in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}" + } + } + }, + "com.amazonaws.datazone#DeleteSubscriptionRequestInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription request is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The ID of the subscription request that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteSubscriptionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteSubscriptionTargetInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a subscription target in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets/{identifier}" + } + } + }, + "com.amazonaws.datazone#DeleteSubscriptionTargetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription target is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone environment in which the subscription target is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#Deployment": { + "type": "structure", + "members": { + "deploymentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the last deployment of the environment.
" + } + }, + "deploymentType": { + "target": "com.amazonaws.datazone#DeploymentType", + "traits": { + "smithy.api#documentation": "The type of the last deployment of the environment.
" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.datazone#DeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the last deployment of the environment.
" + } + }, + "failureReason": { + "target": "com.amazonaws.datazone#EnvironmentError", + "traits": { + "smithy.api#documentation": "The failure reason of the last deployment of the environment.
" + } + }, + "messages": { + "target": "com.amazonaws.datazone#DeploymentMessagesList", + "traits": { + "smithy.api#documentation": "The messages of the last deployment of the environment.
" + } + }, + "isDeploymentComplete": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the last deployment of the environment is complete.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the last deployment of the environment.
" + } + }, + "com.amazonaws.datazone#DeploymentMessage": { + "type": "string" + }, + "com.amazonaws.datazone#DeploymentMessagesList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DeploymentMessage" + } + }, + "com.amazonaws.datazone#DeploymentProperties": { + "type": "structure", + "members": { + "startTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The start timeout of the environment blueprint deployment.
", + "smithy.api#range": { + "min": 1, + "max": 225 + } + } + }, + "endTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The end timeout of the environment blueprint deployment.
", + "smithy.api#range": { + "min": 1, + "max": 225 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The deployment properties of the Amazon DataZone blueprint.
" + } + }, + "com.amazonaws.datazone#DeploymentStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PENDING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DEPLOYMENT" + } + } + } + }, + "com.amazonaws.datazone#DeploymentType": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.datazone#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DetailedGlossaryTerm": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name of a glossary term attached to the inventory asset.
" + } + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription", + "traits": { + "smithy.api#documentation": "The shoft description of a glossary term attached to the inventory asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a glossary term attached to the inventory asset.
" + } + }, + "com.amazonaws.datazone#DetailedGlossaryTerms": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerm" + } + }, + "com.amazonaws.datazone#Domain": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#DomainId" + } + }, + "properties": { + "name": { + "target": "smithy.api#String" + }, + "description": { + "target": "smithy.api#String" + }, + "singleSignOn": { + "target": "com.amazonaws.datazone#SingleSignOn" + }, + "domainExecutionRole": { + "target": "com.amazonaws.datazone#RoleArn" + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.datazone#KmsKeyArn" + }, + "tags": { + "target": "com.amazonaws.datazone#Tags" + }, + "id": { + "target": "com.amazonaws.datazone#DomainId" + }, + "status": { + "target": "com.amazonaws.datazone#DomainStatus" + }, + "arn": { + "target": "smithy.api#String" + }, + "portalUrl": { + "target": "smithy.api#String" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateDomain" + }, + "read": { + "target": "com.amazonaws.datazone#GetDomain" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateDomain" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteDomain" + }, + "list": { + "target": "com.amazonaws.datazone#ListDomains" + } + }, + "com.amazonaws.datazone#DomainDescription": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DomainId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#DomainName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#DomainStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + } + } + }, + "com.amazonaws.datazone#DomainSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DomainSummary" + } + }, + "com.amazonaws.datazone#DomainSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainName", + "traits": { + "smithy.api#documentation": "A name of an Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainDescription", + "traits": { + "smithy.api#documentation": "A description of an Amazon DataZone domain.
" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "managedAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account that manages the domain.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DomainStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "portalUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data portal URL for the Amazon DataZone domain.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "A timestamp of when a Amazon DataZone domain was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "A timestamp of when a Amazon DataZone domain was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a Amazon DataZone domain.
" + } + }, + "com.amazonaws.datazone#EnableSetting": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#EnabledRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RegionName" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.datazone#EntityId": { + "type": "string" + }, + "com.amazonaws.datazone#EntityType": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + } + } + }, + "com.amazonaws.datazone#EnvironmentActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ConfigurableEnvironmentAction" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId" + } + }, + "properties": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId" + }, + "provisioningRoleArn": { + "target": "com.amazonaws.datazone#RoleArn" + }, + "manageAccessRoleArn": { + "target": "com.amazonaws.datazone#RoleArn" + }, + "enabledRegions": { + "target": "com.amazonaws.datazone#EnabledRegionList" + }, + "regionalParameters": { + "target": "com.amazonaws.datazone#RegionalParameterMap" + }, + "createdAt": { + "target": "smithy.api#Timestamp" + }, + "updatedAt": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.datazone#PutEnvironmentBlueprintConfiguration" + }, + "read": { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprintConfiguration" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfiguration" + }, + "list": { + "target": "com.amazonaws.datazone#ListEnvironmentBlueprintConfigurations" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintConfigurationItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which an environment blueprint exists.
", + "smithy.api#required": {} + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the environment blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioning role specified in the environment blueprint\n configuration.
" + } + }, + "manageAccessRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the manage access role specified in the environment blueprint\n configuration.
" + } + }, + "enabledRegions": { + "target": "com.amazonaws.datazone#EnabledRegionList", + "traits": { + "smithy.api#documentation": "The enabled Amazon Web Services Regions specified in a blueprint configuration.
" + } + }, + "regionalParameters": { + "target": "com.amazonaws.datazone#RegionalParameterMap", + "traits": { + "smithy.api#documentation": "The regional parameters of the environment blueprint.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when an environment blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment blueprint was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of an environment blueprint.
" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintConfigurationItem" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintSummary" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the blueprint.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "The name of the blueprint.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of a blueprint.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of the blueprint.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when an environment blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the blueprint was enabled.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an environment blueprint summary.
" + } + }, + "com.amazonaws.datazone#EnvironmentError": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error code for the failure reason for the environment deployment.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message for the failure reason for the environment deployment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The failure reasons for the environment deployment.
" + } + }, + "com.amazonaws.datazone#EnvironmentId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnvironmentParameter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of an environment profile parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of an environment profile parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parameter details of an evironment profile.
" + } + }, + "com.amazonaws.datazone#EnvironmentParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentParameter" + } + }, + "com.amazonaws.datazone#EnvironmentProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnvironmentProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentProfileSummary" + } + }, + "com.amazonaws.datazone#EnvironmentProfileSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the environment profile exists.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The identifier of an Amazon Web Services account in which an environment profile exists.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which an environment profile exists.
" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the environment profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when an environment profile was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment profile was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name of the environment profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the environment profile.
" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of a blueprint with which an environment profile is created.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of a project in which an environment profile exists.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an environment profile.
" + } + }, + "com.amazonaws.datazone#EnvironmentStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "INACCESSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE" + } + } + } + }, + "com.amazonaws.datazone#EnvironmentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentSummary" + } + }, + "com.amazonaws.datazone#EnvironmentSummary": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project in which the environment exists.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the environment exists.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the environment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "environmentProfileId": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile with which the environment was created.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account in which an environment exists.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which an environment exists.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the environment.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the environment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an environment.
" + } + }, + "com.amazonaws.datazone#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.datazone#ExternalIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FailureCause": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "com.amazonaws.datazone#Filter": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.datazone#Attribute", + "traits": { + "smithy.api#documentation": "A search filter attribute in Amazon DataZone.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A search filter value in Amazon DataZone.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A search filter in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#FilterClause": { + "type": "union", + "members": { + "filter": { + "target": "com.amazonaws.datazone#Filter", + "traits": { + "smithy.api#documentation": "A search filter in Amazon DataZone.
" + } + }, + "and": { + "target": "com.amazonaws.datazone#FilterList", + "traits": { + "smithy.api#documentation": "The 'and' search filter clause in Amazon DataZone.
" + } + }, + "or": { + "target": "com.amazonaws.datazone#FilterList", + "traits": { + "smithy.api#documentation": "The 'or' search filter clause in Amazon DataZone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A search filter clause in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#FilterExpression": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.datazone#FilterExpressionType", + "traits": { + "smithy.api#documentation": "The search filter explresison type.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The search filter expression.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter expression in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#FilterExpressionType": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, + "com.amazonaws.datazone#FilterExpressions": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FilterExpression" + } + }, + "com.amazonaws.datazone#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FilterClause" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.datazone#FirstName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FormEntryInput": { + "type": "structure", + "members": { + "typeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier", + "traits": { + "smithy.api#documentation": "The type ID of the form entry.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The type revision of the form entry.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether a form entry is required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the form entry.
" + } + }, + "com.amazonaws.datazone#FormEntryOutput": { + "type": "structure", + "members": { + "typeName": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of the type of the form entry.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The type revision of the form entry.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether a form entry is required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the form entry.
" + } + }, + "com.amazonaws.datazone#FormInput": { + "type": "structure", + "members": { + "formName": { + "target": "com.amazonaws.datazone#FormName", + "traits": { + "smithy.api#documentation": "The name of the metadata form.
", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the metadata form type.
" + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the metadata form type.
" + } + }, + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The content of the metadata form.
", + "smithy.api#length": { + "max": 75000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a metadata form.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FormInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FormInput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FormName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$" + } + }, + "com.amazonaws.datazone#FormOutput": { + "type": "structure", + "members": { + "formName": { + "target": "com.amazonaws.datazone#FormName", + "traits": { + "smithy.api#documentation": "The name of the metadata form.
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of the metadata form type.
" + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the metadata form type.
" + } + }, + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The content of the metadata form.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a metadata form.
" + } + }, + "com.amazonaws.datazone#FormOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FormOutput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.datazone#FormType": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "formTypeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier" + }, + "revision": { + "target": "com.amazonaws.datazone#Revision" + } + }, + "properties": { + "model": { + "target": "com.amazonaws.datazone#Model" + }, + "name": { + "target": "com.amazonaws.datazone#FormTypeName" + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "status": { + "target": "com.amazonaws.datazone#FormTypeStatus" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateFormType" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.datazone#DeleteFormType" + }, + { + "target": "com.amazonaws.datazone#GetFormType" + } + ] + }, + "com.amazonaws.datazone#FormTypeData": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the form type exists.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of the form type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the form type.
", + "smithy.api#required": {} + } + }, + "model": { + "target": "com.amazonaws.datazone#Model", + "traits": { + "smithy.api#documentation": "The model of the form type.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#FormTypeStatus", + "traits": { + "smithy.api#documentation": "The status of the form type.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that owns the form type.
" + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the form type was originally\n created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project in which the form type was originally created.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the metadata form type was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created teh metadata form type.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the metadata form type.
" + } + }, + "imports": { + "target": "com.amazonaws.datazone#ImportList", + "traits": { + "smithy.api#documentation": "The imports specified in the form type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the metadata form type.
" + } + }, + "com.amazonaws.datazone#FormTypeIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 385 + }, + "smithy.api#pattern": "^(?!\\.)[\\w\\.]*\\w$" + } + }, + "com.amazonaws.datazone#FormTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(amazon.datazone.)?(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FormTypeStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#Forms": { + "type": "string" + }, + "com.amazonaws.datazone#FormsInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.datazone#FormName" + }, + "value": { + "target": "com.amazonaws.datazone#FormEntryInput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.datazone#FormsOutputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.datazone#FormName" + }, + "value": { + "target": "com.amazonaws.datazone#FormEntryOutput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.datazone#GetAsset": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetAssetInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetAssetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone asset.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetAssetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain to which the asset belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone asset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the Amazon DataZone asset.
", + "smithy.api#httpQuery": "revision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetAssetOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The ID of the asset.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AssetName", + "traits": { + "smithy.api#documentation": "The name of the asset.
", + "smithy.api#required": {} + } + }, + "typeIdentifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the asset type.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset type.
", + "smithy.api#required": {} + } + }, + "externalIdentifier": { + "target": "com.amazonaws.datazone#ExternalIdentifier", + "traits": { + "smithy.api#documentation": "" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone asset.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the asset.
" + } + }, + "firstRevisionCreatedAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the first revision of the asset was created.
" + } + }, + "firstRevisionCreatedBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the first revision of the asset.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The business glossary terms attached to the asset.
" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that owns the asset.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain to which the asset belongs.
", + "smithy.api#required": {} + } + }, + "listing": { + "target": "com.amazonaws.datazone#AssetListingDetails", + "traits": { + "smithy.api#documentation": "" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata forms attached to the asset.
", + "smithy.api#required": {} + } + }, + "readOnlyFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The read-only metadata forms attached to the asset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetAssetType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetAssetTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetAssetTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone asset type.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/asset-types/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetAssetTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset type exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the asset type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset type.
", + "smithy.api#httpQuery": "revision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetAssetTypeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset type exists.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The name of the asset type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the asset type.
" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap", + "traits": { + "smithy.api#documentation": "The metadata forms attached to the asset type.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project that owns the asset type.
", + "smithy.api#required": {} + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the asset type was originally created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project in which the asset type was originally created.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset type was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the asset type.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the asset type was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user that updated the asset type.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetDataSourceInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetDataSourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone data source.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetDataSourceInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetDataSourceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The ID of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the data source exists.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project where the data source creates and publishes assets.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment where this data source creates and publishes assets,
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", + "traits": { + "smithy.api#documentation": "The configuration of the data source.
", + "smithy.api#notProperty": {} + } + }, + "recommendation": { + "target": "com.amazonaws.datazone#RecommendationConfiguration", + "traits": { + "smithy.api#documentation": "" + } + }, + "enableSetting": { + "target": "com.amazonaws.datazone#EnableSetting", + "traits": { + "smithy.api#documentation": "Specifies whether this data source is enabled or not.
" + } + }, + "publishOnImport": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.
" + } + }, + "assetFormsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata forms attached to the assets created by this data source.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule of the data source runs.
" + } + }, + "lastRunStatus": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the last run of the data source.
" + } + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of the last run of the data source.
" + } + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "lastRunAssetCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of assets created by the data source during its last run.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetDataSourceRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetDataSourceRunInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetDataSourceRunOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone data source run.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-source-runs/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetDataSourceRunInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain in which this data source run was performed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The ID of the data source run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetDataSourceRunOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain in which this data source run was performed.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The ID of the data source for this data source run.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The ID of the data source run.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project in which this data source run occured.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of this data source run.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceRunType", + "traits": { + "smithy.api#documentation": "The type of this data source run.
", + "smithy.api#required": {} + } + }, + "dataSourceConfigurationSnapshot": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The configuration snapshot of the data source run.
" + } + }, + "runStatisticsForAssets": { + "target": "com.amazonaws.datazone#RunStatisticsForAssets", + "traits": { + "smithy.api#documentation": "The asset statistics from this data source run.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when this data source run was updated.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when this data source run started.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when this data source run stopped.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetDomainInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetDomainOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone domain.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{identifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#GetDomainInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the specified Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetDomainOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the specified Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon DataZone domain.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone domain.
" + } + }, + "singleSignOn": { + "target": "com.amazonaws.datazone#SingleSignOn", + "traits": { + "smithy.api#documentation": "The single sing-on option of the specified Amazon DataZone domain.
" + } + }, + "domainExecutionRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The domain execution role with which the Amazon DataZone domain is created.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the specified Amazon DataZone domain.
" + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.datazone#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#DomainStatus", + "traits": { + "smithy.api#documentation": "The status of the specified Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "portalUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL of the data portal for this Amazon DataZone domain.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the Amazon DataZone domain was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the Amazon DataZone domain was last updated.
" + } + }, + "tags": { + "target": "com.amazonaws.datazone#Tags", + "traits": { + "smithy.api#documentation": "The tags specified for the Amazon DataZone domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone environment.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprintInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprintOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon DataZone blueprint.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprintConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprintConfigurationInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentBlueprintConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the blueprint configuration in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprintConfigurationInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where this blueprint exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "He ID of the blueprint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprintConfigurationOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where this blueprint exists.
", + "smithy.api#required": {} + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioning role with which this blueprint is created.
" + } + }, + "manageAccessRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the manage access role with which this blueprint is created.
" + } + }, + "enabledRegions": { + "target": "com.amazonaws.datazone#EnabledRegionList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services regions in which this blueprint is enabled.
" + } + }, + "regionalParameters": { + "target": "com.amazonaws.datazone#RegionalParameterMap", + "traits": { + "smithy.api#documentation": "The regional parameters of the blueprint.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this blueprint was upated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which this blueprint exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of this Amazon DataZone blueprint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentBlueprintOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone blueprint.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "The deployment properties of this Amazon DataZone blueprint.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this blueprint.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms attached to this Amazon DataZone blueprint.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of when this blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this blueprint was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where the environment exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentOutput": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project in which this environment is created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain where the environment exists.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the environment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "environmentProfileId": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of the environment profile with which the environment is created.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account where the environment exists.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region where the environment exists.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of this Amazon DataZone environment.
", + "smithy.api#required": {} + } + }, + "provisionedResources": { + "target": "com.amazonaws.datazone#ResourceList", + "traits": { + "smithy.api#documentation": "The provisioned resources of this Amazon DataZone environment.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of this Amazon DataZone environment.
" + } + }, + "environmentActions": { + "target": "com.amazonaws.datazone#EnvironmentActionList", + "traits": { + "smithy.api#documentation": "The actions of the environment.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The business glossary terms that can be used in this environment.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone environment.
" + } + }, + "lastDeployment": { + "target": "com.amazonaws.datazone#Deployment", + "traits": { + "smithy.api#documentation": "The details of the last deployment of the environment.
" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of this Amazon DataZone environment.
" + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "The deployment properties of the environment.
" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The blueprint with which the environment is created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an evinronment profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-profiles/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this environment profile exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of the environment profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentProfileOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The ID of the environment profile.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this environment profile exists.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account where this environment profile exists.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region where this environment profile exists.
" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created this environment profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment profile was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this environment profile was upated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name of the environment profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the environment profile.
" + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint with which this environment profile is created.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone project in which this environment profile is created.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of the environment profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetFormType": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetFormTypeInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetFormTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a metadata form type in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/form-types/{formTypeIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetFormTypeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this metadata form type exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "formTypeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the metadata form type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of this metadata form type.
", + "smithy.api#httpQuery": "revision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetFormTypeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this metadata form type exists.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of the metadata form type.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the metadata form type.
", + "smithy.api#required": {} + } + }, + "model": { + "target": "com.amazonaws.datazone#Model", + "traits": { + "smithy.api#documentation": "The model of the metadata form type.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that owns this metadata form type.
" + } + }, + "originDomainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the metadata form type was originally\n created.
" + } + }, + "originProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project in which this metadata form type was originally created.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#FormTypeStatus", + "traits": { + "smithy.api#documentation": "The status of the metadata form type.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when this metadata form type was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created this metadata form type.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the metadata form type.
" + } + }, + "imports": { + "target": "com.amazonaws.datazone#ImportList", + "traits": { + "smithy.api#documentation": "The imports of the metadata form type.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetGlossary": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetGlossaryInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetGlossaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a business glossary in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/glossaries/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetGlossaryInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetGlossaryOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary exists.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project that owns this business glossary.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name of the business glossary.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription", + "traits": { + "smithy.api#documentation": "The description of the business glossary.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryStatus", + "traits": { + "smithy.api#documentation": "The status of the business glossary.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when this business glossary was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created this business glossary.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the business glossary was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the business glossary.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetGlossaryTerm": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetGlossaryTermInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetGlossaryTermOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a business glossary term in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/glossary-terms/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetGlossaryTermInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary term exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary term.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetGlossaryTermOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which this business glossary term exists.
", + "smithy.api#required": {} + } + }, + "glossaryId": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary to which this term belongs.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The ID of the business glossary term.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name of the business glossary term.
", + "smithy.api#required": {} + } + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription", + "traits": { + "smithy.api#documentation": "The short decription of the business glossary term.
" + } + }, + "longDescription": { + "target": "com.amazonaws.datazone#LongDescription", + "traits": { + "smithy.api#documentation": "The long description of the business glossary term.
" + } + }, + "termRelations": { + "target": "com.amazonaws.datazone#TermRelations", + "traits": { + "smithy.api#documentation": "The relations of the business glossary term.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryTermStatus", + "traits": { + "smithy.api#documentation": "The status of the business glossary term.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the business glossary term was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the business glossary.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the business glossary term was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the business glossary term.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetGroupProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetGroupProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetGroupProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a group profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/group-profiles/{groupIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#GetGroupProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the group profile exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the group profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetGroupProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the group profile exists.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#GroupProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the group profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GroupProfileStatus", + "traits": { + "smithy.api#documentation": "The identifier of the group profile.
" + } + }, + "groupName": { + "target": "com.amazonaws.datazone#GroupProfileName", + "traits": { + "smithy.api#documentation": "The name of the group for which the specified group profile exists.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetIamPortalLoginUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetIamPortalLoginUrlInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetIamPortalLoginUrlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the data portal URL for the specified Amazon DataZone domain.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/get-portal-login-url" + } + } + }, + "com.amazonaws.datazone#GetIamPortalLoginUrlInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "the ID of the Amazon DataZone domain the data portal of which you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetIamPortalLoginUrlOutput": { + "type": "structure", + "members": { + "authCodeUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data portal URL of the specified Amazon DataZone domain.
" + } + }, + "userProfileId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the user profile.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetListingInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetListingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/listings/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetListingInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "listingRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#default": "latest", + "smithy.api#documentation": "", + "smithy.api#httpQuery": "listingRevision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetListingOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "listingRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the listing was updated.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the listing.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the listing.
" + } + }, + "item": { + "target": "com.amazonaws.datazone#ListingItem", + "traits": { + "smithy.api#documentation": "" + } + }, + "name": { + "target": "com.amazonaws.datazone#ListingName", + "traits": { + "smithy.api#documentation": "" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "" + } + }, + "status": { + "target": "com.amazonaws.datazone#ListingStatus", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetProjectInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a project in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/projects/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetProjectInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the project exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetProjectOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the project exists.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": ">The ID of the project.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the project.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The business glossary terms that can be used in the project.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetSubscriptionInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetSubscriptionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a subscription in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscriptions/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetSubscriptionGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetSubscriptionGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the subscription grant in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscription-grants/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionGrantInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription grant exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionGrantOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription grant.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription grant.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription grant exists.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant was upated.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The subscription target ID associated with the subscription grant.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntity", + "traits": { + "smithy.api#documentation": "The entity to which the subscription is granted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantOverallStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription grant.
", + "smithy.api#required": {} + } + }, + "assets": { + "target": "com.amazonaws.datazone#SubscribedAssets", + "traits": { + "smithy.api#documentation": "The assets for which the subscription grant is created.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the subscription.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription exists.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was updated.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipal": { + "target": "com.amazonaws.datazone#SubscribedPrincipal", + "traits": { + "smithy.api#documentation": "The principal that owns the subscription.
", + "smithy.api#required": {} + } + }, + "subscribedListing": { + "target": "com.amazonaws.datazone#SubscribedListing", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "subscriptionRequestId": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The ID of the subscription request.
" + } + }, + "retainPermissions": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The retain permissions of the subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionRequestDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetSubscriptionRequestDetailsInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetSubscriptionRequestDetailsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of the specified subscription request.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionRequestDetailsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to get the subscription request\n details.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request the details of which to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionRequestDetailsOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription request.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The Amazon DataZone domain of the subscription request.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the specified subscription request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the subscription request.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipals", + "traits": { + "smithy.api#documentation": "The subscribed principals in the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "The subscribed listings in the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone user who reviewed the subscription request.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the subscription request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetSubscriptionTargetInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetSubscriptionTargetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the subscription target in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionTargetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription target exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment associated with the subscription target.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetSubscriptionTargetOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The ID of the subscription target.
", + "smithy.api#required": {} + } + }, + "authorizedPrincipals": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", + "traits": { + "smithy.api#documentation": "The authorized principals of the subscription target.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the subscription target exists.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project associated with the subscription target.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment associated with the subscription target.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name of the subscription target.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the subscription target.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription target.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription target.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was updated.
" + } + }, + "manageAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The manage access role with which the subscription target was created.
", + "smithy.api#required": {} + } + }, + "applicableAssetTypes": { + "target": "com.amazonaws.datazone#ApplicableAssetTypes", + "traits": { + "smithy.api#documentation": "The asset types associated with the subscription target.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetConfig": { + "target": "com.amazonaws.datazone#SubscriptionTargetForms", + "traits": { + "smithy.api#documentation": "The configuration of teh subscription target.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the subscription target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetUserProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetUserProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a user profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/user-profiles/{userIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#GetUserProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "the ID of the Amazon DataZone domain the data portal of which you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the user for which you want to get the user profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile.
", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetUserProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "the identifier of the Amazon DataZone domain of which you want to get the user\n profile.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#UserProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the user profile.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the user profile.
" + } + }, + "details": { + "target": "com.amazonaws.datazone#UserProfileDetails" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#Glossary": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryId" + } + }, + "properties": { + "id": { + "target": "com.amazonaws.datazone#GlossaryId" + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName" + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription" + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryStatus" + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateGlossary" + }, + "read": { + "target": "com.amazonaws.datazone#GetGlossary" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateGlossary" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteGlossary" + } + }, + "com.amazonaws.datazone#GlossaryDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GlossaryId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#GlossaryItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the business glossary exists.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The identifier of the glossary.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name of the glossary.
", + "smithy.api#required": {} + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that owns the business glosary.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription", + "traits": { + "smithy.api#documentation": "The business glossary description.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryStatus", + "traits": { + "smithy.api#documentation": "The business glossary status.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the glossary was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the glossary.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the business glossary was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the business glossary.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a business glossary.
" + } + }, + "com.amazonaws.datazone#GlossaryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GlossaryStatus": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.datazone#GlossaryTerm": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#GlossaryTermId" + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + } + }, + "properties": { + "id": { + "target": "com.amazonaws.datazone#GlossaryTermId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "glossaryIdentifier": { + "target": "com.amazonaws.datazone#GlossaryTermId" + }, + "glossaryId": { + "target": "com.amazonaws.datazone#GlossaryId" + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName" + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription" + }, + "longDescription": { + "target": "com.amazonaws.datazone#LongDescription" + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryTermStatus" + }, + "termRelations": { + "target": "com.amazonaws.datazone#TermRelations" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateGlossaryTerm" + }, + "read": { + "target": "com.amazonaws.datazone#GetGlossaryTerm" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateGlossaryTerm" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteGlossaryTerm" + } + }, + "com.amazonaws.datazone#GlossaryTermId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#GlossaryTermItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the business glossary exists.
", + "smithy.api#required": {} + } + }, + "glossaryId": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary to which the term belongs.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary term.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name of the business glossary term.
", + "smithy.api#required": {} + } + }, + "shortDescription": { + "target": "com.amazonaws.datazone#ShortDescription", + "traits": { + "smithy.api#documentation": "The short description of the business glossary term.
" + } + }, + "longDescription": { + "target": "com.amazonaws.datazone#LongDescription", + "traits": { + "smithy.api#documentation": "The long description of the business glossary term.
" + } + }, + "termRelations": { + "target": "com.amazonaws.datazone#TermRelations", + "traits": { + "smithy.api#documentation": "The relations of the business glossary term.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GlossaryTermStatus", + "traits": { + "smithy.api#documentation": "The status of the business glossary term.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when a business glossary term was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the business glossary.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when a business glossary term was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the business glossary term.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a business glossary term.
" + } + }, + "com.amazonaws.datazone#GlossaryTermName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GlossaryTermStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#GlossaryTerms": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#GlossaryTermId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.datazone#GlueRunConfigurationInput": { + "type": "structure", + "members": { + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data access role included in the configuration details of the Amazon Web Services Glue data\n source.
", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of the Amazon Web Services Glue data source.
" + } + }, + "com.amazonaws.datazone#GlueRunConfigurationOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data\n source.
", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.\n
", + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + } + }, + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data access role included in the configuration details of the Amazon Web Services Glue data\n source.
", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of the Amazon Web Services Glue data source.
" + } + }, + "com.amazonaws.datazone#GrantedEntity": { + "type": "union", + "members": { + "listing": { + "target": "com.amazonaws.datazone#ListingRevision", + "traits": { + "smithy.api#documentation": "The listing for which a subscription is granted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a listing for which a subscription is granted.
" + } + }, + "com.amazonaws.datazone#GrantedEntityInput": { + "type": "union", + "members": { + "listing": { + "target": "com.amazonaws.datazone#ListingRevisionInput", + "traits": { + "smithy.api#documentation": "The listing for which a subscription is to be granted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a listing for which a subscription is to be granted.
" + } + }, + "com.amazonaws.datazone#GroupDetails": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the group in Amazon DataZone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a group in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#GroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)" + } + }, + "com.amazonaws.datazone#GroupProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.datazone#GroupProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GroupProfileStatus": { + "type": "enum", + "members": { + "ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGNED" + } + }, + "NOT_ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ASSIGNED" + } + } + } + }, + "com.amazonaws.datazone#GroupProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#GroupProfileSummary" + } + }, + "com.amazonaws.datazone#GroupProfileSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain of a group profile.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#GroupProfileId", + "traits": { + "smithy.api#documentation": "The ID of a group profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GroupProfileStatus", + "traits": { + "smithy.api#documentation": "The status of a group profile.
" + } + }, + "groupName": { + "target": "com.amazonaws.datazone#GroupProfileName", + "traits": { + "smithy.api#documentation": "The group name of a group profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a group profile.
" + } + }, + "com.amazonaws.datazone#GroupSearchText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#GroupSearchType": { + "type": "enum", + "members": { + "SSO_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO_GROUP" + } + }, + "DATAZONE_SSO_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATAZONE_SSO_GROUP" + } + } + } + }, + "com.amazonaws.datazone#IamUserProfileDetails": { + "type": "structure", + "members": { + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of an IAM user profile in Amazon DataZone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an IAM user profile in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#Import": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The name of the import.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the import.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the import of the metadata form type.
" + } + }, + "com.amazonaws.datazone#ImportList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#Import" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.datazone#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.datazone#InventorySearchScope": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + }, + "GLOSSARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLOSSARY" + } + }, + "GLOSSARY_TERM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLOSSARY_TERM" + } + } + } + }, + "com.amazonaws.datazone#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.datazone#LastName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#ListAssetRevisions": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListAssetRevisionsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListAssetRevisionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the revisions for the asset.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/revisions" + }, + "smithy.api#paginated": {}, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListAssetRevisionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the asset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of revisions, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetRevisions to\n list the next set of revisions.
The maximum number of revisions to return in a single call to\n ListAssetRevisions. When the number of revisions to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListAssetRevisions to list the\n next set of revisions.
The results of the ListAssetRevisions action.
When the number of revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of revisions, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetRevisions to\n list the next set of revisions.
Lists data source run activities.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-source-runs/{identifier}/activities" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListDataSourceRunActivitiesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to list data source run\n activities.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The identifier of the data source run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataAssetActivityStatus", + "traits": { + "smithy.api#documentation": "The status of the data source run.
", + "smithy.api#httpQuery": "status" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of activities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of activities, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.
The maximum number of activities to return in a single call to\n ListDataSourceRunActivities. When the number of activities to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.
The results of the ListDataSourceRunActivities action.
When the number of activities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of activities, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.
Lists data source runs in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{dataSourceIdentifier}/runs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListDataSourceRunsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to invoke the\n ListDataSourceRuns action.
The identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#httpQuery": "status" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of runs, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDataSourceRuns to list the next set of\n runs.
The maximum number of runs to return in a single call to\n ListDataSourceRuns. When the number of runs to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListDataSourceRuns to list the next set of\n runs.
The results of the ListDataSourceRuns action.
When the number of runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of runs, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDataSourceRuns to list the next set of\n runs.
Lists data sources in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/data-sources" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListDataSourcesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to list the data sources.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the project in which to list data sources.
", + "smithy.api#httpQuery": "projectIdentifier", + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the environment in which to list the data sources.
", + "smithy.api#httpQuery": "environmentIdentifier" + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
", + "smithy.api#httpQuery": "type" + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#httpQuery": "status" + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpQuery": "name" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of data sources is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data sources, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListDataSources to\n list the next set of data sources.
The maximum number of data sources to return in a single call to\n ListDataSources. When the number of data sources to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListDataSources to list the\n next set of data sources.
The results of the ListDataSources action.
When the number of data sources is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data sources, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListDataSources to\n list the next set of data sources.
Lists Amazon DataZone domains.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListDomainsInput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.datazone#DomainStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#httpQuery": "status" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", + "traits": { + "smithy.api#documentation": "The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.
When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
The results of the ListDomains action.
When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
Lists blueprint configurations for a Amazon DataZone environment.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprint-configurations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#ListEnvironmentBlueprintConfigurationsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of blueprint configurations to return in a single call to\n ListEnvironmentBlueprintConfigurations. When the number of configurations\n to be listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.
When the number of blueprint configurations is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of configurations, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.
The results of the ListEnvironmentBlueprintConfigurations action.
When the number of blueprint configurations is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of configurations, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.
Lists blueprints in an Amazon DataZone environment.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentBlueprintsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of blueprints to return in a single call to\n ListEnvironmentBlueprints. When the number of blueprints to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentBlueprints to list the next set of blueprints.
When the number of blueprints in the environment is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of blueprints in the environment,\n the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintsto list the next set of blueprints.
The name of the Amazon DataZone environment.
", + "smithy.api#httpQuery": "name" + } + }, + "managed": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the environment blueprint is managed by Amazon DataZone.
", + "smithy.api#httpQuery": "managed" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentBlueprintsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintSummaries", + "traits": { + "smithy.api#documentation": "The results of the ListEnvironmentBlueprints action.
When the number of blueprints in the environment is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of blueprints in the environment,\n the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintsto list the next set of blueprints.
Lists Amazon DataZone environment profiles.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environment-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentProfilesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account where you want to list environment\n profiles.
", + "smithy.api#httpQuery": "awsAccountId" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region where you want to list environment profiles.
", + "smithy.api#httpQuery": "awsAccountRegion" + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the blueprint that was used to create the environment profiles that\n you want to list.
", + "smithy.api#httpQuery": "environmentBlueprintIdentifier" + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project.
", + "smithy.api#httpQuery": "projectIdentifier" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpQuery": "name" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of environment profiles is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment profiles, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.
The maximum number of environment profiles to return in a single call to\n ListEnvironmentProfiles. When the number of environment profiles to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.
The results of the ListEnvironmentProfiles action.
When the number of environment profiles is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment profiles, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.
Lists Amazon DataZone environments.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account where you want to list\n environments.
", + "smithy.api#httpQuery": "awsAccountId" + } + }, + "status": { + "target": "com.amazonaws.datazone#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the environments that you want to list.
", + "smithy.api#httpQuery": "status" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region where you want to list environments.
", + "smithy.api#httpQuery": "awsAccountRegion" + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone project.
", + "smithy.api#httpQuery": "projectIdentifier", + "smithy.api#required": {} + } + }, + "environmentProfileIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile.
", + "smithy.api#httpQuery": "environmentProfileIdentifier" + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone blueprint.
", + "smithy.api#httpQuery": "environmentBlueprintIdentifier" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the environment.
", + "smithy.api#httpQuery": "provider" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpQuery": "name" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of environments to return in a single call to\n ListEnvironments. When the number of environments to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListEnvironments to list the\n next set of environments.
When the number of environments is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environments, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironments to\n list the next set of environments.
The results of the ListEnvironments action.
When the number of environments is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environments, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironments to\n list the next set of environments.
Lists all Amazon DataZone notifications.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/notifications" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "notifications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListNotificationsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#NotificationType", + "traits": { + "smithy.api#documentation": "The type of notifications.
", + "smithy.api#httpQuery": "type", + "smithy.api#required": {} + } + }, + "afterTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time after which you want to list notifications.
", + "smithy.api#httpQuery": "afterTimestamp" + } + }, + "beforeTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time before which you want to list notifications.
", + "smithy.api#httpQuery": "beforeTimestamp" + } + }, + "subjects": { + "target": "com.amazonaws.datazone#NotificationSubjects", + "traits": { + "smithy.api#documentation": "The subjects of notifications.
", + "smithy.api#httpQuery": "subjects" + } + }, + "taskStatus": { + "target": "com.amazonaws.datazone#TaskStatus", + "traits": { + "smithy.api#documentation": "The task status of notifications.
", + "smithy.api#httpQuery": "taskStatus" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of notifications to return in a single call to\n ListNotifications. When the number of notifications to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListNotifications to list the\n next set of notifications.
When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.
The results of the ListNotifications action.
When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.
Lists all members of the specified project.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/memberships" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "members" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListProjectMembershipsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which you want to list project\n memberships.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project whose memberships you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortFieldProject", + "traits": { + "smithy.api#documentation": "The method by which you want to sort the project memberships.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the project memberships.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of memberships is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
The maximum number of memberships to return in a single call to\n ListProjectMemberships. When the number of memberships to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListProjectMemberships to list the next set of memberships.
The members of the project.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of memberships is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
Lists Amazon DataZone projects.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/projects" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListProjectsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone user.
", + "smithy.api#httpQuery": "userIdentifier" + } + }, + "groupIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of a group.
", + "smithy.api#httpQuery": "groupIdentifier" + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpQuery": "name" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of projects is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of projects, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjects to list\n the next set of projects.
The maximum number of projects to return in a single call to ListProjects.\n When the number of projects to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListProjects to list the next set of\n projects.
The results of the ListProjects action.
When the number of projects is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of projects, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjects to list\n the next set of projects.
Lists subscription grants.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscription-grants" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListSubscriptionGrantsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone environment.
", + "smithy.api#httpQuery": "environmentId" + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription target.
", + "smithy.api#httpQuery": "subscriptionTargetId" + } + }, + "subscribedListingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the subscribed listing.
", + "smithy.api#httpQuery": "subscribedListingId" + } + }, + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription.
", + "smithy.api#httpQuery": "subscriptionId" + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortKey", + "traits": { + "smithy.api#documentation": "Specifies the way of sorting the results of this action.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies the sort order of this action.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of subscription grants to return in a single call to\n ListSubscriptionGrants. When the number of subscription grants to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionGrants to list the next set of subscription grants.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
The results of the ListSubscriptionGrants action.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
Lists Amazon DataZone subscription requests.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListSubscriptionRequestsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "Specifies the status of the subscription requests.
", + "smithy.api#httpQuery": "status" + } + }, + "subscribedListingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the subscribed listing.
", + "smithy.api#httpQuery": "subscribedListingId" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project for the subscription requests.
", + "smithy.api#httpQuery": "owningProjectId" + } + }, + "approverProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request approver's project.
", + "smithy.api#httpQuery": "approverProjectId" + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortKey", + "traits": { + "smithy.api#documentation": "Specifies the way to sort the results of this action.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies the sort order for the results of this action.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of subscription requests to return in a single call to\n ListSubscriptionRequests. When the number of subscription requests to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.
When the number of subscription requests is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription requests, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.
The results of the ListSubscriptionRequests action.
When the number of subscription requests is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription requests, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.
Lists subscription targets in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListSubscriptionTargetsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain where you want to list subscription\n targets.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment where you want to list subscription targets.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortKey", + "traits": { + "smithy.api#documentation": "Specifies the way in which the results of this action are to be sorted.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies the sort order for the results of this action.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of subscription targets to return in a single call to\n ListSubscriptionTargets. When the number of subscription targets to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription targets.\n
When the number of subscription targets is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription targets, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription\n targets.
The results of the ListSubscriptionTargets action.
When the number of subscription targets is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription targets, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription\n targets.
Lists subscriptions in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscriptions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListSubscriptionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "subscriptionRequestIdentifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request for the subscriptions that you want to\n list.
", + "smithy.api#httpQuery": "subscriptionRequestIdentifier" + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "The status of the subscriptions that you want to list.
", + "smithy.api#httpQuery": "status" + } + }, + "subscribedListingId": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the subscribed listing for the subscriptions that you want to\n list.
", + "smithy.api#httpQuery": "subscribedListingId" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the owning project.
", + "smithy.api#httpQuery": "owningProjectId" + } + }, + "approverProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project for the subscription's approver.
", + "smithy.api#httpQuery": "approverProjectId" + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortKey", + "traits": { + "smithy.api#documentation": "Specifies the way in which the results of this action are to be sorted.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies the sort order for the results of this action.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of subscriptions to return in a single call to\n ListSubscriptions. When the number of subscriptions to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListSubscriptions to list the\n next set of Subscriptions.
When the number of subscriptions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscriptions, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptions to\n list the next set of subscriptions.
The results of the ListSubscriptions action.
When the number of subscriptions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscriptions, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptions to\n list the next set of subscriptions.
Lists tags for the specified resource in Amazon DataZone.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource whose tags you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.datazone#Tags", + "traits": { + "smithy.api#documentation": "The tags of the specified resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#Listing": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#ListingId" + } + }, + "properties": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "id": { + "target": "com.amazonaws.datazone#ListingId" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "listingRevision": { + "target": "com.amazonaws.datazone#Revision" + }, + "name": { + "target": "com.amazonaws.datazone#ListingName" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" + }, + "item": { + "target": "com.amazonaws.datazone#ListingItem" + }, + "status": { + "target": "com.amazonaws.datazone#ListingStatus" + } + }, + "read": { + "target": "com.amazonaws.datazone#GetListing" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteListing" + } + }, + "com.amazonaws.datazone#ListingId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#ListingItem": { + "type": "union", + "members": { + "assetListing": { + "target": "com.amazonaws.datazone#AssetListing", + "traits": { + "smithy.api#documentation": "An asset published in an Amazon DataZone catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a listing (aka asset published in a Amazon DataZone catalog).
" + } + }, + "com.amazonaws.datazone#ListingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.datazone#ListingRevision": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "An identifier of a revision of an asset published in a Amazon DataZone catalog.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The details of a revision of an asset published in a Amazon DataZone catalog.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A revision of an asset published in a Amazon DataZone catalog.
" + } + }, + "com.amazonaws.datazone#ListingRevisionInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "An identifier of revision to be made to an asset published in a Amazon DataZone\n catalog.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The details of a revision to be made to an asset published in a Amazon DataZone\n catalog.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A revision to be made to an asset published in a Amazon DataZone catalog.
" + } + }, + "com.amazonaws.datazone#ListingStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.datazone#LongDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.datazone#MaxResultsForListDomains": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.datazone#Member": { + "type": "union", + "members": { + "userIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The user ID of a project member.
" + } + }, + "groupIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the group of a project member.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about a project member.
" + } + }, + "com.amazonaws.datazone#MemberDetails": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#UserDetails", + "traits": { + "smithy.api#documentation": "The user details of a project member.
" + } + }, + "group": { + "target": "com.amazonaws.datazone#GroupDetails", + "traits": { + "smithy.api#documentation": "The group details of a project member.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about a project member.
" + } + }, + "com.amazonaws.datazone#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 16384 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#MetadataMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#Model": { + "type": "union", + "members": { + "smithy": { + "target": "com.amazonaws.datazone#Smithy", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#NotificationOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#TaskId", + "traits": { + "smithy.api#documentation": "The identifier of the notification.
", + "smithy.api#required": {} + } + }, + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of a Amazon DataZone domain in which the notification exists.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#NotificationType", + "traits": { + "smithy.api#documentation": "The type of the notification.
", + "smithy.api#required": {} + } + }, + "topic": { + "target": "com.amazonaws.datazone#Topic", + "traits": { + "smithy.api#documentation": "The topic of the notification.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.datazone#Title", + "traits": { + "smithy.api#documentation": "The title of the notification.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.datazone#Message", + "traits": { + "smithy.api#documentation": "The message included in the notification.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#TaskStatus", + "traits": { + "smithy.api#documentation": "The status included in the notification.
" + } + }, + "actionLink": { + "target": "com.amazonaws.datazone#ActionLink", + "traits": { + "smithy.api#documentation": "The action link included in the notification.
", + "smithy.api#required": {} + } + }, + "creationTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when a notification was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the notification was last updated.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.datazone#MetadataMap", + "traits": { + "smithy.api#documentation": "The metadata included in the notification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a notification generated in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#NotificationResource": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.datazone#NotificationResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource mentioned in a notification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the resource mentioned in a notification.
" + } + }, + "com.amazonaws.datazone#NotificationResourceType": { + "type": "enum", + "members": { + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT" + } + } + } + }, + "com.amazonaws.datazone#NotificationRole": { + "type": "enum", + "members": { + "PROJECT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_OWNER" + } + }, + "PROJECT_CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + } + }, + "PROJECT_VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_VIEWER" + } + }, + "DOMAIN_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_OWNER" + } + }, + "PROJECT_SUBSCRIBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_SUBSCRIBER" + } + } + } + }, + "com.amazonaws.datazone#NotificationSubjects": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#NotificationType": { + "type": "enum", + "members": { + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } + } + }, + "com.amazonaws.datazone#NotificationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#NotificationOutput" + } + }, + "com.amazonaws.datazone#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.datazone#PredictionChoices": { + "type": "list", + "member": { + "target": "smithy.api#Integer" + } + }, + "com.amazonaws.datazone#PredictionConfiguration": { + "type": "structure", + "members": { + "businessNameGeneration": { + "target": "com.amazonaws.datazone#BusinessNameGenerationConfiguration", + "traits": { + "smithy.api#documentation": "The business name generation mechanism.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the prediction.
" + } + }, + "com.amazonaws.datazone#ProjectId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#ProjectMember": { + "type": "structure", + "members": { + "memberDetails": { + "target": "com.amazonaws.datazone#MemberDetails", + "traits": { + "smithy.api#documentation": "The membership details of a project member.
", + "smithy.api#required": {} + } + }, + "designation": { + "target": "com.amazonaws.datazone#UserDesignation", + "traits": { + "smithy.api#documentation": "The designated role of a project member.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a project member.
" + } + }, + "com.amazonaws.datazone#ProjectMembers": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProjectMember" + } + }, + "com.amazonaws.datazone#ProjectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#ProjectSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProjectSummary" + } + }, + "com.amazonaws.datazone#ProjectSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of a Amazon DataZone domain where the project exists.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of a project.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of a project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of a project.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the project.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when a project was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a Amazon DataZone project.
" + } + }, + "com.amazonaws.datazone#ProvisioningProperties": { + "type": "union", + "members": { + "cloudFormation": { + "target": "com.amazonaws.datazone#CloudFormationProperties", + "traits": { + "smithy.api#documentation": "The cloud formation properties included as part of the provisioning properties of an\n environment blueprint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The provisioning properties of an environment blueprint.
" + } + }, + "com.amazonaws.datazone#PutEnvironmentBlueprintConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#PutEnvironmentBlueprintConfigurationInput" + }, + "output": { + "target": "com.amazonaws.datazone#PutEnvironmentBlueprintConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Writes the configuration for the specified environment blueprint in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#PutEnvironmentBlueprintConfigurationInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentBlueprintIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the environment blueprint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "provisioningRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioning role.
" + } + }, + "manageAccessRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the manage access role.
" + } + }, + "enabledRegions": { + "target": "com.amazonaws.datazone#EnabledRegionList", + "traits": { + "smithy.api#documentation": "Specifies the enabled Amazon Web Services Regions.
", + "smithy.api#required": {} + } + }, + "regionalParameters": { + "target": "com.amazonaws.datazone#RegionalParameterMap", + "traits": { + "smithy.api#documentation": "The regional parameters in the environment blueprint.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#PutEnvironmentBlueprintConfigurationOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "environmentBlueprintId": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the environment blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioning role.
" + } + }, + "manageAccessRoleArn": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the manage access role.
" + } + }, + "enabledRegions": { + "target": "com.amazonaws.datazone#EnabledRegionList", + "traits": { + "smithy.api#documentation": "Specifies the enabled Amazon Web Services Regions.
" + } + }, + "regionalParameters": { + "target": "com.amazonaws.datazone#RegionalParameterMap", + "traits": { + "smithy.api#documentation": "The regional parameters in the environment blueprint.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment blueprint was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RecommendationConfiguration": { + "type": "structure", + "members": { + "enableBusinessNameGeneration": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether automatic business name generation is to be enabled or not as part of\n the recommendation configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The recommendation to be updated as part of the UpdateDataSource\n action.
The name of an Amazon Redshift cluster.
", + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-z].[a-z0-9\\-]*$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the Amazon Redshift cluster storage.
" + } + }, + "com.amazonaws.datazone#RedshiftCredentialConfiguration": { + "type": "structure", + "members": { + "secretManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of a secret manager for an Amazon Redshift cluster.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the credentials required to access an Amazon Redshift cluster.
" + } + }, + "com.amazonaws.datazone#RedshiftRunConfigurationInput": { + "type": "structure", + "members": { + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data access role included in the configuration details of the Amazon Redshift data\n source.
", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.
", + "smithy.api#required": {} + } + }, + "redshiftCredentialConfiguration": { + "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "redshiftStorage": { + "target": "com.amazonaws.datazone#RedshiftStorage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of the Amazon Redshift data source.
" + } + }, + "com.amazonaws.datazone#RedshiftRunConfigurationOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift\n data source.
", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region included in the configuration details of the Amazon Redshift\n data source.
", + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]" + } + }, + "dataAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data access role included in the configuration details of the Amazon Redshift data\n source.
", + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" + } + }, + "relationalFilterConfigurations": { + "target": "com.amazonaws.datazone#RelationalFilterConfigurations", + "traits": { + "smithy.api#documentation": "The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.
", + "smithy.api#required": {} + } + }, + "redshiftCredentialConfiguration": { + "target": "com.amazonaws.datazone#RedshiftCredentialConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "redshiftStorage": { + "target": "com.amazonaws.datazone#RedshiftStorage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of the Amazon Redshift data source.
" + } + }, + "com.amazonaws.datazone#RedshiftServerlessStorage": { + "type": "structure", + "members": { + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Redshift Serverless workgroup.
", + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the Amazon Redshift Serverless workgroup storage.
" + } + }, + "com.amazonaws.datazone#RedshiftStorage": { + "type": "union", + "members": { + "redshiftClusterSource": { + "target": "com.amazonaws.datazone#RedshiftClusterStorage", + "traits": { + "smithy.api#documentation": "The details of the Amazon Redshift cluster source.
" + } + }, + "redshiftServerlessSource": { + "target": "com.amazonaws.datazone#RedshiftServerlessStorage", + "traits": { + "smithy.api#documentation": "The details of the Amazon Redshift Serverless workgroup source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the Amazon Redshift storage as part of the configuration of an Amazon\n Redshift data source run.
" + } + }, + "com.amazonaws.datazone#RegionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$" + } + }, + "com.amazonaws.datazone#RegionalParameter": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#RegionalParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.datazone#RegionName" + }, + "value": { + "target": "com.amazonaws.datazone#RegionalParameter" + } + }, + "com.amazonaws.datazone#RejectChoice": { + "type": "structure", + "members": { + "predictionTarget": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the target (for example, a column name) where a prediction can be\n rejected.
" + } + }, + "predictionChoices": { + "target": "com.amazonaws.datazone#PredictionChoices", + "traits": { + "smithy.api#documentation": "Specifies the the automatically generated business metadata that can be rejected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the automatically generated business metadata that is rejected.
" + } + }, + "com.amazonaws.datazone#RejectChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RejectChoice" + } + }, + "com.amazonaws.datazone#RejectPredictions": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RejectPredictionsInput" + }, + "output": { + "target": "com.amazonaws.datazone#RejectPredictionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Rejects automatically generated business-friendly metadata for your Amazon DataZone\n assets.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/assets/{identifier}/reject-predictions" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#RejectPredictionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the prediction.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#httpQuery": "revision" + } + }, + "rejectRule": { + "target": "com.amazonaws.datazone#RejectRule", + "traits": { + "smithy.api#documentation": "" + } + }, + "rejectChoices": { + "target": "com.amazonaws.datazone#RejectChoices", + "traits": { + "smithy.api#documentation": "" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#RejectPredictionsOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "assetRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RejectRule": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.datazone#RejectRuleBehavior", + "traits": { + "smithy.api#documentation": "Specifies whether you want to reject the top prediction for all targets or none.
" + } + }, + "threshold": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The confidence score that specifies the condition at which a prediction can be\n rejected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the rule and the threshold under which a prediction can be rejected.
" + } + }, + "com.amazonaws.datazone#RejectRuleBehavior": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.datazone#RejectSubscriptionRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RejectSubscriptionRequestInput" + }, + "output": { + "target": "com.amazonaws.datazone#RejectSubscriptionRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Rejects the specified subscription request.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}/reject" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#RejectSubscriptionRequestInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the subscription request was\n rejected.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request that was rejected.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the rejected subscription request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#RejectSubscriptionRequestOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request that was rejected.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was rejected.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the subscription request was\n rejected.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was rejected.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the subscription request.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipals", + "traits": { + "smithy.api#documentation": "The subscribed principals of the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "The subscribed listings of the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request reviewer.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the rejected subscription request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RelationalFilterConfiguration": { + "type": "structure", + "members": { + "databaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The database name specified in the relational filter configuration for the data\n source.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The schema name specified in the relational filter configuration for the data\n source.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "filterExpressions": { + "target": "com.amazonaws.datazone#FilterExpressions", + "traits": { + "smithy.api#documentation": "The filter expressions specified in the relational filter configuration for the data\n source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The relational filter configuration for the data source.
" + } + }, + "com.amazonaws.datazone#RelationalFilterConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RelationalFilterConfiguration" + } + }, + "com.amazonaws.datazone#RequestReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#Resource": { + "type": "structure", + "members": { + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of a provisioned resource of this Amazon DataZone environment.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of a provisioned resource of this Amazon DataZone environment.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of a provisioned resource of this Amazon DataZone environment.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of a provisioned resource of this Amazon DataZone environment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a provisioned resource of this Amazon DataZone environment.
" + } + }, + "com.amazonaws.datazone#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#Resource" + } + }, + "com.amazonaws.datazone#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource cannot be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.datazone#Revision": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.datazone#RevokeSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RevokeSubscriptionInput" + }, + "output": { + "target": "com.amazonaws.datazone#RevokeSubscriptionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Revokes a specified subscription in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/subscriptions/{identifier}/revoke" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#RevokeSubscriptionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain where you want to revoke a subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the revoked subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retainPermissions": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether permissions are retained when the subscription is revoked.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#RevokeSubscriptionOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the revoked subscription.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier of the user who revoked the subscription.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who revoked the subscription.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain where you want to revoke a subscription.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "The status of the revoked subscription.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was revoked.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was revoked.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipal": { + "target": "com.amazonaws.datazone#SubscribedPrincipal", + "traits": { + "smithy.api#documentation": "The subscribed principal of the revoked subscription.
", + "smithy.api#required": {} + } + }, + "subscribedListing": { + "target": "com.amazonaws.datazone#SubscribedListing", + "traits": { + "smithy.api#documentation": "The subscribed listing of the revoked subscription.
", + "smithy.api#required": {} + } + }, + "subscriptionRequestId": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request for the revoked subscription.
" + } + }, + "retainPermissions": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether permissions are retained when the subscription is revoked.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "com.amazonaws.datazone#RunStatisticsForAssets": { + "type": "structure", + "members": { + "added": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The added statistic for the data source run.
The updated statistic for the data source run.
The unchanged statistic for the data source run.
The skipped statistic for the data source run.
The failed statistic for the data source run.
The asset statistics from the data source run.
" + } + }, + "com.amazonaws.datazone#ScheduleConfiguration": { + "type": "structure", + "members": { + "timezone": { + "target": "com.amazonaws.datazone#Timezone", + "traits": { + "smithy.api#documentation": "The timezone of the data source run.
" + } + }, + "schedule": { + "target": "com.amazonaws.datazone#CronString", + "traits": { + "smithy.api#documentation": "The schedule of the data source runs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the schedule of the data source runs.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#Search": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#SearchInput" + }, + "output": { + "target": "com.amazonaws.datazone#SearchOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches for assets in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/search" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + } + } + }, + "com.amazonaws.datazone#SearchGroupProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#SearchGroupProfilesInput" + }, + "output": { + "target": "com.amazonaws.datazone#SearchGroupProfilesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches group profiles in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/search-group-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#SearchGroupProfilesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which you want to search group\n profiles.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupType": { + "target": "com.amazonaws.datazone#GroupSearchType", + "traits": { + "smithy.api#documentation": "The group type for which to search.
", + "smithy.api#required": {} + } + }, + "searchText": { + "target": "com.amazonaws.datazone#GroupSearchText", + "traits": { + "smithy.api#documentation": "Specifies the text for which to search.
" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call to\n SearchGroupProfiles. When the number of results to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to SearchGroupProfiles to list the\n next set of results.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchGroupProfiles to list the next set of\n results.
The results of the SearchGroupProfiles action.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchGroupProfiles to list the next set of\n results.
The search attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the search.
" + } + }, + "com.amazonaws.datazone#SearchInList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SearchInItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.datazone#SearchInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "owningProjectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the owning project specified for the search.
" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call to Search. When\n the number of results to be listed is greater than the value of MaxResults,\n the response contains a NextToken value that you can use in a subsequent call\n to Search to list the next set of results.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to Search to list the next set of results.
The scope of the search.
", + "smithy.api#required": {} + } + }, + "searchText": { + "target": "com.amazonaws.datazone#SearchText", + "traits": { + "smithy.api#documentation": "Specifies the text for which to search.
" + } + }, + "searchIn": { + "target": "com.amazonaws.datazone#SearchInList", + "traits": { + "smithy.api#documentation": "" + } + }, + "filters": { + "target": "com.amazonaws.datazone#FilterClause", + "traits": { + "smithy.api#documentation": "Specifies the search filters.
" + } + }, + "sort": { + "target": "com.amazonaws.datazone#SearchSort", + "traits": { + "smithy.api#documentation": "Specifies the way in which the search results are to be sorted.
" + } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#SearchOutputAdditionalAttributes", + "traits": { + "smithy.api#documentation": "Specifies additional attributes for the Search action.
The glossary item included in the search results.
" + } + }, + "glossaryTermItem": { + "target": "com.amazonaws.datazone#GlossaryTermItem", + "traits": { + "smithy.api#documentation": "The glossary term item included in the search results.
" + } + }, + "assetItem": { + "target": "com.amazonaws.datazone#AssetItem", + "traits": { + "smithy.api#documentation": "The asset item included in the search results.
" + } + }, + "dataProductItem": { + "target": "com.amazonaws.datazone#DataProductSummary", + "traits": { + "smithy.api#documentation": "The data product item included in the search results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the search results.
" + } + }, + "com.amazonaws.datazone#SearchInventoryResultItems": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SearchInventoryResultItem" + } + }, + "com.amazonaws.datazone#SearchListings": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#SearchListingsInput" + }, + "output": { + "target": "com.amazonaws.datazone#SearchListingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches listings in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/listings/search" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + } + } + }, + "com.amazonaws.datazone#SearchListingsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which to search listings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchText": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the text for which to search.
" + } + }, + "searchIn": { + "target": "com.amazonaws.datazone#SearchInList", + "traits": { + "smithy.api#documentation": "" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call to SearchListings.\n When the number of results to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to SearchListings to list the next set of\n results.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchListings to list the next set of\n results.
Specifies the filters for the search of listings.
" + } + }, + "sort": { + "target": "com.amazonaws.datazone#SearchSort", + "traits": { + "smithy.api#documentation": "Specifies the way for sorting the search results.
" + } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#SearchOutputAdditionalAttributes", + "traits": { + "smithy.api#documentation": "Specifies additional attributes for the search.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#SearchListingsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#SearchResultItems", + "traits": { + "smithy.api#documentation": "The results of the SearchListings action.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchListings to list the next set of\n results.
Total number of search results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#SearchOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#SearchInventoryResultItems", + "traits": { + "smithy.api#documentation": "The results of the Search action.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to Search to list the next set of results.
Total number of search results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#SearchOutputAdditionalAttribute": { + "type": "enum", + "members": { + "FORMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORMS" + } + } + } + }, + "com.amazonaws.datazone#SearchOutputAdditionalAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SearchOutputAdditionalAttribute" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.datazone#SearchResultItem": { + "type": "union", + "members": { + "assetListing": { + "target": "com.amazonaws.datazone#AssetListingItem", + "traits": { + "smithy.api#documentation": "The asset listing included in the results of the SearchListings\n action.
The details of the results of the SearchListings action.
The attribute detail of the way to sort search results.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "The order detail of the wya to sort search results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the way to sort search results.
" + } + }, + "com.amazonaws.datazone#SearchText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.datazone#SearchTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#SearchTypesInput" + }, + "output": { + "target": "com.amazonaws.datazone#SearchTypesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches for types in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/types-search" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + } + } + }, + "com.amazonaws.datazone#SearchTypesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to invoke the SearchTypes\n action.
The maximum number of results to return in a single call to SearchTypes.\n When the number of results to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to SearchTypes to list the next set of results.\n
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchTypes to list the next set of\n results.
Specifies the scope of the search for types.
", + "smithy.api#required": {} + } + }, + "searchText": { + "target": "com.amazonaws.datazone#SearchText", + "traits": { + "smithy.api#documentation": "Specifies the text for which to search.
" + } + }, + "searchIn": { + "target": "com.amazonaws.datazone#SearchInList", + "traits": { + "smithy.api#documentation": "" + } + }, + "filters": { + "target": "com.amazonaws.datazone#FilterClause", + "traits": { + "smithy.api#documentation": "The filters for the SearchTypes action.
The specifies the way to sort the SearchTypes results.
The results of the SearchTypes action.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchTypes to list the next set of\n results.
Total number of search results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#SearchTypesResultItem": { + "type": "union", + "members": { + "assetTypeItem": { + "target": "com.amazonaws.datazone#AssetTypeItem", + "traits": { + "smithy.api#documentation": "The asset type included in the results of the SearchTypes action.
The form type included in the results of the SearchTypes action.
The details of the results of the SearchTypes action.
Searches user profiles in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/search-user-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#SearchUserProfilesInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which you want to search user\n profiles.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userType": { + "target": "com.amazonaws.datazone#UserSearchType", + "traits": { + "smithy.api#documentation": "Specifies the user type for the SearchUserProfiles action.
Specifies the text for which to search.
" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call to\n SearchUserProfiles. When the number of results to be listed is greater than\n the value of MaxResults, the response contains a NextToken value\n that you can use in a subsequent call to SearchUserProfiles to list the next\n set of results.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchUserProfiles to list the next set of\n results.
The results of the SearchUserProfiles action.
When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchUserProfiles to list the next set of\n results.
The request has exceeded the specified service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.datazone#ShortDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#SingleSignOn": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.datazone#AuthType", + "traits": { + "smithy.api#documentation": "The type of single sign-on in Amazon DataZone.
" + } + }, + "userAssignment": { + "target": "com.amazonaws.datazone#UserAssignment", + "traits": { + "smithy.api#documentation": "The single sign-on user assignment in Amazon DataZone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The single sign-on details in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#Smithy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.datazone#SortFieldProject": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.datazone#SortKey": { + "type": "enum", + "members": { + "CREATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED_AT" + } + }, + "UPDATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_AT" + } + } + } + }, + "com.amazonaws.datazone#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.datazone#SsoUserProfileDetails": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.datazone#UserProfileName", + "traits": { + "smithy.api#documentation": "The username included in the single sign-on details of the user profile.
" + } + }, + "firstName": { + "target": "com.amazonaws.datazone#FirstName", + "traits": { + "smithy.api#documentation": "The first name included in the single sign-on details of the user profile.
" + } + }, + "lastName": { + "target": "com.amazonaws.datazone#LastName", + "traits": { + "smithy.api#documentation": "The last name included in the single sign-on details of the user profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The single sign-on details of the user profile.
" + } + }, + "com.amazonaws.datazone#StartDataSourceRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#StartDataSourceRunInput" + }, + "output": { + "target": "com.amazonaws.datazone#StartDataSourceRunOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Start the run of the specified data source in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{dataSourceIdentifier}/runs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#StartDataSourceRunInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to start a data source run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceIdentifier": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#StartDataSourceRunOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which to start a data source run.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#DataSourceRunId", + "traits": { + "smithy.api#documentation": "The identifier of the data source run.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceRunStatus", + "traits": { + "smithy.api#documentation": "The status of the data source run.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#DataSourceRunType", + "traits": { + "smithy.api#documentation": "The type of the data source run.
", + "smithy.api#required": {} + } + }, + "dataSourceConfigurationSnapshot": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The configuration snapshot of the data source that is being run.
" + } + }, + "runStatisticsForAssets": { + "target": "com.amazonaws.datazone#RunStatisticsForAssets", + "traits": { + "smithy.api#documentation": "Specifies run statistics for assets.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when data source run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source run was updated.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source run was started.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source run was stopped.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#SubscribedAsset": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the asset for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "assetRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the asset for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantStatus", + "traits": { + "smithy.api#documentation": "The status of the asset for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "targetName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The target name of the asset for which the subscription grant is created.
" + } + }, + "failureCause": { + "target": "com.amazonaws.datazone#FailureCause", + "traits": { + "smithy.api#documentation": "The failure cause included in the details of the asset for which the subscription grant\n is created.
" + } + }, + "grantedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant to the asset is created.
" + } + }, + "failureTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The failure timestamp included in the details of the asset for which the subscription\n grant is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the asset for which the subscription grant is created.
" + } + }, + "com.amazonaws.datazone#SubscribedAssetListing": { + "type": "structure", + "members": { + "entityId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the published asset for which the subscription grant is\n created.
" + } + }, + "entityRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the published asset for which the subscription grant is created.
" + } + }, + "entityType": { + "target": "com.amazonaws.datazone#TypeName", + "traits": { + "smithy.api#documentation": "The type of the published asset for which the subscription grant is created.
" + } + }, + "forms": { + "target": "com.amazonaws.datazone#Forms", + "traits": { + "smithy.api#documentation": "The forms attached to the published asset for which the subscription grant is\n created.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms attached to the published asset for which the subscription grant is\n created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the published asset for which the subscription grant is created.
" + } + }, + "com.amazonaws.datazone#SubscribedAssets": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscribedAsset" + } + }, + "com.amazonaws.datazone#SubscribedListing": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the published asset for which the subscription grant is\n created.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the published asset for which the subscription grant is created.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#ListingName", + "traits": { + "smithy.api#documentation": "The name of the published asset for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the published asset for which the subscription grant is\n created.
", + "smithy.api#required": {} + } + }, + "item": { + "target": "com.amazonaws.datazone#SubscribedListingItem", + "traits": { + "smithy.api#documentation": "The published asset for which the subscription grant is created.
", + "smithy.api#required": {} + } + }, + "ownerProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project of the published asset for which the subscription grant is\n created.
", + "smithy.api#required": {} + } + }, + "ownerProjectName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the project that owns the published asset for which the subscription grant\n is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the published asset for which the subscription grant is created.
" + } + }, + "com.amazonaws.datazone#SubscribedListingInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#ListingId", + "traits": { + "smithy.api#documentation": "The identifier of the published asset for which the subscription grant is to be\n created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The published asset for which the subscription grant is to be created.
" + } + }, + "com.amazonaws.datazone#SubscribedListingInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscribedListingInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.datazone#SubscribedListingItem": { + "type": "union", + "members": { + "assetListing": { + "target": "com.amazonaws.datazone#SubscribedAssetListing", + "traits": { + "smithy.api#documentation": "The asset for which the subscription grant is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The published asset for which the subscription grant is created.
" + } + }, + "com.amazonaws.datazone#SubscribedListings": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscribedListing" + } + }, + "com.amazonaws.datazone#SubscribedPrincipal": { + "type": "union", + "members": { + "project": { + "target": "com.amazonaws.datazone#SubscribedProject", + "traits": { + "smithy.api#documentation": "The project that has the subscription grant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The principal that has the subscription grant for the asset.
" + } + }, + "com.amazonaws.datazone#SubscribedPrincipalInput": { + "type": "union", + "members": { + "project": { + "target": "com.amazonaws.datazone#SubscribedProjectInput", + "traits": { + "smithy.api#documentation": "The project that is to be given a subscription grant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The principal that is to be given a subscriptiong grant.
" + } + }, + "com.amazonaws.datazone#SubscribedPrincipalInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscribedPrincipalInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.datazone#SubscribedPrincipals": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscribedPrincipal" + } + }, + "com.amazonaws.datazone#SubscribedProject": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that has the subscription grant.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that has the subscription grant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The project that has the subscription grant.
" + } + }, + "com.amazonaws.datazone#SubscribedProjectInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that is to be given a subscription grant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The project that is to be given a subscription grant.
" + } + }, + "com.amazonaws.datazone#SubscriptionGrantId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#SubscriptionGrantOverallStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "GRANT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_FAILED" + } + }, + "REVOKE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE_FAILED" + } + }, + "GRANT_AND_REVOKE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_AND_REVOKE_FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "INACCESSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE" + } + } + } + }, + "com.amazonaws.datazone#SubscriptionGrantStatus": { + "type": "enum", + "members": { + "GRANT_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_PENDING" + } + }, + "REVOKE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE_PENDING" + } + }, + "GRANT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_IN_PROGRESS" + } + }, + "REVOKE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE_IN_PROGRESS" + } + }, + "GRANTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANTED" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "GRANT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_FAILED" + } + }, + "REVOKE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE_FAILED" + } + } + } + }, + "com.amazonaws.datazone#SubscriptionGrantSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription grant.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The datazone user who created the subscription grant.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription grant.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription grant exists.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when a subscription grant was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestampf of when the subscription grant was updated.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The identifier of the target of the subscription grant.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntity", + "traits": { + "smithy.api#documentation": "The entity to which the subscription is granted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantOverallStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription grant.
", + "smithy.api#required": {} + } + }, + "assets": { + "target": "com.amazonaws.datazone#SubscribedAssets", + "traits": { + "smithy.api#documentation": "The assets included in the subscription grant.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the subscription grant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the subscription grant.
" + } + }, + "com.amazonaws.datazone#SubscriptionGrants": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscriptionGrantSummary" + } + }, + "com.amazonaws.datazone#SubscriptionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#SubscriptionRequestId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#SubscriptionRequestStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPTED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + } + } + }, + "com.amazonaws.datazone#SubscriptionRequestSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription request.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription request exists.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when a subscription request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the subscription request.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipals": { + "target": "com.amazonaws.datazone#SubscribedPrincipals", + "traits": { + "smithy.api#documentation": "The principals included in the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "The listings included in the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request reviewer.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the subscription request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the subscription request.
" + } + }, + "com.amazonaws.datazone#SubscriptionRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscriptionRequestSummary" + } + }, + "com.amazonaws.datazone#SubscriptionStatus": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.datazone#SubscriptionSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription exists.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription was updated.
", + "smithy.api#required": {} + } + }, + "subscribedPrincipal": { + "target": "com.amazonaws.datazone#SubscribedPrincipal", + "traits": { + "smithy.api#documentation": "The principal included in the subscription.
", + "smithy.api#required": {} + } + }, + "subscribedListing": { + "target": "com.amazonaws.datazone#SubscribedListing", + "traits": { + "smithy.api#documentation": "The listing included in the subscription.
", + "smithy.api#required": {} + } + }, + "subscriptionRequestId": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request for the subscription.
" + } + }, + "retainPermissions": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The retain permissions included in the subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the subscription.
" + } + }, + "com.amazonaws.datazone#SubscriptionTargetForm": { + "type": "structure", + "members": { + "formName": { + "target": "com.amazonaws.datazone#FormName", + "traits": { + "smithy.api#documentation": "The form name included in the subscription target configuration.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The content of the subscription target configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the subscription target configuration.
" + } + }, + "com.amazonaws.datazone#SubscriptionTargetForms": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscriptionTargetForm" + } + }, + "com.amazonaws.datazone#SubscriptionTargetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#SubscriptionTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#SubscriptionTargetSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription target.
", + "smithy.api#required": {} + } + }, + "authorizedPrincipals": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", + "traits": { + "smithy.api#documentation": "The authorized principals included in the subscription target.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the subscription target exists.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project specified in the subscription target.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment of the subscription target.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name of the subscription target.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the subscription target.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription target.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription target.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was updated.
" + } + }, + "manageAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The manage access role specified in the subscription target.
", + "smithy.api#required": {} + } + }, + "applicableAssetTypes": { + "target": "com.amazonaws.datazone#ApplicableAssetTypes", + "traits": { + "smithy.api#documentation": "The asset types included in the subscription target.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetConfig": { + "target": "com.amazonaws.datazone#SubscriptionTargetForms", + "traits": { + "smithy.api#documentation": "The configuration of the subscription target.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of the subscription target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the subscription target.
" + } + }, + "com.amazonaws.datazone#SubscriptionTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscriptionTargetSummary" + } + }, + "com.amazonaws.datazone#Subscriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#SubscriptionSummary" + } + }, + "com.amazonaws.datazone#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w \\.:/=+@-]+$" + } + }, + "com.amazonaws.datazone#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#TagKey" + } + }, + "com.amazonaws.datazone#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.datazone#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tags a resource in Amazon DataZone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.datazone#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to be tagged in Amazon DataZone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.datazone#Tags", + "traits": { + "smithy.api#documentation": "Specifies the tags for the TagResource action.
The isA property of the term relations.
The classifies of the term relations.
", + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the term relations.
" + } + }, + "com.amazonaws.datazone#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.datazone#Timezone": { + "type": "enum", + "members": { + "UTC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTC" + } + }, + "AFRICA_JOHANNESBURG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFRICA_JOHANNESBURG" + } + }, + "AMERICA_MONTREAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMERICA_MONTREAL" + } + }, + "AMERICA_SAO_PAULO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMERICA_SAO_PAULO" + } + }, + "ASIA_BAHRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_BAHRAIN" + } + }, + "ASIA_BANGKOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_BANGKOK" + } + }, + "ASIA_CALCUTTA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_CALCUTTA" + } + }, + "ASIA_DUBAI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_DUBAI" + } + }, + "ASIA_HONG_KONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_HONG_KONG" + } + }, + "ASIA_JAKARTA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_JAKARTA" + } + }, + "ASIA_KUALA_LUMPUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_KUALA_LUMPUR" + } + }, + "ASIA_SEOUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_SEOUL" + } + }, + "ASIA_SHANGHAI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_SHANGHAI" + } + }, + "ASIA_SINGAPORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_SINGAPORE" + } + }, + "ASIA_TAIPEI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_TAIPEI" + } + }, + "ASIA_TOKYO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASIA_TOKYO" + } + }, + "AUSTRALIA_MELBOURNE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUSTRALIA_MELBOURNE" + } + }, + "AUSTRALIA_SYDNEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUSTRALIA_SYDNEY" + } + }, + "CANADA_CENTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANADA_CENTRAL" + } + }, + "CET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CET" + } + }, + "CST6CDT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CST6CDT" + } + }, + "ETC_GMT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT" + } + }, + "ETC_GMT0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT0" + } + }, + "ETC_GMT_ADD_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_0" + } + }, + "ETC_GMT_ADD_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_1" + } + }, + "ETC_GMT_ADD_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_10" + } + }, + "ETC_GMT_ADD_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_11" + } + }, + "ETC_GMT_ADD_12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_12" + } + }, + "ETC_GMT_ADD_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_2" + } + }, + "ETC_GMT_ADD_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_3" + } + }, + "ETC_GMT_ADD_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_4" + } + }, + "ETC_GMT_ADD_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_5" + } + }, + "ETC_GMT_ADD_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_6" + } + }, + "ETC_GMT_ADD_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_7" + } + }, + "ETC_GMT_ADD_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_8" + } + }, + "ETC_GMT_ADD_9": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_ADD_9" + } + }, + "ETC_GMT_NEG_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_0" + } + }, + "ETC_GMT_NEG_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_1" + } + }, + "ETC_GMT_NEG_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_10" + } + }, + "ETC_GMT_NEG_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_11" + } + }, + "ETC_GMT_NEG_12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_12" + } + }, + "ETC_GMT_NEG_13": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_13" + } + }, + "ETC_GMT_NEG_14": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_14" + } + }, + "ETC_GMT_NEG_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_2" + } + }, + "ETC_GMT_NEG_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_3" + } + }, + "ETC_GMT_NEG_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_4" + } + }, + "ETC_GMT_NEG_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_5" + } + }, + "ETC_GMT_NEG_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_6" + } + }, + "ETC_GMT_NEG_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_7" + } + }, + "ETC_GMT_NEG_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_8" + } + }, + "ETC_GMT_NEG_9": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETC_GMT_NEG_9" + } + }, + "EUROPE_DUBLIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUROPE_DUBLIN" + } + }, + "EUROPE_LONDON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUROPE_LONDON" + } + }, + "EUROPE_PARIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUROPE_PARIS" + } + }, + "EUROPE_STOCKHOLM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUROPE_STOCKHOLM" + } + }, + "EUROPE_ZURICH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUROPE_ZURICH" + } + }, + "ISRAEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISRAEL" + } + }, + "MEXICO_GENERAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEXICO_GENERAL" + } + }, + "MST7MDT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MST7MDT" + } + }, + "PACIFIC_AUCKLAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PACIFIC_AUCKLAND" + } + }, + "US_CENTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_CENTRAL" + } + }, + "US_EASTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_EASTERN" + } + }, + "US_MOUNTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_MOUNTAIN" + } + }, + "US_PACIFIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PACIFIC" + } + } + } + }, + "com.amazonaws.datazone#Title": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#Topic": { + "type": "structure", + "members": { + "subject": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subject of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.datazone#NotificationResource", + "traits": { + "smithy.api#required": {} + } + }, + "role": { + "target": "com.amazonaws.datazone#NotificationRole", + "traits": { + "smithy.api#documentation": "The role of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The topic of the notification.
" + } + }, + "com.amazonaws.datazone#TypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[^\\.]*" + } + }, + "com.amazonaws.datazone#TypesSearchScope": { + "type": "enum", + "members": { + "ASSET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET_TYPE" + } + }, + "FORM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_TYPE" + } + } + } + }, + "com.amazonaws.datazone#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have permission to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.datazone#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.datazone#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Untags a resource in Amazon DataZone.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to be untagged in Amazon DataZone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.datazone#TagKeyList", + "traits": { + "smithy.api#documentation": "Specifies the tag keys for the UntagResource action.
Updates the specified data source in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/data-sources/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateDataSourceInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which to update a data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#Name", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateDataSource action.
The description to be updated as part of the UpdateDataSource\n action.
The enable setting to be updated as part of the UpdateDataSource\n action.
The publish on import setting to be updated as part of the UpdateDataSource\n action.
The asset forms to be updated as part of the UpdateDataSource\n action.
The schedule to be updated as part of the UpdateDataSource action.
The configuration to be updated as part of the UpdateDataSource\n action.
The recommendation to be updated as part of the UpdateDataSource\n action.
The identifier of the data source to be updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status to be updated as part of the UpdateDataSource action.
The type to be updated as part of the UpdateDataSource action.
The name to be updated as part of the UpdateDataSource action.
The description to be updated as part of the UpdateDataSource\n action.
The identifier of the Amazon DataZone domain in which a data source is to be updated.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project where data source is to be updated.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment in which a data source is to be updated.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", + "traits": { + "smithy.api#documentation": "The configuration to be updated as part of the UpdateDataSource\n action.
The recommendation to be updated as part of the UpdateDataSource\n action.
The enable setting to be updated as part of the UpdateDataSource\n action.
The publish on import setting to be updated as part of the UpdateDataSource\n action.
The asset forms to be updated as part of the UpdateDataSource\n action.
The schedule to be updated as part of the UpdateDataSource action.
The last run status of the data source.
" + } + }, + "lastRunAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was last run.
" + } + }, + "lastRunErrorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "The last run error message of the data source.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.datazone#DataSourceErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was updated.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp of when the data source was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateDomainInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateDomainOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Amazon DataZone domain.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{identifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#UpdateDomainInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services domain that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description to be updated as part of the UpdateDomain action.
The single sign-on option to be updated as part of the UpdateDomain\n action.
The domain execution role to be updated as part of the UpdateDomain\n action.
The name to be updated as part of the UpdateDomain action.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateDomainOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description to be updated as part of the UpdateDomain action.
The single sign-on option of the Amazon DataZone domain.
" + } + }, + "domainExecutionRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "The domain execution role to be updated as part of the UpdateDomain\n action.
The name to be updated as part of the UpdateDomain action.
Specifies the timestamp of when the domain was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateEnvironmentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified environment in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + } + } + }, + "com.amazonaws.datazone#UpdateEnvironmentInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which the environment is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateEnvironment action.
The description to be updated as part of the UpdateEnvironment\n action.
The glossary terms to be updated as part of the UpdateEnvironment\n action.
The project identifier of the environment.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment that is to be updated.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which the environment is to be updated.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the environment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateEnvironment action.
The description to be updated as part of the UpdateEnvironment\n action.
The profile identifier of the environment.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account in which the environment is to be\n updated.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the environment is updated.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider identifier of the environment.
", + "smithy.api#required": {} + } + }, + "provisionedResources": { + "target": "com.amazonaws.datazone#ResourceList", + "traits": { + "smithy.api#documentation": "The provisioned resources to be updated as part of the UpdateEnvironment\n action.
The status to be updated as part of the UpdateEnvironment action.
The environment actions to be updated as part of the UpdateEnvironment\n action.
The glossary terms to be updated as part of the UpdateEnvironment\n action.
The user parameters to be updated as part of the UpdateEnvironment\n action.
The last deployment of the environment.
" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties to be updated as part of the UpdateEnvironment\n action.
The deployment properties to be updated as part of the UpdateEnvironment\n action.
The blueprint identifier of the environment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironmentProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateEnvironmentProfileInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateEnvironmentProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified environment profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/environment-profiles/{identifier}" + } + } + }, + "com.amazonaws.datazone#UpdateEnvironmentProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which an environment profile is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateEnvironmentProfile\n action.
The description to be updated as part of the UpdateEnvironmentProfile\n action.
The user parameters to be updated as part of the UpdateEnvironmentProfile\n action.
The Amazon Web Services account in which a specified environment profile is to be\n udpated.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which a specified environment profile is to be\n updated.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironmentProfileOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the environment profile that is to be udpated.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which the environment profile is to be\n updated.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account in which a specified environment profile is to be\n udpated.
" + } + }, + "awsAccountRegion": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which a specified environment profile is to be\n updated.
" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the environment profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment profile was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the environment profile was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentProfileName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateEnvironmentProfile\n action.
The description to be updated as part of the UpdateEnvironmentProfile\n action.
The identifier of the blueprint of the environment profile that is to be updated.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project of the environment profile that is to be updated.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters to be updated as part of the UpdateEnvironmentProfile\n action.
Updates the business glossary in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/glossaries/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateGlossaryInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a business glossary is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateGlossary action.
The description to be updated as part of the UpdateGlossary action.
The status to be updated as part of the UpdateGlossary action.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateGlossaryOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a business glossary is to be\n updated.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary that is to be updated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateGlossary action.
The identifier of the project in which to update a business glossary.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#GlossaryDescription", + "traits": { + "smithy.api#documentation": "The description to be updated as part of the UpdateGlossary action.
The status to be updated as part of the UpdateGlossary action.
Updates a business glossary term in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/glossary-terms/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateGlossaryTermInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a business glossary term is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "glossaryIdentifier": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary in which a term is to be updated.
" + } + }, + "identifier": { + "target": "com.amazonaws.datazone#GlossaryTermId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary term that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateGlossaryTerm action.
The short description to be updated as part of the UpdateGlossaryTerm\n action.
The long description to be updated as part of the UpdateGlossaryTerm\n action.
The term relations to be updated as part of the UpdateGlossaryTerm\n action.
The status to be updated as part of the UpdateGlossaryTerm action.
The identifier of the business glossary term that is to be updated.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a business glossary term is to be\n updated.
", + "smithy.api#required": {} + } + }, + "glossaryId": { + "target": "com.amazonaws.datazone#GlossaryId", + "traits": { + "smithy.api#documentation": "The identifier of the business glossary in which a term is to be updated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#GlossaryTermName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateGlossaryTerm action.
The status to be updated as part of the UpdateGlossaryTerm action.
The short description to be updated as part of the UpdateGlossaryTerm\n action.
The long description to be updated as part of the UpdateGlossaryTerm\n action.
The term relations to be updated as part of the UpdateGlossaryTerm\n action.
Updates the specified group profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/group-profiles/{groupIdentifier}" + }, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#UpdateGroupProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a group profile is updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the group profile that is updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#GroupProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the group profile that is updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateGroupProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a group profile is updated.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#GroupProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the group profile that is updated.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#GroupProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the group profile that is updated.
" + } + }, + "groupName": { + "target": "com.amazonaws.datazone#GroupProfileName", + "traits": { + "smithy.api#documentation": "The name of the group profile that is updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateProjectInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified project in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/projects/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateProjectInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a project is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateProject action.
The description to be updated as part of the UpdateProject action.
The glossary terms to be updated as part of the UpdateProject\n action.
The identifier of the Amazon DataZone domain in which a project is updated.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project that is to be updated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that is to be updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the project that is to be updated.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the project.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the project was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms of the project that are to be updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateSubscriptionGrantStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateSubscriptionGrantStatusInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateSubscriptionGrantStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the status of the specified subscription grant status in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/subscription-grants/{identifier}/status/{assetIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateSubscriptionGrantStatusInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription grant status is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionGrantId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription grant the status of which is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "The identifier of the asset the subscription grant status of which is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionGrantStatus", + "traits": { + "smithy.api#documentation": "The status to be updated as part of the UpdateSubscriptionGrantStatus\n action.
Specifies the error message that is returned if the operation cannot be successfully\n completed.
" + } + }, + "targetName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The target name to be updated as part of the UpdateSubscriptionGrantStatus\n action.
The identifier of the subscription grant.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone domain user who created the subscription grant status.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription grant status.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription grant status is to be\n updated.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant status was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription grant status is to be updated.
", + "smithy.api#required": {} + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription target whose subscription grant status is to be\n updated.
", + "smithy.api#required": {} + } + }, + "grantedEntity": { + "target": "com.amazonaws.datazone#GrantedEntity", + "traits": { + "smithy.api#documentation": "The granted entity to be updated as part of the\n UpdateSubscriptionGrantStatus action.
The status to be updated as part of the UpdateSubscriptionGrantStatus\n action.
The identifier of the subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdateSubscriptionRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateSubscriptionRequestInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateSubscriptionRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a specified subscription request in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateSubscriptionRequestInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription request is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionRequestId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the UpdateSubscriptionRequest action.
The identifier of the subscription request that is to be updated.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who created the subscription request.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription request.
" + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription request is to be\n updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the subscription request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription request was updated.
", + "smithy.api#required": {} + } + }, + "requestReason": { + "target": "com.amazonaws.datazone#RequestReason", + "traits": { + "smithy.api#documentation": "The reason for the UpdateSubscriptionRequest action.
The subscribed principals of the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "subscribedListings": { + "target": "com.amazonaws.datazone#SubscribedListings", + "traits": { + "smithy.api#documentation": "The subscribed listings of the subscription request.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone user who reviews the subscription request.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the UpdateSubscriptionRequest action.
Updates the specified subscription target in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateSubscriptionTargetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a subscription target is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment in which a subscription target is to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "Identifier of the subscription target that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateSubscriptionTarget\n action.
The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action.
The applicable asset types to be updated as part of the\n UpdateSubscriptionTarget action.
The configuration to be updated as part of the UpdateSubscriptionTarget\n action.
The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.
The provider to be updated as part of the UpdateSubscriptionTarget\n action.
Identifier of the subscription target that is to be updated.
", + "smithy.api#required": {} + } + }, + "authorizedPrincipals": { + "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", + "traits": { + "smithy.api#documentation": "The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action.
The identifier of the Amazon DataZone domain in which a subscription target is to be\n updated.
", + "smithy.api#required": {} + } + }, + "projectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project in which a subscription target is to be updated.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The identifier of the environment in which a subscription target is to be\n updated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#SubscriptionTargetName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateSubscriptionTarget\n action.
The type to be updated as part of the UpdateSubscriptionTarget\n action.
The Amazon DataZone user who created the subscription target.
", + "smithy.api#required": {} + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The Amazon DataZone user who updated the subscription target.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when a subscription target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp of when the subscription target was updated.
" + } + }, + "manageAccessRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.
The applicable asset types to be updated as part of the\n UpdateSubscriptionTarget action.
The configuration to be updated as part of the UpdateSubscriptionTarget\n action.
The provider to be updated as part of the UpdateSubscriptionTarget\n action.
Updates the specified user profile in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/user-profiles/{userIdentifier}" + }, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#UpdateUserProfileInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a user profile is updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the user whose user profile is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile that are to be updated.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the user profile that are to be updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateUserProfileOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a user profile is updated.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#UserProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the user profile.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the user profile.
" + } + }, + "details": { + "target": "com.amazonaws.datazone#UserProfileDetails" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#UpdatedAt": { + "type": "timestamp" + }, + "com.amazonaws.datazone#UpdatedBy": { + "type": "string" + }, + "com.amazonaws.datazone#UserAssignment": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.datazone#UserDesignation": { + "type": "enum", + "members": { + "PROJECT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_OWNER" + } + }, + "PROJECT_CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + } + } + } + }, + "com.amazonaws.datazone#UserDetails": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The user details of a project member.
" + } + }, + "com.amazonaws.datazone#UserIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)" + } + }, + "com.amazonaws.datazone#UserProfileDetails": { + "type": "union", + "members": { + "iam": { + "target": "com.amazonaws.datazone#IamUserProfileDetails", + "traits": { + "smithy.api#documentation": "The IAM details included in the user profile details.
" + } + }, + "sso": { + "target": "com.amazonaws.datazone#SsoUserProfileDetails", + "traits": { + "smithy.api#documentation": "The single sign-on details included in the user profile details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the user profile in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#UserProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.datazone#UserProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#UserProfileStatus": { + "type": "enum", + "members": { + "ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGNED" + } + }, + "NOT_ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ASSIGNED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + }, + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + } + } + }, + "com.amazonaws.datazone#UserProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#UserProfileSummary" + } + }, + "com.amazonaws.datazone#UserProfileSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain of the user profile.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#UserProfileId", + "traits": { + "smithy.api#documentation": "The ID of the user profile.
" + } + }, + "type": { + "target": "com.amazonaws.datazone#UserProfileType", + "traits": { + "smithy.api#documentation": "The type of the user profile.
" + } + }, + "status": { + "target": "com.amazonaws.datazone#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the user profile.
" + } + }, + "details": { + "target": "com.amazonaws.datazone#UserProfileDetails", + "traits": { + "smithy.api#documentation": "The details of the user profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the user profile.
" + } + }, + "com.amazonaws.datazone#UserProfileType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "SSO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO" + } + } + } + }, + "com.amazonaws.datazone#UserSearchText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#UserSearchType": { + "type": "enum", + "members": { + "SSO_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO_USER" + } + }, + "DATAZONE_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATAZONE_USER" + } + }, + "DATAZONE_SSO_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATAZONE_SSO_USER" + } + }, + "DATAZONE_IAM_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATAZONE_IAM_USER" + } + } + } + }, + "com.amazonaws.datazone#UserType": { + "type": "enum", + "members": { + "IAM_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_USER" + } + }, + "IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE" + } + }, + "SSO_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO_USER" + } + } + } + }, + "com.amazonaws.datazone#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.datazone#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the Amazon Web Services service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index 8d9b31253f2..12c476f0452 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -1575,7 +1575,7 @@ "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
\nUse DescribeAvailabilityZones to view the network border groups.
\nYou cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
\nUse DescribeAvailabilityZones to view the network border groups.
" } }, "CustomerOwnedIpv4Pool": { @@ -6502,7 +6502,7 @@ "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.
\nBy default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.
\nBy default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
\nWhen you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n
\nThe ID of the export task. This is the ID returned by CreateInstanceExportTask.
The ID of the export task. This is the ID returned by the\n CreateInstanceExportTask and ExportImage operations.
The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tagging your resources.
\nIf the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.
The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tag your resources.
\nIf the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.
Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon VPC User Guide.
", + "smithy.api#documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon VPC User Guide.
\nWhen you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n
\nDeletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
", + "smithy.api#documentation": "Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.
", "smithy.api#examples": [ { "title": "To delete a VPC", @@ -31821,7 +31821,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.
\n client-token - The idempotency token you provided when you\n launched the instance.
\n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).
\n dns-name - The public DNS name of the instance.
\n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.
\n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.
\n iam-instance-profile.name - The instance profile associated with\n the instance. Specified as an name.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n ipv6-address - The IPv6 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n license-pool -
\n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).
\n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)
\n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)
\n metadata-options.state - The state of the metadata option changes\n (pending | applied).
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.
\n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.
\n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay\n | marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - 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.\n 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.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).
\n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).
\n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.
\n client-token - The idempotency token you provided when you\n launched the instance.
\n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).
\n dns-name - The public DNS name of the instance.
\n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.
\n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.
\n iam-instance-profile.name - The instance profile associated with\n the instance. Specified as an name.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n ipv6-address - The IPv6 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).
\n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)
\n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)
\n metadata-options.state - The state of the metadata option changes\n (pending | applied).
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.association.allocation-id - The allocation ID.
\n network-interface.addresses.association.association-id - The association ID.
\n network-interface.addresses.association.carrier-ip - The carrier IP address.
\n network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.addresses.association.public-dns-name - The public DNS name.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.private-dns-name - The private DNS name.
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.association.carrier-ip - The customer-owned IP address.
\n network-interface.association.customer-owned-ip - The customer-owned IP address.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.public-dns-name - The public DNS name.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.network-card-index - The index of the network card.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.deny-all-igw-traffic - A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
\n network-interface.ipv6-address - The IPv6 address associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this\n is the primary IPv6 address.
\n network-interface.ipv6-native - A Boolean that indicates whether this is\n an IPv6 only network interface.
\n network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.outpost-arn - The ARN of the Outpost.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.private-ip-address - The private IPv4 address.
\n network-interface.public-dns-name - The public DNS name.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.tag-key - The key of a tag assigned to the network interface.
\n network-interface.tag-value - The value of a tag assigned to the network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.
\n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.
\n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay\n | marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - 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.\n 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.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).
\n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).
\n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
Describes one or more of your network interfaces.
", + "smithy.api#documentation": "Describes one or more of your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.
One or more filters.
\n\n addresses.private-ip-address - The private IPv4 addresses\n associated with the network interface.
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n the network interface was associated with the Elastic IP address\n (IPv4).
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n association.association-id - The association ID returned when the\n network interface was associated with an IPv4 address.
\n association.allocation-id - The allocation ID returned when you\n allocated the Elastic IP address (IPv4) for your network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n group-name - The name of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | efa | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | \n\t\t interface | iot_rules_managed | lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | quicksight | \n\t\t transit_gateway | trunk | vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service \n\t\t (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-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.
\n vpc-id - The ID of the VPC for the network interface.
One or more filters.
\n\n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.
\n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | \n\t\t ec2_instance_connect_endpoint | efa | efs | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | \n\t\t global_accelerator_managed | \n\t\t interface | iot_rules_managed | \n\t\t lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | \n\t\t quicksight | \n\t\t transit_gateway | trunk | \n\t\t vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service \n\t\t (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-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.
\n vpc-id - The ID of the VPC for the network interface.
Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.
Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.
Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.
Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.
The boot mode of the virtual machine.
" + "smithy.api#documentation": "The boot mode of the virtual machine.
\nThe uefi-preferred boot mode isn't supported for importing images. For more\n information, see Boot modes in\n the VM Import/Export User Guide.
The type of resource to tag.
\nThe Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n
To tag a resource after it has been created, see CreateTags.
" + "smithy.api#documentation": "The type of resource to tag.
\nValid Values lists all resource types for Amazon EC2 that can be tagged. When\n you create a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request.\n If the instance does include the resource type that you specify, the instance \n launch fails. For example, not all instance types include an Elastic GPU.
To tag a resource after it has been created, see CreateTags.
" } }, "Tags": { @@ -80109,7 +80109,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "MaxTotalPrice", - "smithy.api#documentation": "The maximum amount per hour for On-Demand Instances that you're willing to pay.
", + "smithy.api#documentation": "The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The maxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
" + "smithy.api#documentation": "The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.
\nIf 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 \n receive an InvalidParameterCombination error.
The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.
\nIf you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
The elastic inference accelerator for the instance.
", + "smithy.api#documentation": "An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.
\nYou cannot specify accelerators from different generations in the same request.
\nStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.
\nThe elastic inference accelerator for the instance.
", + "smithy.api#documentation": "An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.
\nYou cannot specify accelerators from different generations in the same request.
\nStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.
\nThe maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.
If your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The onDemandMaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for onDemandMaxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,\n Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.\n When the maximum amount you're willing to pay is reached, the fleet stops launching\n instances even if it hasn’t met the target capacity.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your budget.\n If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will\n launch instances until it reaches the maximum amount you're willing to pay. When the\n maximum amount you're willing to pay is reached, the fleet stops launching instances even\n if it hasn’t met the target capacity.
If your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The spotMaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for spotMaxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.
The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tag your resources.
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The maxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nThe maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems\n with a data repository association created with\n .
\n\n AutoImportPolicy\n
\n ExportPath\n
\n ImportedChunkSize\n
\n ImportPath\n
The Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems\n with a data repository association created with\n .
\n\n AutoImportPolicy\n
\n ExportPath\n
\n ImportedFileChunkSize\n
\n ImportPath\n
After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to \n initiate the process of Amazon FSx attempting to reconnect to the file system.
" + } + }, + "com.amazonaws.fsx#StartMisconfiguredStateRecoveryRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fsx#StartMisconfiguredStateRecoveryResponse": { + "type": "structure", + "members": { + "FileSystem": { + "target": "com.amazonaws.fsx#FileSystem" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.fsx#StartTime": { "type": "timestamp" }, diff --git a/codegen/sdk-codegen/aws-models/location.2020-11-19.json b/codegen/sdk-codegen/aws-models/location.2020-11-19.json index 3a53e67e88d..911158f4ad8 100644 --- a/codegen/sdk-codegen/aws-models/location.2020-11-19.json +++ b/codegen/sdk-codegen/aws-models/location.2020-11-19.json @@ -2160,6 +2160,12 @@ "traits": { "smithy.api#documentation": "Whether to enable position UPDATE events from this tracker to be sent to \n EventBridge.
You do not need enable this feature to get ENTER and \n EXIT events for geofences with this tracker. Those events are\n always sent to EventBridge.
Enables GeospatialQueries for a tracker that uses a Amazon Web Services\n KMS customer managed key.
This parameter is only used if you are using a KMS customer managed key.
\nIf you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. \n This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.
\nYou can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to \n true when creating or updating a Tracker.
The timestamp for when the geofence collection was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n
The number of geofences in the geofence collection.
", + "smithy.api#range": { + "min": 0 + } + } } } }, @@ -3251,6 +3266,12 @@ "traits": { "smithy.api#documentation": "Whether UPDATE events from this tracker in EventBridge are\n enabled. If set to true these events will be sent to EventBridge.
Enables GeospatialQueries for a tracker that uses a Amazon Web Services\n KMS customer managed key.
This parameter is only used if you are using a KMS customer managed key.
\nIf you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. \n This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.
\nYou can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to \n true when creating or updating a Tracker.
A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.
Valid fonts stacks for Esri styles:
\nVectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n
VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n
VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n
VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n
VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n
Valid font stacks for HERE Technologies styles:
\nVectorHereContrast – Fira \n GO Regular | Fira GO Bold\n
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n
Valid font stacks for GrabMaps styles:
\nVectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n
Valid font stacks for Open Data styles:
\nVectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n
The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.
A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.
Valid font stacks for Esri styles:
\nVectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n
VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n
VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n
VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n
VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n
Valid font stacks for HERE Technologies styles:
\nVectorHereContrast – Fira \n GO Regular | Fira GO Bold\n
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n
Valid font stacks for GrabMaps styles:
\nVectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n
Valid font stacks for Open Data styles:
\nVectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n
The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.
The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null\n
The geomerty used to filter device positions.
" + } } } }, @@ -4616,7 +4643,7 @@ "Entries": { "target": "com.amazonaws.location#ListDevicePositionsResponseEntryList", "traits": { - "smithy.api#documentation": "Contains details about each device's last known position. These details includes the device ID,\n the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.
", + "smithy.api#documentation": "Contains details about each device's last known position.
", "smithy.api#required": {} } }, @@ -8103,6 +8130,20 @@ "aws.iam#disableConditionKeyInference": {} } }, + "com.amazonaws.location#TrackingFilterGeometry": { + "type": "structure", + "members": { + "Polygon": { + "target": "com.amazonaws.location#LinearRings", + "traits": { + "smithy.api#documentation": "The set of arrays which define the polygon. A polygon can have between 4 and 1000 vertices.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The geomerty used to filter device positions.
" + } + }, "com.amazonaws.location#TravelMode": { "type": "string", "traits": { @@ -8832,6 +8873,12 @@ "traits": { "smithy.api#documentation": "Whether to enable position UPDATE events from this tracker to be sent to \n EventBridge.
You do not need enable this feature to get ENTER and \n EXIT events for geofences with this tracker. Those events are\n always sent to EventBridge.
Enables GeospatialQueries for a tracker that uses a Amazon Web Services\n KMS customer managed key.
This parameter is only used if you are using a KMS customer managed key.
" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json b/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json index ca72e87c52c..dc1a455da8a 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json +++ b/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json @@ -834,7 +834,7 @@ "ChangeType": { "target": "com.amazonaws.marketplacecatalog#ChangeType", "traits": { - "smithy.api#documentation": "Change types are single string values that describe your intention for the change.\n Each change type is unique for each EntityType provided in the change's\n scope. For more information on change types available for single-AMI products, see\n Working with single-AMI products. Also, for more information on change\n types available for container-based products, see Working with container products.
Change types are single string values that describe your intention for the change.\n Each change type is unique for each EntityType provided in the change's\n scope. For more information on change types available for single-AMI products, see\n Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.
This object contains details specific to the change type of the requested\n change. For more\n information on change types available for single-AMI products, see Working with single-AMI products. Also, for more information on change\n types available for container-based products, see Working with container products.
", - "smithy.api#required": {} + "smithy.api#documentation": "This object contains details specific to the change type of the requested change. For\n more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.
" + } + }, + "DetailsDocument": { + "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", + "traits": { + "smithy.api#documentation": "Alternative field that accepts a JSON value instead of a string for\n ChangeType details. You can use either Details or\n DetailsDocument, but not both.
This object contains details specific to the change type of the requested\n change.
" } }, + "DetailsDocument": { + "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", + "traits": { + "smithy.api#documentation": "The JSON value of the details specific to the change type of the requested change.
" + } + }, "ErrorDetailList": { "target": "com.amazonaws.marketplacecatalog#ErrorDetailList", "traits": { @@ -1086,7 +1097,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a resource-based policy on an Entity that is identified by its resource\n ARN.
", + "smithy.api#documentation": "Deletes a resource-based policy on an entity that is identified by its resource\n ARN.
", "smithy.api#http": { "method": "DELETE", "uri": "/DeleteResourcePolicy", @@ -1100,7 +1111,7 @@ "ResourceArn": { "target": "com.amazonaws.marketplacecatalog#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Entity resource that is associated with the\n resource policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity resource that is associated with the\n resource policy.
", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } @@ -1330,6 +1341,12 @@ "traits": { "smithy.api#documentation": "This stringified JSON object includes the details of the entity.
" } + }, + "DetailsDocument": { + "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", + "traits": { + "smithy.api#documentation": "The JSON value of the details specific to the entity.
" + } } }, "traits": { @@ -1568,7 +1585,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a resource-based policy of an Entity that is identified by its resource\n ARN.
", + "smithy.api#documentation": "Gets a resource-based policy of an entity that is identified by its resource\n ARN.
", "smithy.api#http": { "method": "GET", "uri": "/GetResourcePolicy", @@ -1582,7 +1599,7 @@ "ResourceArn": { "target": "com.amazonaws.marketplacecatalog#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Entity resource that is associated with the\n resource policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity resource that is associated with the\n resource policy.
", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } @@ -1639,6 +1656,9 @@ "smithy.api#pattern": "^[\\s]*\\{[\\s\\S]*\\}[\\s]*$" } }, + "com.amazonaws.marketplacecatalog#JsonDocumentType": { + "type": "document" + }, "com.amazonaws.marketplacecatalog#ListChangeSets": { "type": "operation", "input": { @@ -1835,7 +1855,10 @@ } }, "OwnershipType": { - "target": "com.amazonaws.marketplacecatalog#OwnershipType" + "target": "com.amazonaws.marketplacecatalog#OwnershipType", + "traits": { + "smithy.api#documentation": "Filters the returned set of entities based on their owner. The default is\n SELF. To list entities shared with you\n through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace\n Catalog API PutResourcePolicy operation can't be discovered through the\n SHARED parameter.
Attaches a resource-based policy to an Entity. Examples of an entity include:\n AmiProduct and ContainerProduct.
Attaches a resource-based policy to an entity. Examples of an entity include:\n AmiProduct and ContainerProduct.
The Amazon Resource Name (ARN) of the Entity resource you want to associate with a\n resource policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity resource you want to associate with a\n resource policy.
", "smithy.api#required": {} } }, @@ -2127,7 +2150,7 @@ "SortBy": { "target": "com.amazonaws.marketplacecatalog#SortBy", "traits": { - "smithy.api#documentation": "For ListEntities, supported attributes include\n LastModifiedDate (default), Visibility,\n EntityId, and Name.
For ListChangeSets, supported attributes include StartTime\n and EndTime.
For ListEntities, supported attributes include\n LastModifiedDate (default) and EntityId. In addition to\n LastModifiedDate and EntityId, each\n EntityType might support additional fields.
For ListChangeSets, supported attributes include StartTime\n and EndTime.
Allows you to request changes for your entities. Within a single\n ChangeSet, you can't start the same change type against the same entity\n multiple times. Additionally, when a ChangeSet is running, all the entities\n targeted by the different changes are locked until the change set has completed (either\n succeeded, cancelled, or failed). If you try to start a change set containing a change\n against an entity that is already locked, you will receive a\n ResourceInUseException error.
For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same\n change type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see Working with change sets. For information on change types for single-AMI\n products, see Working with single-AMI products. Als, for more information on change types\n available for container-based products, see Working with container products.
", + "smithy.api#documentation": "Allows you to request changes for your entities. Within a single\n ChangeSet, you can't start the same change type against the same entity\n multiple times. Additionally, when a ChangeSet is running, all the entities\n targeted by the different changes are locked until the change set has completed (either\n succeeded, cancelled, or failed). If you try to start a change set containing a change\n against an entity that is already locked, you will receive a\n ResourceInUseException error.
For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same\n change type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see Working with change sets. For information about change types for\n single-AMI products, see Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.
", "smithy.api#http": { "method": "POST", "uri": "/StartChangeSet", diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json index 8fb818f3433..77d1419ea86 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json @@ -9515,6 +9515,26 @@ "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames." } }, + "com.amazonaws.mediaconvert#H264EndOfStreamMarkers": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "SUPPRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESS" + } + } + }, + "traits": { + "smithy.api#documentation": "Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream." + } + }, "com.amazonaws.mediaconvert#H264EntropyEncoding": { "type": "enum", "members": { @@ -9923,6 +9943,13 @@ "smithy.api#jsonName": "dynamicSubGop" } }, + "EndOfStreamMarkers": { + "target": "com.amazonaws.mediaconvert#H264EndOfStreamMarkers", + "traits": { + "smithy.api#documentation": "Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream.", + "smithy.api#jsonName": "endOfStreamMarkers" + } + }, "EntropyEncoding": { "target": "com.amazonaws.mediaconvert#H264EntropyEncoding", "traits": { @@ -10544,6 +10571,26 @@ "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames." } }, + "com.amazonaws.mediaconvert#H265EndOfStreamMarkers": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "SUPPRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESS" + } + } + }, + "traits": { + "smithy.api#documentation": "Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream." + } + }, "com.amazonaws.mediaconvert#H265FlickerAdaptiveQuantization": { "type": "enum", "members": { @@ -10919,6 +10966,13 @@ "smithy.api#jsonName": "dynamicSubGop" } }, + "EndOfStreamMarkers": { + "target": "com.amazonaws.mediaconvert#H265EndOfStreamMarkers", + "traits": { + "smithy.api#documentation": "Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream.", + "smithy.api#jsonName": "endOfStreamMarkers" + } + }, "FlickerAdaptiveQuantization": { "target": "com.amazonaws.mediaconvert#H265FlickerAdaptiveQuantization", "traits": { @@ -12827,6 +12881,13 @@ "smithy.api#jsonName": "videoGenerator" } }, + "VideoOverlays": { + "target": "com.amazonaws.mediaconvert#__listOfVideoOverlay", + "traits": { + "smithy.api#documentation": "Contains an array of video overlays.", + "smithy.api#jsonName": "videoOverlays" + } + }, "VideoSelector": { "target": "com.amazonaws.mediaconvert#VideoSelector", "traits": { @@ -13223,6 +13284,13 @@ "smithy.api#jsonName": "timecodeStart" } }, + "VideoOverlays": { + "target": "com.amazonaws.mediaconvert#__listOfVideoOverlay", + "traits": { + "smithy.api#documentation": "Contains an array of video overlays.", + "smithy.api#jsonName": "videoOverlays" + } + }, "VideoSelector": { "target": "com.amazonaws.mediaconvert#VideoSelector", "traits": { @@ -13655,13 +13723,6 @@ "smithy.api#jsonName": "extendedDataServices" } }, - "FollowInputIndex": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max149", - "traits": { - "smithy.api#documentation": "Specifies which input metadata to use for the default \"Follow input\" option for the following settings: resolution, frame rate, and pixel aspect ratio. In the simplest case, specify which input is used based on its index in the job. For example if you specify 3, then the fourth input will be used from each input. If the job does not have a fourth input, then the first input will be used. If no followInputIndex is specified, then 0 will be chosen automatically.", - "smithy.api#jsonName": "followInputIndex" - } - }, "Inputs": { "target": "com.amazonaws.mediaconvert#__listOfInput", "traits": { @@ -13919,13 +13980,6 @@ "smithy.api#jsonName": "extendedDataServices" } }, - "FollowInputIndex": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max149", - "traits": { - "smithy.api#documentation": "Specifies which input metadata to use for the default \"Follow input\" option for the following settings: resolution, frame rate, and pixel aspect ratio. In the simplest case, specify which input is used based on its index in the job. For example if you specify 3, then the fourth input will be used from each input. If the job does not have a fourth input, then the first input will be used. If no followInputIndex is specified, then 0 will be chosen automatically.", - "smithy.api#jsonName": "followInputIndex" - } - }, "Inputs": { "target": "com.amazonaws.mediaconvert#__listOfInputTemplate", "traits": { @@ -23245,6 +23299,93 @@ "smithy.api#documentation": "Contains details about the output's video stream" } }, + "com.amazonaws.mediaconvert#VideoOverlay": { + "type": "structure", + "members": { + "EndTimecode": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Enter the end timecode in the underlying input video for this overlay. Your overlay will be active through this frame. To display your video overlay for the duration of the underlying video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for the underlying Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to end ten minutes into the video, enter 01:10:00:00.", + "smithy.api#jsonName": "endTimecode" + } + }, + "Input": { + "target": "com.amazonaws.mediaconvert#VideoOverlayInput", + "traits": { + "smithy.api#documentation": "Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify.", + "smithy.api#jsonName": "input" + } + }, + "StartTimecode": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Enter the start timecode in the underlying input video for this overlay. Your overlay will be active starting with this frame. To display your video overlay starting at the beginning of the underlying video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for the underlying Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to begin five minutes into the video, enter 01:05:00:00.", + "smithy.api#jsonName": "startTimecode" + } + } + }, + "traits": { + "smithy.api#documentation": "Overlay one or more videos on top of your input video." + } + }, + "com.amazonaws.mediaconvert#VideoOverlayInput": { + "type": "structure", + "members": { + "FileInput": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3Https", + "traits": { + "smithy.api#documentation": "Specify the input file S3, HTTP, or HTTPS URI for your video overlay. For consistency in color and formatting in your output video image, we recommend that you specify a video with similar characteristics as the underlying input video.", + "smithy.api#jsonName": "fileInput" + } + }, + "InputClippings": { + "target": "com.amazonaws.mediaconvert#__listOfVideoOverlayInputClipping", + "traits": { + "smithy.api#documentation": "Specify one or more clips to use from your video overlay. When you include an input clip, you must also specify its start timecode, end timecode, or both start and end timecode.", + "smithy.api#jsonName": "inputClippings" + } + }, + "TimecodeSource": { + "target": "com.amazonaws.mediaconvert#InputTimecodeSource", + "traits": { + "smithy.api#documentation": "Specify the starting timecode for your video overlay. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.", + "smithy.api#jsonName": "timecodeSource" + } + }, + "TimecodeStart": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "traits": { + "smithy.api#documentation": "Specify the starting timecode for this video overlay. To use this setting, you must set Timecode source to Specified start.", + "smithy.api#jsonName": "timecodeStart" + } + } + }, + "traits": { + "smithy.api#documentation": "Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify." + } + }, + "com.amazonaws.mediaconvert#VideoOverlayInputClipping": { + "type": "structure", + "members": { + "EndTimecode": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Specify the timecode of the last frame to include in your video overlay's clip. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for Timecode source.", + "smithy.api#jsonName": "endTimecode" + } + }, + "StartTimecode": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Specify the timecode of the first frame to include in your video overlay's clip. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for Timecode source.", + "smithy.api#jsonName": "startTimecode" + } + } + }, + "traits": { + "smithy.api#documentation": "To transcode only portions of your video overlay, include one input clip for each part of your video overlay that you want in your output." + } + }, "com.amazonaws.mediaconvert#VideoPreprocessor": { "type": "structure", "members": { @@ -24980,15 +25121,6 @@ } } }, - "com.amazonaws.mediaconvert#__integerMin0Max149": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 149 - } - } - }, "com.amazonaws.mediaconvert#__integerMin0Max15": { "type": "integer", "traits": { @@ -25979,6 +26111,18 @@ "target": "com.amazonaws.mediaconvert#TeletextPageType" } }, + "com.amazonaws.mediaconvert#__listOfVideoOverlay": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#VideoOverlay" + } + }, + "com.amazonaws.mediaconvert#__listOfVideoOverlayInputClipping": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#VideoOverlayInputClipping" + } + }, "com.amazonaws.mediaconvert#__listOfWarningGroup": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json index ff181eaf8b5..b916048d1fe 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json @@ -95,6 +95,31 @@ "target": "com.amazonaws.mediatailor#KeyValuePair" } }, + "com.amazonaws.mediatailor#AdBreakOpportunities": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AdBreakOpportunity" + }, + "traits": { + "smithy.api#documentation": "The list of ad break opportunities detected within the VOD source.
" + } + }, + "com.amazonaws.mediatailor#AdBreakOpportunity": { + "type": "structure", + "members": { + "OffsetMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The offset in milliseconds from the start of the VOD source at which an ad marker was detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location at which a zero-duration ad marker was detected in a VOD source manifest.
" + } + }, "com.amazonaws.mediatailor#AdMarkerPassthrough": { "type": "structure", "members": { @@ -2205,6 +2230,12 @@ "com.amazonaws.mediatailor#DescribeVodSourceResponse": { "type": "structure", "members": { + "AdBreakOpportunities": { + "target": "com.amazonaws.mediatailor#AdBreakOpportunities", + "traits": { + "smithy.api#documentation": "The ad break opportunities within the VOD source.
" + } + }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json b/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json index 80c6e633ae0..2c694fdfdac 100644 --- a/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json +++ b/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json @@ -355,6 +355,9 @@ { "target": "com.amazonaws.mgn#ApplicationResource" }, + { + "target": "com.amazonaws.mgn#ConnectorResource" + }, { "target": "com.amazonaws.mgn#ExportResource" }, @@ -1807,6 +1810,161 @@ "target": "com.amazonaws.mgn#ErrorDetails" } }, + "com.amazonaws.mgn#Connector": { + "type": "structure", + "members": { + "connectorID": { + "target": "com.amazonaws.mgn#ConnectorID", + "traits": { + "smithy.api#documentation": "Connector ID.
" + } + }, + "name": { + "target": "com.amazonaws.mgn#ConnectorName", + "traits": { + "smithy.api#documentation": "Connector name.
" + } + }, + "ssmInstanceID": { + "target": "com.amazonaws.mgn#SsmInstanceID", + "traits": { + "smithy.api#documentation": "Connector SSM instance ID.
" + } + }, + "arn": { + "target": "com.amazonaws.mgn#ARN", + "traits": { + "smithy.api#documentation": "Connector arn.
" + } + }, + "tags": { + "target": "com.amazonaws.mgn#TagsMap", + "traits": { + "smithy.api#documentation": "Connector tags.
" + } + }, + "ssmCommandConfig": { + "target": "com.amazonaws.mgn#ConnectorSsmCommandConfig", + "traits": { + "smithy.api#documentation": "Connector SSM command config.
" + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.mgn#ConnectorResource" + } + ] + } + }, + "com.amazonaws.mgn#ConnectorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 27, + "max": 100 + }, + "smithy.api#pattern": "^arn:[\\w-]+:mgn:([a-z]{2}-(gov-)?[a-z]+-\\d{1})?:(\\d{12})?:connector\\/(connector-[0-9a-zA-Z]{17})$" + } + }, + "com.amazonaws.mgn#ConnectorID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 27, + "max": 27 + }, + "smithy.api#pattern": "^connector-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.mgn#ConnectorIDsFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.mgn#ConnectorID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.mgn#ConnectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.mgn#ConnectorResource": { + "type": "resource", + "identifiers": { + "connectorID": { + "target": "com.amazonaws.mgn#ConnectorID" + } + }, + "create": { + "target": "com.amazonaws.mgn#CreateConnector" + }, + "update": { + "target": "com.amazonaws.mgn#UpdateConnector" + }, + "delete": { + "target": "com.amazonaws.mgn#DeleteConnector" + }, + "list": { + "target": "com.amazonaws.mgn#ListConnectors" + }, + "traits": { + "aws.api#arn": { + "template": "connector/{connectorID}" + } + } + }, + "com.amazonaws.mgn#ConnectorSsmCommandConfig": { + "type": "structure", + "members": { + "s3OutputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Connector SSM command config S3 output enabled.
", + "smithy.api#required": {} + } + }, + "outputS3BucketName": { + "target": "com.amazonaws.mgn#S3BucketName", + "traits": { + "smithy.api#documentation": "Connector SSM command config output S3 bucket name.
" + } + }, + "cloudWatchOutputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Connector SSM command config CloudWatch output enabled.
", + "smithy.api#required": {} + } + }, + "cloudWatchLogGroupName": { + "target": "com.amazonaws.mgn#CloudWatchLogGroupName", + "traits": { + "smithy.api#documentation": "Connector SSM command config CloudWatch log group name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Connector SSM command config.
" + } + }, + "com.amazonaws.mgn#ConnectorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.mgn#Connector" + } + }, "com.amazonaws.mgn#Cpus": { "type": "list", "member": { @@ -1878,6 +2036,66 @@ } } }, + "com.amazonaws.mgn#CreateConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#CreateConnectorRequest" + }, + "output": { + "target": "com.amazonaws.mgn#Connector" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create Connector.
", + "smithy.api#http": { + "uri": "/CreateConnector", + "method": "POST", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mgn#CreateConnectorRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.mgn#ConnectorName", + "traits": { + "smithy.api#documentation": "Create Connector request name.
", + "smithy.api#required": {} + } + }, + "ssmInstanceID": { + "target": "com.amazonaws.mgn#SsmInstanceID", + "traits": { + "smithy.api#documentation": "Create Connector request SSM instance ID.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.mgn#TagsMap", + "traits": { + "smithy.api#documentation": "Create Connector request tags.
" + } + }, + "ssmCommandConfig": { + "target": "com.amazonaws.mgn#ConnectorSsmCommandConfig", + "traits": { + "smithy.api#documentation": "Create Connector request SSM command config.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.mgn#CreateLaunchConfigurationTemplate": { "type": "operation", "input": { @@ -2612,6 +2830,50 @@ "type": "structure", "members": {} }, + "com.amazonaws.mgn#DeleteConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#DeleteConnectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete Connector.
", + "smithy.api#http": { + "uri": "/DeleteConnector", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mgn#DeleteConnectorRequest": { + "type": "structure", + "members": { + "connectorID": { + "target": "com.amazonaws.mgn#ConnectorID", + "traits": { + "smithy.api#documentation": "Delete Connector request connector ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.mgn#DeleteJob": { "type": "operation", "input": { @@ -5602,6 +5864,99 @@ } } }, + "com.amazonaws.mgn#ListConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#ListConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.mgn#ListConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List Connectors.
", + "smithy.api#http": { + "uri": "/ListConnectors", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mgn#ListConnectorsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.mgn#ListConnectorsRequestFilters", + "traits": { + "smithy.api#documentation": "List Connectors Request filters.
" + } + }, + "maxResults": { + "target": "com.amazonaws.mgn#MaxResultsType", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "List Connectors Request max results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.mgn#PaginationToken", + "traits": { + "smithy.api#documentation": "List Connectors Request next token.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mgn#ListConnectorsRequestFilters": { + "type": "structure", + "members": { + "connectorIDs": { + "target": "com.amazonaws.mgn#ConnectorIDsFilter", + "traits": { + "smithy.api#documentation": "List Connectors Request Filters connector IDs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "List Connectors Request Filters.
" + } + }, + "com.amazonaws.mgn#ListConnectorsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.mgn#ConnectorsList", + "traits": { + "smithy.api#documentation": "List connectors response items.
" + } + }, + "nextToken": { + "target": "com.amazonaws.mgn#PaginationToken", + "traits": { + "smithy.api#documentation": "List connectors response next token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mgn#ListExportErrors": { "type": "operation", "input": { @@ -7691,6 +8046,16 @@ } } }, + "com.amazonaws.mgn#SecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 100 + }, + "smithy.api#pattern": "^arn:[\\w-]+:secretsmanager:([a-z]{2}-(gov-)?[a-z]+-\\d{1})?:(\\d{12})?:secret:(.+)$" + } + }, "com.amazonaws.mgn#SecurityGroupID": { "type": "string", "traits": { @@ -7894,6 +8259,12 @@ "traits": { "smithy.api#documentation": "Source server fqdn for action framework.
" } + }, + "connectorAction": { + "target": "com.amazonaws.mgn#SourceServerConnectorAction", + "traits": { + "smithy.api#documentation": "Source Server connector action.
" + } } }, "traits": { @@ -8009,6 +8380,26 @@ "smithy.api#documentation": "Source server post migration custom action filters.
" } }, + "com.amazonaws.mgn#SourceServerConnectorAction": { + "type": "structure", + "members": { + "credentialsSecretArn": { + "target": "com.amazonaws.mgn#SecretArn", + "traits": { + "smithy.api#documentation": "Source Server connector action credentials secret arn.
" + } + }, + "connectorArn": { + "target": "com.amazonaws.mgn#ConnectorArn", + "traits": { + "smithy.api#documentation": "Source Server connector action connector arn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Source Server connector action.
" + } + }, "com.amazonaws.mgn#SourceServerID": { "type": "string", "traits": { @@ -8026,6 +8417,9 @@ "target": "com.amazonaws.mgn#SourceServerID" } }, + "update": { + "target": "com.amazonaws.mgn#UpdateSourceServer" + }, "delete": { "target": "com.amazonaws.mgn#DeleteSourceServer" }, @@ -8246,6 +8640,16 @@ "smithy.api#documentation": "AWS Systems Manager Document external parameter.
" } }, + "com.amazonaws.mgn#SsmInstanceID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 20 + }, + "smithy.api#pattern": "(^i-[0-9a-zA-Z]{17}$)|(^mi-[0-9a-zA-Z]{17}$)" + } + }, "com.amazonaws.mgn#SsmParameterStoreParameter": { "type": "structure", "members": { @@ -9282,6 +9686,62 @@ } } }, + "com.amazonaws.mgn#UpdateConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#UpdateConnectorRequest" + }, + "output": { + "target": "com.amazonaws.mgn#Connector" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update Connector.
", + "smithy.api#http": { + "uri": "/UpdateConnector", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mgn#UpdateConnectorRequest": { + "type": "structure", + "members": { + "connectorID": { + "target": "com.amazonaws.mgn#ConnectorID", + "traits": { + "smithy.api#documentation": "Update Connector request connector ID.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.mgn#ConnectorName", + "traits": { + "smithy.api#documentation": "Update Connector request name.
" + } + }, + "ssmCommandConfig": { + "target": "com.amazonaws.mgn#ConnectorSsmCommandConfig", + "traits": { + "smithy.api#documentation": "Update Connector request SSM command config.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.mgn#UpdateLaunchConfiguration": { "type": "operation", "input": { @@ -9780,6 +10240,35 @@ } } }, + "com.amazonaws.mgn#UpdateSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#UpdateSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.mgn#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ConflictException" + }, + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Update Source Server.
", + "smithy.api#http": { + "uri": "/UpdateSourceServer", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, "com.amazonaws.mgn#UpdateSourceServerReplicationType": { "type": "operation", "input": { @@ -9836,6 +10325,33 @@ } } }, + "com.amazonaws.mgn#UpdateSourceServerRequest": { + "type": "structure", + "members": { + "accountID": { + "target": "com.amazonaws.mgn#AccountID", + "traits": { + "smithy.api#documentation": "Update Source Server request account ID.
" + } + }, + "sourceServerID": { + "target": "com.amazonaws.mgn#SourceServerID", + "traits": { + "smithy.api#documentation": "Update Source Server request source server ID.
", + "smithy.api#required": {} + } + }, + "connectorAction": { + "target": "com.amazonaws.mgn#SourceServerConnectorAction", + "traits": { + "smithy.api#documentation": "Update Source Server request connector action.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.mgn#UpdateWave": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json index 6bdf61fa917..6faabc548ff 100644 --- a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json +++ b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json @@ -58,7 +58,7 @@ "aws:RequestTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account.
\nBefore you create a link, you must create a sink in the monitoring account and create a\n sink policy in that account. The sink policy must permit the source account to link to it. You\n can grant permission to source accounts by granting permission to an entire organization or to\n individual accounts.
\nFor more information, see\n CreateSink and\n PutSinkPolicy.
\nEach monitoring account can be linked to as many as 100,000 source accounts.
\nEach source account can be linked to as many as five monitoring accounts.
", + "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account.
\nBefore you create a link, you must create a sink in the monitoring account and create a\n sink policy in that account. The sink policy must permit the source account to link to it. You\n can grant permission to source accounts by granting permission to an entire organization or to\n individual accounts.
\nFor more information, see\n CreateSink and\n PutSinkPolicy.
\nEach monitoring account can be linked to as many as 100,000 source accounts.
\nEach source account can be linked to as many as five monitoring accounts.
", "smithy.api#http": { "method": "POST", "uri": "/CreateLink" @@ -71,7 +71,7 @@ "LabelTemplate": { "target": "com.amazonaws.oam#LabelTemplate", "traits": { - "smithy.api#documentation": "Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\n account.
\nYou can use a custom label or use the following variables:
\n\n $AccountName is the name of the account
\n $AccountEmail is the globally unique email address of the account
\n $AccountEmailNoDomain is the email address of the account without the domain name
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\n account.
\nYou can use a custom label or use the following variables:
\n\n $AccountName is the name of the account
\n $AccountEmail is the globally unique email address of the account
\n $AccountEmailNoDomain is the email address of the account without the domain name
The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
\nFor more information about sinks, see\n CreateSink.
", + "smithy.api#documentation": "The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
\nFor more information about sinks, see\n CreateSink.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" } } }, @@ -180,7 +180,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be\n used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that\n represents an attachment point in a monitoring account. Source accounts can link to the sink\n to send observability data.
\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it.\n For more information, see PutSinkPolicy.
\nEach account can contain one sink. If you delete a sink, you can then create a new one in that account.
", + "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be\n used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that\n represents an attachment point in a monitoring account. Source accounts can link to the sink\n to send observability data.
\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it.\n For more information, see PutSinkPolicy.
\nEach account can contain one sink. If you delete a sink, you can then create a new one in that account.
", "smithy.api#http": { "method": "POST", "uri": "/CreateSink" @@ -200,7 +200,7 @@ "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see\n Controlling access to Amazon Web Services resources using tags.
" } } }, @@ -379,7 +379,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns complete information about one link.
\nTo use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
", + "smithy.api#documentation": "Returns complete information about one link.
\nTo use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
", "smithy.api#http": { "method": "POST", "uri": "/GetLink" @@ -478,7 +478,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns complete information about one monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
", + "smithy.api#documentation": "Returns complete information about one monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
", "smithy.api#http": { "method": "POST", "uri": "/GetSink" @@ -683,7 +683,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns a list of source account links that are linked to this monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
\nTo find a list of links for one source account, use ListLinks.
", + "smithy.api#documentation": "Returns a list of source account links that are linked to this monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
\nTo find a list of links for one source account, use ListLinks.
", "smithy.api#http": { "method": "POST", "uri": "/ListAttachedLinks" @@ -694,10 +694,7 @@ "pageSize": "MaxResults", "items": "Items" }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "dataplane" - ] + "smithy.api#readonly": {} } }, "com.amazonaws.oam#ListAttachedLinksInput": { @@ -810,7 +807,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that\n this source account has.
\nTo find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", + "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that\n this source account has.
\nTo find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", "smithy.api#http": { "method": "POST", "uri": "/ListLinks" @@ -1069,7 +1066,7 @@ "ResourceArn": { "target": "com.amazonaws.oam#Arn", "traits": { - "smithy.api#documentation": "The ARN of the resource that you want to view tags for.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
\nUnlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags\n for links or sinks you must have the oam:RequestTag permission. The\n aws:ReguestTag permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you want to view tags for.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
\nUnlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags\n for links or sinks you must have the oam:RequestTag permission. The\n aws:ReguestTag permission does not allow you to tag and untag links and\n sinks.
Creates or updates the resource policy that grants permissions to source\n accounts to link to the monitoring account sink. When you create a sink policy, you can grant\n permissions to all accounts in an organization or to individual accounts.
\nYou can also use a sink policy to limit the types of data that is shared. The three types that\n you can allow or deny are:
\n\n Metrics - Specify with\n AWS::CloudWatch::Metric\n
\n Log groups - Specify with AWS::Logs::LogGroup\n
\n Traces - Specify with AWS::XRay::Trace\n
See the examples in this section to see how to specify permitted source accounts and data types.
", + "smithy.api#documentation": "Creates or updates the resource policy that grants permissions to source\n accounts to link to the monitoring account sink. When you create a sink policy, you can grant\n permissions to all accounts in an organization or to individual accounts.
\nYou can also use a sink policy to limit the types of data that is shared. The three types that\n you can allow or deny are:
\n\n Metrics - Specify with\n AWS::CloudWatch::Metric\n
\n Log groups - Specify with AWS::Logs::LogGroup\n
\n Traces - Specify with AWS::XRay::Trace\n
\n Application Insights - Applications - Specify with AWS::ApplicationInsights::Application\n
See the examples in this section to see how to specify permitted source accounts and data types.
", "smithy.api#http": { "method": "POST", "uri": "/PutSinkPolicy" @@ -1162,7 +1159,7 @@ "Policy": { "target": "com.amazonaws.oam#SinkPolicy", "traits": { - "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is\n replaced by what you specify here.
\nThe policy must be in JSON string format with quotation marks escaped and no newlines.
\nFor examples of different types of policies, see the Examples section on this page.
", + "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is\n replaced by what you specify here.
\nThe policy must be in JSON string format with quotation marks escaped and no newlines.
\nFor examples of different types of policies, see the Examples section on this page.
", "smithy.api#required": {} } } @@ -1243,6 +1240,12 @@ "traits": { "smithy.api#enumValue": "AWS::XRay::Trace" } + }, + "AWS_APPLICATIONINSIGHTS_APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::ApplicationInsights::Application" + } } } }, @@ -1359,7 +1362,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified resource.\n Both sinks and links can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm,\n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:ResourceTag permission does not allow you to tag and untag links and\n sinks.
Assigns one or more tags (key-value pairs) to the specified resource.\n Both sinks and links can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm,\n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:ResourceTag permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you're adding tags to.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1441,7 +1444,7 @@ "aws.iam#conditionKeys": [ "aws:TagKeys" ], - "smithy.api#documentation": "Removes one or more tags from the specified resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:TagResource permission does not allow you to tag and untag links and\n sinks.
Removes one or more tags from the specified resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:TagResource permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you're removing tags from.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're removing tags from.
\nThe ARN format of a sink is\n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is\n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs\n resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1507,7 +1510,7 @@ "aws:ResourceTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked\n monitoring account sink. You can't change the sink or change the monitoring account with this operation.
\nTo update the list of tags associated with the sink, use\n TagResource.
", + "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked\n monitoring account sink. You can't change the sink or change the monitoring account with this operation.
\nTo update the list of tags associated with the sink, use\n TagResource.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateLink" @@ -1527,7 +1530,7 @@ "ResourceTypes": { "target": "com.amazonaws.oam#ResourceTypesInput", "traits": { - "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring\n account.
\nYour input here replaces the current set of data types that are shared.
", + "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring\n account.
\nYour input here replaces the current set of data types that are shared.
", "smithy.api#required": {} } } @@ -1693,7 +1696,7 @@ "X-Amz-Requested-Operation" ] }, - "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and\n monitoring accounts by using CloudWatch cross-account observability. With\n CloudWatch cross-account observability, you can monitor and troubleshoot applications that span\n multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,\n logs, and traces in any of the linked accounts without account boundaries.
\n\nSet up one or more Amazon Web Services accounts as monitoring\n accounts and link them with multiple source accounts. A\n monitoring account is a central Amazon Web Services account that can view and interact with\n observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.\n Source accounts share their observability data with the monitoring account. The shared\n observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, and traces in X-Ray.
", + "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and\n monitoring accounts by using CloudWatch cross-account observability. With\n CloudWatch cross-account observability, you can monitor and troubleshoot applications that span\n multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,\n logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.
\nSet up one or more Amazon Web Services accounts as monitoring\n accounts and link them with multiple source accounts. A\n monitoring account is a central Amazon Web Services account that can view and interact with\n observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.\n Source accounts share their observability data with the monitoring account. The shared\n observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.
", "smithy.api#title": "CloudWatch Observability Access Manager", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json index 6197c459506..43a9fce846c 100644 --- a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json +++ b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json @@ -36,6 +36,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to abort multipart read set uploads", "smithy.api#documentation": "\n Stops a multipart upload.\n
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -820,6 +821,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to batch delete Read Sets in the given Sequence Store", "smithy.api#documentation": "Deletes one or more read sets.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -1106,6 +1108,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to complete a multipart read set upload", "smithy.api#documentation": "\n Concludes a multipart upload once you have uploaded all the components.\n
", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -1559,6 +1562,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a multipart read set upload", "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -1755,6 +1759,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Reference Store", "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" @@ -2025,6 +2030,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Sequence Store", "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" @@ -2737,6 +2743,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference in the given Reference Store", "smithy.api#documentation": "Deletes a genome reference.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -2812,6 +2819,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference Store", "smithy.api#documentation": "Deletes a genome reference store.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -3005,6 +3013,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Sequence Store", "smithy.api#documentation": "Deletes a sequence store.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -3266,6 +3275,51 @@ } } }, + "com.amazonaws.omics#ETag": { + "type": "structure", + "members": { + "algorithm": { + "target": "com.amazonaws.omics#ETagAlgorithm", + "traits": { + "smithy.api#documentation": "\n The algorithm used to calculate the read set’s ETag(s).
" + } + }, + "source1": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ETag hash calculated on Source1 of the read set.\n
" + } + }, + "source2": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ETag hash calculated on Source2 of the read set.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object representing its semantic content.\n
" + } + }, + "com.amazonaws.omics#ETagAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FASTQ_MD5up", + "name": "FASTQ_MD5UP" + }, + { + "value": "BAM_MD5up", + "name": "BAM_MD5UP" + }, + { + "value": "CRAM_MD5up", + "name": "CRAM_MD5UP" + } + ] + } + }, "com.amazonaws.omics#Encoding": { "type": "string", "traits": { @@ -4340,6 +4394,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a Read Set in the given Sequence Store", "smithy.api#documentation": "Gets a file from a read set.
", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -4380,6 +4435,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set activation job for the given Sequence Store", "smithy.api#documentation": "Gets information about a read set activation job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4579,6 +4635,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set export job for the given Sequence Store", "smithy.api#documentation": "Gets information about a read set export job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4785,6 +4842,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set import job for the given Sequence Store", "smithy.api#documentation": "Gets information about a read set import job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4992,6 +5050,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set in the given Sequence Store", "smithy.api#documentation": "Gets details about a read set.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5127,6 +5186,12 @@ "traits": { "smithy.api#documentation": "\n The creation type of the read set.\n
" } + }, + "etag": { + "target": "com.amazonaws.omics#ETag", + "traits": { + "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object meant to represent its semantic content.\n
" + } } }, "traits": { @@ -5225,6 +5290,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a Reference in the given Reference Store", "smithy.api#documentation": "Gets a reference file.
", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -5265,6 +5331,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference import job for the given Reference Store", "smithy.api#documentation": "Gets information about a reference import job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5472,6 +5539,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference in the given Reference Store", "smithy.api#documentation": "Gets information about a genome reference's metadata.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5680,6 +5748,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference Store", "smithy.api#documentation": "Gets information about a reference store.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -6574,6 +6643,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Sequence Store", "smithy.api#documentation": "Gets information about a sequence store.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8213,6 +8283,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list multipart read set uploads", "smithy.api#documentation": "\n Lists all multipart read set uploads and their statuses. \n
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8313,6 +8384,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set activation jobs for the given Sequence Store", "smithy.api#documentation": "Retrieves a list of read set activation jobs.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8419,6 +8491,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set export jobs for the given Sequence Store", "smithy.api#documentation": "Retrieves a list of read set export jobs.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8525,6 +8598,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set import jobs for the given Sequence Store", "smithy.api#documentation": "Retrieves a list of read set import jobs.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8637,6 +8711,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list read set upload parts", "smithy.api#documentation": "\n This operation will list all parts in a requested multipart upload for a sequence store.\n
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8758,6 +8833,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Sets in the given Sequence Store", "smithy.api#documentation": "Retrieves a list of read sets.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8865,6 +8941,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Reference import jobs for the given Reference Store", "smithy.api#documentation": "Retrieves a list of reference import jobs.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8968,6 +9045,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Reference Stores", "smithy.api#documentation": "Retrieves a list of reference stores.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -9067,6 +9145,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list References in the given Reference Store", "smithy.api#documentation": "Retrieves a list of references.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -9511,6 +9590,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Sequence Stores", "smithy.api#documentation": "Retrieves a list of sequence stores.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -11562,6 +11642,12 @@ "traits": { "smithy.api#documentation": "\n The creation type of the read set.\n
" } + }, + "etag": { + "target": "com.amazonaws.omics#ETag", + "traits": { + "smithy.api#documentation": "\n The entity tag (ETag) is a hash of the object representing its semantic content.\n
" + } } }, "traits": { @@ -11639,7 +11725,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "readSet" - } + }, + "smithy.api#documentation": "Represents a resource that stores a single genomic sequence file" } }, "com.amazonaws.omics#ReadSetStatus": { @@ -12073,7 +12160,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "reference" - } + }, + "smithy.api#documentation": "Represents a resource that stores a single genomic reference file" } }, "com.amazonaws.omics#ReferenceStatus": { @@ -12265,7 +12353,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "referenceStore" - } + }, + "smithy.api#documentation": "Represents a resource that stores genomic reference data" } }, "com.amazonaws.omics#ReferenceStreamingBlob": { @@ -13225,7 +13314,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "sequenceStore" - } + }, + "smithy.api#documentation": "Represents a resource that stores genomic sequence data" } }, "com.amazonaws.omics#ServiceQuotaExceededException": { @@ -13570,6 +13660,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set activation job from the given Sequence Store", "smithy.api#documentation": "Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read\n sets after 30 days.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -13703,6 +13794,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set export job from the given Sequence Store", "smithy.api#documentation": "Exports a read set to Amazon S3.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -13836,6 +13928,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set import job into the given Sequence Store", "smithy.api#documentation": "Starts a read set import job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -14035,6 +14128,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Reference import job into the given Reference Store", "smithy.api#documentation": "Starts a reference import job.
", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -15682,6 +15776,7 @@ ], "traits": { "aws.auth#unsignedPayload": {}, + "aws.iam#actionPermissionDescription": "Grants permission to upload read set parts", "smithy.api#documentation": "\n This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten. \n
", "smithy.api#endpoint": { "hostPrefix": "storage-" diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index 73ef12cf8a1..88d091ac781 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -6050,6 +6050,12 @@ "traits": { "smithy.api#documentation": "The definition of an analysis.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
\nEither a SourceEntity or a Definition must be provided in \n order for the request to be valid.
The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.
" + } } }, "traits": { @@ -6227,6 +6233,12 @@ "traits": { "smithy.api#documentation": "The definition of a dashboard.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
\nEither a SourceEntity or a Definition must be provided in \n order for the request to be valid.
The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
" + } } }, "traits": { @@ -7811,6 +7823,12 @@ "traits": { "smithy.api#documentation": "The definition of a template.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
\nEither a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.
TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.
" + } } }, "traits": { @@ -11334,6 +11352,36 @@ } } }, + "com.amazonaws.quicksight#DatabaseGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DatabaseGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatabaseGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DatabaseUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.quicksight#DatabricksParameters": { "type": "structure", "members": { @@ -20540,6 +20588,12 @@ "traits": { "smithy.api#documentation": "Select all of the values. Null is not the assigned value of select all.
\n\n FILTER_ALL_VALUES\n
This option determines how null values should be treated when filtering data.
\n\n ALL_VALUES: Include null values in filtered results.
\n NULLS_ONLY: Only include null values in filtered results.
\n NON_NULLS_ONLY: Exclude null values from filtered results.
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .
Cluster ID. This field can be blank if the Host and Port are\n provided.
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
" + } } }, "traits": { - "smithy.api#documentation": "The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and\n Port fields can be blank if the ClusterId field is set.
The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.
The definition of an analysis.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
" } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.
" + } } }, "traits": { @@ -46485,6 +46598,12 @@ "traits": { "smithy.api#documentation": "The definition of a dashboard.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
" } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.
" + } } }, "traits": { @@ -48138,6 +48257,12 @@ "traits": { "smithy.api#documentation": "The definition of a template.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
" } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.
" + } } }, "traits": { @@ -49630,6 +49755,38 @@ "target": "com.amazonaws.quicksight#VPCConnectionSummary" } }, + "com.amazonaws.quicksight#ValidationStrategy": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.quicksight#ValidationStrategyMode", + "traits": { + "smithy.api#documentation": "The mode of validation for the asset to be creaed or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.
The pending maintenance action to apply to this resource.
\nValid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n
The pending maintenance action to apply to this resource.
\nValid Values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.
Valid values:
\n\n immediate - Apply the maintenance action immediately.
\n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.
\n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.
Valid Values:
\n\n immediate - Apply the maintenance action immediately.
\n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.
\n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.
A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.
" + "smithy.api#documentation": "Specifies whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.
" } }, "UseEarliestTimeOnPointInTimeUnavailable": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.
" + "smithy.api#documentation": "Specifies whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.
" } } }, @@ -2675,7 +2675,7 @@ "CustomerOverride": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Whether there is an override for the default certificate identifier.
" + "smithy.api#documentation": "Indicates whether there is an override for the default certificate identifier.
" } }, "CustomerOverrideValidTill": { @@ -2852,7 +2852,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "EngineVersion": { @@ -2896,19 +2896,19 @@ "MaxConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
\nConstraints: Must be between 1 and 100.
" + "smithy.api#documentation": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints:
\nMust be between 1 and 100.
\nControls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
A value that controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.
Constraints:
\nMust be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.
\nDefault: 120
\nConstraints: between 1 and 3600, or 0 representing unlimited
" + "smithy.api#documentation": "The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120\n
Constraints:
\nMust be between 0 and 3600.
\nA value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.
" } }, "Tags": { @@ -3365,7 +3365,7 @@ "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.
" } }, "PreSignedUrl": { @@ -3389,7 +3389,7 @@ "CopyOptionGroup": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.
" + "smithy.api#documentation": "Specifies whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.
" } } }, @@ -4695,7 +4695,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nThe password for the master user.
\nThis setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.
\nConstraints:
\nCan't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
\nLength Constraints:
\nRDS for MariaDB - Must contain from 8 to 41 characters.
\nRDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
\nRDS for MySQL - Must contain from 8 to 41 characters.
\nRDS for Oracle - Must contain from 8 to 30 characters.
\nRDS for PostgreSQL - Must contain from 8 to 128 characters.
\nCreates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.
\nYour source DB instance or cluster must have backup retention enabled.
\nCreates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.
All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.
\nYour source DB instance or cluster must have backup retention enabled.
\nThe compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: Inherits from the source DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
\nDefault: Inherits the value from the source DB instance.
" } }, "AvailabilityZone": { @@ -5152,43 +5152,43 @@ "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number that the DB instance uses for connections.
\nDefault: Inherits from the source DB instance
\nValid Values: 1150-65535\n
The port number that the DB instance uses for connections.
\nValid Values: 1150-65535\n
Default: Inherits the value from the source DB instance.
" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the read replica is in a Multi-AZ deployment.
\nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the read replica is in a Multi-AZ deployment.
\nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Inherits from the source DB instance
" + "smithy.api#documentation": "Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window.
\nThis setting doesn't apply to RDS Custom DB instances.
\nDefault: Inherits the value from the source DB instance.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The option group the DB instance is associated with. If omitted, the option group\n associated with the source instance or cluster is used.
\nFor SQL Server, you must use the option group associated with the source.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The option group to associate the DB instance with. If not specified, RDS uses the option group\n associated with the source DB instance or cluster.
\nFor SQL Server, you must use the option group associated with the source.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -5197,37 +5197,37 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
\nConstraints:
\nIf supplied, must match the name of an existing DBSubnetGroup.
\nThe specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
\nAll read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>
\nSpecify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.
\nNot specify a DB subnet group. All these read replicas are created outside of any\n VPC.
\nExample: mydbsubnetgroup\n
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
\nConstraints:
\nIf supplied, must match the name of an existing DB subnet group.
\nThe specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
\nAll read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:
\nSpecify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.
\nNot specify a DB subnet group. All these read replicas are created outside of any\n VPC.
\nExample: mydbsubnetgroup\n
A list of Amazon EC2 VPC security groups to associate with the read replica.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" + "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with the read replica.
\nThis setting doesn't apply to RDS Custom DB instances.
\nDefault: The default EC2 VPC security group for the DB subnet group's VPC.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the read replica.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The storage type to associate with the read replica.
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Valid Values: gp2 | gp3 | io1 | standard\n
Default: io1 if the Iops parameter\n is specified. Otherwise, gp2.
A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags aren't copied.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collection of Enhanced Monitoring metrics,\n specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
Default: 0\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
" } }, "KmsKeyId": { @@ -5239,67 +5239,67 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
\nThis setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
\nYou must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
\nThis setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
\nYou must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom DB instances.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nThis setting doesn't apply to RDS Custom DB instances.
\nValid Values:
\n\n 7\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
\n 731\n
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role to be used when making API calls to the Directory\n Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory\n Service.
\nThis setting doesn't apply to RDS Custom DB instances.
" } }, "DomainFqdn": { @@ -5341,25 +5341,25 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.
\nThis setting is required for RDS Custom DB instances.
" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput value for the read replica.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "Specifies the storage throughput value for the read replica.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "AllocatedStorage": { @@ -5572,7 +5572,7 @@ "TargetRole": { "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write\n or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.
" + "smithy.api#documentation": "Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.
" } }, "IdleClientTimeout": { @@ -5658,7 +5658,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" + "smithy.api#documentation": "Specifies whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, "Tags": { @@ -6071,7 +6071,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
" + "smithy.api#documentation": "Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
" } }, "Tags": { @@ -6791,7 +6791,7 @@ "GlobalWriteForwardingRequested": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.
Indicates whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.
" + "smithy.api#documentation": "Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.
" } }, "AwsBackupRecoveryPointArn": { @@ -6986,7 +6986,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "ClusterCreateTime": { @@ -6999,7 +6999,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the source DB cluster is encrypted.
" + "smithy.api#documentation": "Indicates whether the source DB cluster is encrypted.
" } }, "AllocatedStorage": { @@ -7444,7 +7444,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Indicates whether the cluster member is the primary DB instance for the DB cluster.
" } }, "DBClusterParameterGroupStatus": { @@ -7762,107 +7762,107 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
" + "smithy.api#documentation": "The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
" } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the identifier for the DB cluster snapshot.
" + "smithy.api#documentation": "The identifier for the DB cluster snapshot.
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
" + "smithy.api#documentation": "The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
" } }, "SnapshotCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
" + "smithy.api#documentation": "The time when the snapshot was taken, in Universal Coordinated Time (UTC).
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the name of the database engine for this DB cluster snapshot.
" + "smithy.api#documentation": "The name of the database engine for this DB cluster snapshot.
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the engine mode of the database engine for this DB cluster snapshot.
" + "smithy.api#documentation": "The engine mode of the database engine for this DB cluster snapshot.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" + "smithy.api#documentation": "The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the status of this DB cluster snapshot. Valid statuses are the following:
\n\n available\n
\n copying\n
\n creating\n
The status of this DB cluster snapshot. Valid statuses are the following:
\n\n available\n
\n copying\n
\n creating\n
Specifies the port that the DB cluster was listening on at the time of the snapshot.
" + "smithy.api#documentation": "The port that the DB cluster was listening on at the time of the snapshot.
" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the VPC ID associated with the DB cluster snapshot.
" + "smithy.api#documentation": "The VPC ID associated with the DB cluster snapshot.
" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
" + "smithy.api#documentation": "The time when the DB cluster was created, in Universal Coordinated Time (UTC).
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the master username for this DB cluster snapshot.
" + "smithy.api#documentation": "The master username for this DB cluster snapshot.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the version of the database engine for this DB cluster snapshot.
" + "smithy.api#documentation": "The version of the database engine for this DB cluster snapshot.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the license model information for this DB cluster snapshot.
" + "smithy.api#documentation": "The license model information for this DB cluster snapshot.
" } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides the type of the DB cluster snapshot.
" + "smithy.api#documentation": "The type of the DB cluster snapshot.
" } }, "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the percentage of the estimated data that has been transferred.
" + "smithy.api#documentation": "The percentage of the estimated data that has been transferred.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the DB cluster snapshot is encrypted.
" + "smithy.api#documentation": "Indicates whether the DB cluster snapshot is encrypted.
" } }, "KmsKeyId": { @@ -7874,7 +7874,7 @@ "DBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the DB cluster snapshot.
" } }, "SourceDBClusterSnapshotArn": { @@ -7887,7 +7887,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "TagList": { @@ -7908,7 +7908,7 @@ "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.
" + "smithy.api#documentation": "The resource ID of the DB cluster that this DB cluster snapshot was created from.
" } } }, @@ -8114,7 +8114,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
" + "smithy.api#documentation": "Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
" } }, "SupportsReadReplica": { @@ -8146,14 +8146,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
" + "smithy.api#documentation": "Indicates whether you can use Aurora parallel query with a specific DB engine version.
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific DB engine version.
" + "smithy.api#documentation": "Indicates whether you can use Aurora global databases with a specific DB engine version.
" } }, "MajorEngineVersion": { @@ -8199,7 +8199,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
" + "smithy.api#documentation": "Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
" } }, "CustomDBEngineVersionManifest": { @@ -8211,7 +8211,7 @@ "SupportsCertificateRotationWithoutRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.
" + "smithy.api#documentation": "Indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.
" } }, "SupportedCACertificateIdentifiers": { @@ -8223,7 +8223,7 @@ "SupportsLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" } } }, @@ -8815,20 +8815,20 @@ "RestoreWindow": { "target": "com.amazonaws.rds#RestoreWindow", "traits": { - "smithy.api#documentation": "Earliest and latest time an instance can be restored to.
" + "smithy.api#documentation": "The earliest and latest time a DB instance can be restored to.
" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" + "smithy.api#documentation": "The allocated storage size for the the automated backup in gibibytes (GiB).
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Provides a list of status information for an automated backup:
\n\n active - Automated backups for current instances.
\n retained - Automated backups for deleted instances.
\n creating - Automated backups that are waiting for the first automated snapshot to be available.
A list of status information for an automated backup:
\n\n active - Automated backups for current instances.
\n retained - Automated backups for deleted instances.
\n creating - Automated backups that are waiting for the first automated snapshot to be available.
Provides the VPC ID associated with the DB instance.
" + "smithy.api#documentation": "The VPC ID associated with the DB instance.
" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "Provides the date and time that the DB instance was created.
" + "smithy.api#documentation": "The date and time when the DB instance was created.
" } }, "MasterUsername": { @@ -8877,7 +8877,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the automated backup.
" + "smithy.api#documentation": "The license model information for the automated backup.
" } }, "Iops": { @@ -8902,13 +8902,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the automated backup is encrypted.
" + "smithy.api#documentation": "Indicates whether the automated backup is encrypted.
" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type associated with the automated backup.
" + "smithy.api#documentation": "The storage type associated with the automated backup.
" } }, "KmsKeyId": { @@ -8951,13 +8951,13 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" + "smithy.api#documentation": "The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the storage throughput for the automated backup.
" + "smithy.api#documentation": "The storage throughput for the automated backup.
" } }, "AwsBackupRecoveryPointArn": { @@ -9123,12 +9123,12 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB instance.
\n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:
\n\n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.
\n PENDING - the IAM role ARN is being associated with the DB instance.
\n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
" + "smithy.api#documentation": "Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
" } }, "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { @@ -9204,13 +9204,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" + "smithy.api#documentation": "A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.
" + "smithy.api#documentation": "The status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.
" } }, "Message": { @@ -9507,7 +9507,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" + "smithy.api#documentation": "Indicates whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.
" } }, "CreatedDate": { @@ -9611,7 +9611,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.
" + "smithy.api#documentation": "Indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.
" } } }, @@ -9952,7 +9952,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.
Indicates whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.
Specifies whether the DB snapshot is encrypted.
" + "smithy.api#documentation": "Indicates whether the DB snapshot is encrypted.
" } }, "KmsKeyId": { @@ -10365,7 +10365,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "ProcessorFeatures": { @@ -11015,7 +11015,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.
\nYou must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.
" + "smithy.api#documentation": "Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.
" } } }, @@ -11204,7 +11204,7 @@ } ], "traits": { - "smithy.api#documentation": "The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:
\nThe DB cluster is a read replica of another Amazon Aurora DB cluster.
\nThe DB instance is the only instance in the DB cluster.
\nTo delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.
Deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n However, manual DB snapshots of the DB instance aren't deleted.
\nIf you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. \n This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:
\nThe DB cluster is a read replica of another Amazon Aurora DB cluster.
\nThe DB instance is the only instance in the DB cluster.
\nTo delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. \n After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete \n these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
\nA value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" + "smithy.api#documentation": "Specifies whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" } }, "FinalDBSnapshotIdentifier": { @@ -11336,7 +11336,7 @@ "DeleteAutomatedBackups": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.
" + "smithy.api#documentation": "Specifies whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.
" } } }, @@ -12589,7 +12589,7 @@ "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.
A specific source to return parameters for.
\nValid Values:
\n\n customer\n
\n engine\n
\n service\n
A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
" + "smithy.api#documentation": "Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
" } }, "DbClusterResourceId": { @@ -13255,7 +13255,7 @@ "target": "com.amazonaws.rds#DBEngineVersionMessage" }, "traits": { - "smithy.api#documentation": "Returns a list of the available DB engines.
", + "smithy.api#documentation": "Describes the properties of specific versions of DB engines.
", "smithy.api#examples": [ { "title": "To describe the DB engine versions for the MySQL DB engine", @@ -13306,19 +13306,19 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to return.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to return version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-oracle-ee\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine version to return.
\nExample: 5.1.49\n
A specific database engine version to return details for.
\nExample: 5.1.49\n
The name of a specific DB parameter group family to return details for.
\nConstraints:
\nIf supplied, must match an existing DBParameterGroupFamily.
\nThe name of a specific DB parameter group family to return details for.
\nConstraints:
\nIf supplied, must match an existing DB parameter group family.
\nA value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
" + "smithy.api#documentation": "Specifies whether to return only the default version of the specified engine or the engine and major version combination.
" } }, "ListSupportedCharacterSets": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.
Specifies whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
" } }, "ListSupportedTimezones": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.
Specifies whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
" } }, "IncludeAll": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
" + "smithy.api#documentation": "Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
" } } }, @@ -14754,14 +14754,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" } }, "DbiResourceId": { @@ -15136,7 +15136,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.
\nRDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.
" + "smithy.api#documentation": "Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.
\nRDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.
" } }, "Filters": { @@ -16019,7 +16019,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to show only those reservations that support Multi-AZ.
" + "smithy.api#documentation": "Specifies whether to show only those reservations that support Multi-AZ.
" } }, "LeaseId": { @@ -16141,7 +16141,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to show only those reservations that support Multi-AZ.
" + "smithy.api#documentation": "Specifies whether to show only those reservations that support Multi-AZ.
" } }, "Filters": { @@ -16616,7 +16616,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Boolean value that if true, indicates there is more data to be downloaded.
" + "smithy.api#documentation": "A Boolean value that, if true, indicates there is more data to be downloaded.
" } } }, @@ -17081,31 +17081,31 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The data exported from the snapshot or cluster. Valid values are the following:
\n\n database - Export all the data from a specified database.
\n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data exported from the snapshot or cluster.
\nValid Values:
\n\n database - Export all the data from a specified database.
\n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The time that the snapshot was created.
" + "smithy.api#documentation": "The time when the snapshot was created.
" } }, "TaskStartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The time that the snapshot or cluster export task started.
" + "smithy.api#documentation": "The time when the snapshot or cluster export task started.
" } }, "TaskEndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The time that the snapshot or cluster export task ended.
" + "smithy.api#documentation": "The time when the snapshot or cluster export task ended.
" } }, "S3Bucket": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket that the snapshot or cluster is exported to.
" + "smithy.api#documentation": "The Amazon S3 bucket where the snapshot or cluster is exported to.
" } }, "S3Prefix": { @@ -17166,7 +17166,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details of a snapshot or cluster export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks action.
Contains the details of a snapshot or cluster export to Amazon S3.
\nThis data type is used as a response element in the DescribeExportTasks operation.
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing DB cluster.
\nSpecifies whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.
" + "smithy.api#documentation": "Indicates whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.
" } }, "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "Specifies whether a secondary cluster in the global cluster has\n write forwarding enabled, not enabled, or is in the process of enabling it.
" + "smithy.api#documentation": "The status of write forwarding for a secondary cluster in the global cluster.
" } }, "SynchronizationStatus": { @@ -17732,13 +17732,13 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" + "smithy.api#documentation": "The status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" } }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the IP range.
" + "smithy.api#documentation": "The IP range.
" } } }, @@ -18701,7 +18701,7 @@ "RemoveCustomerOverride": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.
" + "smithy.api#documentation": "Specifies whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.
" } } }, @@ -20677,7 +20677,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n
A value that indicates whether to activate the subscription.
" + "smithy.api#documentation": "Specifies whether to activate the subscription.
" } } }, @@ -20874,7 +20874,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
" + "smithy.api#documentation": "Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
" } } }, @@ -20930,14 +20930,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicate if this option is persistent.
" + "smithy.api#documentation": "Indicates whether this option is persistent.
" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicate if this option is permanent.
" + "smithy.api#documentation": "Indicates whether this option is permanent.
" } }, "Port": { @@ -20972,7 +20972,7 @@ } }, "traits": { - "smithy.api#documentation": "Option details.
" + "smithy.api#documentation": "The details of an option.
" } }, "com.amazonaws.rds#OptionConfiguration": { @@ -21204,7 +21204,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the option requires a port.
" + "smithy.api#documentation": "Indicates whether the option requires a port.
" } }, "DefaultPort": { @@ -21274,7 +21274,7 @@ "CopyableCrossAccount": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether the option can be copied across Amazon Web Services accounts.
" + "smithy.api#documentation": "Indicates whether the option can be copied across Amazon Web Services accounts.
" } } }, @@ -21319,14 +21319,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Boolean value where true indicates that this option group option can be changed from the default value.
" + "smithy.api#documentation": "Indicates whether this option group option can be changed from the default value.
" } }, "IsRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Boolean value where true indicates that a value must be specified for this option setting of the option group option.
" + "smithy.api#documentation": "Indicates whether a value must be specified for this option setting of the option group option.
" } }, "MinimumEngineVersionPerAllowedValue": { @@ -21489,14 +21489,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A Boolean value that, when true, indicates the option setting can be modified from the default.
" + "smithy.api#documentation": "Indicates whether the option setting can be modified from the default.
" } }, "IsCollection": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the option setting is part of a collection.
" + "smithy.api#documentation": "Indicates whether the option setting is part of a collection.
" } } }, @@ -21535,7 +21535,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if the version is the default version of the option, and otherwise false.
" + "smithy.api#documentation": "Indicates whether the version is the default version of the option.
" } } }, @@ -21640,7 +21640,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Indicates the storage type for a DB instance.
" + "smithy.api#documentation": "The storage type for a DB instance.
" } }, "SupportsIops": { @@ -21668,7 +21668,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "True if a DB instance supports Performance Insights, otherwise false.
" + "smithy.api#documentation": "Indicates whether a DB instance supports Performance Insights.
" } }, "MinStorageSize": { @@ -21722,20 +21722,20 @@ "SupportsStorageAutoscaling": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
" + "smithy.api#documentation": "Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
" } }, "SupportsKerberosAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Whether a DB instance supports Kerberos Authentication.
" + "smithy.api#documentation": "Indicates whether a DB instance supports Kerberos Authentication.
" } }, "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Indicates whether a DB instance supports RDS on Outposts.
\nFor more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n
" } }, "SupportedActivityStreamModes": { @@ -21748,14 +21748,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
" + "smithy.api#documentation": "Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
" } }, "SupportsClusters": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether DB instances can be configured as a Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "SupportedNetworkTypes": { @@ -21850,13 +21850,13 @@ "ParameterName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the name of the parameter.
" + "smithy.api#documentation": "The name of the parameter.
" } }, "ParameterValue": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the value of the parameter.
" + "smithy.api#documentation": "The value of the parameter.
" } }, "Description": { @@ -21868,7 +21868,7 @@ "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Indicates the source of the parameter value.
" + "smithy.api#documentation": "The source of the parameter value.
" } }, "ApplyType": { @@ -22067,7 +22067,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
" + "smithy.api#documentation": "Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
" } }, "EngineVersion": { @@ -22124,7 +22124,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" + "smithy.api#documentation": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } }, "AutomationMode": { @@ -22616,7 +22616,7 @@ "ForceFailover": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the reboot is conducted through a Multi-AZ failover.
\nConstraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" + "smithy.api#documentation": "Specifies whether the reboot is conducted through a Multi-AZ failover.
\nConstraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
" } } }, @@ -23203,7 +23203,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the reservation applies to Multi-AZ deployments.
" + "smithy.api#documentation": "Indicates whether the reservation applies to Multi-AZ deployments.
" } }, "State": { @@ -23374,7 +23374,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the offering applies to Multi-AZ deployments.
" + "smithy.api#documentation": "Indicates whether the offering applies to Multi-AZ deployments.
" } }, "RecurringCharges": { @@ -23482,7 +23482,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.
Specifies whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.
A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.
" + "smithy.api#documentation": "Specifies whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.
" } }, "Parameters": { @@ -23825,7 +23825,7 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the restored DB cluster is encrypted.
" + "smithy.api#documentation": "Specifies whether the restored DB cluster is encrypted.
" } }, "KmsKeyId": { @@ -23837,13 +23837,13 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.
\nValid values: mysql\n
The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.
\nValid Values: mysql\n
A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" } }, "Domain": { @@ -23916,13 +23916,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The network type of the DB cluster.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies the storage type to be associated with the DB cluster.
\nValid values: aurora, aurora-iopt1\n
Default: aurora\n
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nValid Values: aurora, aurora-iopt1\n
Default: aurora\n
Valid for: Aurora DB clusters only
" } } }, @@ -24164,7 +24164,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { @@ -24200,25 +24200,25 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "DBClusterInstanceClass": { @@ -24230,7 +24230,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Iops": { @@ -24242,7 +24242,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "ServerlessV2ScalingConfiguration": { @@ -24251,7 +24251,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The network type of the DB cluster.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } } }, @@ -24433,7 +24433,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { @@ -24472,7 +24472,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { @@ -24496,25 +24496,25 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.
\nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { @@ -24538,13 +24538,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nWhen specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" } }, "Iops": { @@ -24559,7 +24559,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB cluster.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The network type of the DB cluster.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "SourceDbClusterResourceId": { @@ -24739,25 +24739,25 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.
\nIf you restore an RDS Custom DB instance, you must disable this parameter.
" + "smithy.api#documentation": "Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window.
\nIf you restore an RDS Custom DB instance, you must disable this parameter.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid Values: license-included | bring-your-own-license | general-public-license\n
Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
\nConstraints:
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
\nConstraints:
\nCan't be longer than 64 characters.
\nExample: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
\nIn most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
\nFor more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.
\nIn most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
\nFor more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { @@ -24856,7 +24856,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { @@ -24874,7 +24874,7 @@ "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { @@ -24886,13 +24886,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { @@ -24910,7 +24910,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" } }, "StorageThroughput": { @@ -25121,7 +25121,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
Specifies whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.
" + "smithy.api#documentation": "Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.
" } }, "LicenseModel": { @@ -25157,7 +25157,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -25169,13 +25169,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, \n you must also include a value for the Iops parameter.
Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n
A value that indicates whether the new DB instance is encrypted or not.
" + "smithy.api#documentation": "Specifies whether the new DB instance is encrypted or not.
" } }, "KmsKeyId": { @@ -25187,7 +25187,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
" } }, "MonitoringInterval": { @@ -25205,7 +25205,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "SourceEngine": { @@ -25245,7 +25245,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specifies whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
" } }, "PerformanceInsightsKMSKeyId": { @@ -25275,13 +25275,13 @@ "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" + "smithy.api#documentation": "Specifies whether the DB instance class of the DB instance uses its default\n processor features.
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "MaxAllocatedStorage": { @@ -25293,7 +25293,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nValid Values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" } }, "StorageThroughput": { @@ -25305,7 +25305,7 @@ "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
\nFor more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n
\nConstraints:
\nCan't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether the DB instance class of the DB instance uses its default processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { @@ -25956,7 +25956,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.
\nIndicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.
\nA value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
" + "smithy.api#documentation": "Indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
" } }, "SecondsUntilAutoPause": { @@ -26185,7 +26185,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
" + "smithy.api#documentation": "Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
" } } }, @@ -26798,7 +26798,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:
\n\n database - Export all the data from a specified database.
\n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data to be exported from the snapshot or cluster. \n If this parameter isn't provided, all of the data is exported.
\nValid Values:
\n\n database - Export all the data from a specified database.
\n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
\n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
\n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
" + "smithy.api#documentation": "Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
" } }, "SupportedEngineModes": { @@ -27807,25 +27807,25 @@ "SupportsParallelQuery": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether you can use Aurora parallel query with the target engine version.
" + "smithy.api#documentation": "Indicates whether you can use Aurora parallel query with the target engine version.
" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether you can use Aurora global databases with the target engine version.
" + "smithy.api#documentation": "Indicates whether you can use Aurora global databases with the target engine version.
" } }, "SupportsBabelfish": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
" + "smithy.api#documentation": "Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
" } }, "SupportsLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "Indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" } } }, @@ -27863,7 +27863,7 @@ "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { - "smithy.api#documentation": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" + "smithy.api#documentation": "Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" } }, "ProvisionedStorageThroughput": { diff --git a/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json b/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json index cb171eb7c42..d5fbce4bb35 100644 --- a/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json +++ b/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json @@ -2010,7 +2010,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.
\n Deleting Resource Record Sets\n
\nTo delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.
\n\n Change Batches and Transactional Changes\n
\nThe request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.
For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.
If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.
\n Traffic Flow\n
\nTo create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.
\n\n Create, Delete, and Upsert\n
\nUse ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:
\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes an existing resource record set that has the\n\t\t\t\t\tspecified values.
\n UPSERT: If a resource set exists Route 53 updates it with the\n\t\t\t\t\tvalues in the request.
\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n
\nThe syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.
\nFor an example for each type of resource record set, see \"Examples.\"
\nDon't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.
\n Change Propagation to Route 53 DNS Servers\n
\nWhen you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.
\n Limits on ChangeResourceRecordSets Requests\n
\nFor information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.
Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.
\n Deleting Resource Record Sets\n
\nTo delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.
\n\n Change Batches and Transactional Changes\n
\nThe request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.
For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.
If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.
\n Traffic Flow\n
\nTo create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.
\n\n Create, Delete, and Upsert\n
\nUse ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:
\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes an existing resource record set that has the\n\t\t\t\t\tspecified values.
\n UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource\n\t\t\t\t\tset exists Route 53 updates it with the values in the request.
\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n
\nThe syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.
\nFor an example for each type of resource record set, see \"Examples.\"
\nDon't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.
\n Change Propagation to Route 53 DNS Servers\n
\nWhen you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.
\n Limits on ChangeResourceRecordSets Requests\n
\nFor information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.
A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference and settings as a previous request, and if the\n\t\t\t\t\thealth check doesn't exist, Amazon Route 53 creates the health check. If the\n\t\t\t\t\thealth check does exist, Route 53 returns the settings for the existing health\n\t\t\t\t\tcheck.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as a deleted health check, regardless of the\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as an existing health check but with different\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique\n\t\t\t\t\t\tCallerReference but settings identical to an existing health\n\t\t\t\t\tcheck, Route 53 creates the health check.
A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference and settings as a previous request, and if the\n\t\t\t\t\thealth check doesn't exist, Amazon Route 53 creates the health check. If the\n\t\t\t\t\thealth check does exist, Route 53 returns the settings for the existing health\n\t\t\t\t\tcheck.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as a deleted health check, regardless of the\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as an existing health check but with different\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique\n\t\t\t\t\t\tCallerReference but settings identical to an existing health\n\t\t\t\t\tcheck, Route 53 creates the health check.
Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.
Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.
For geolocation resource record sets, the two-letter code for a country.
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
" + "smithy.api#documentation": "For geolocation resource record sets, the two-letter code for a country.
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
" } }, "SubdivisionCode": { @@ -5355,7 +5355,7 @@ "CountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
", + "smithy.api#documentation": "Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
", "smithy.api#httpQuery": "countrycode" } }, @@ -6060,7 +6060,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a specified traffic policy instance.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nGets information about a specified traffic policy instance.
\n\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nIn the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.
The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 100\n\t\t\titems. If you set MaxItems to a value greater than 100, Route 53 returns\n\t\t\tonly the first 100 health checks.
The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.
If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.
", "smithy.api#httpQuery": "delegationsetid" } + }, + "HostedZoneType": { + "target": "com.amazonaws.route53#HostedZoneType", + "traits": { + "smithy.api#documentation": "\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t
", + "smithy.api#httpQuery": "hostedzonetype" + } } }, "traits": { @@ -11317,7 +11335,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\nAfter you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\nThe data type of the additional data source that you specify for use in inference or\n training.
", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "The type of compression used for an additional data source used in inference or\n training. Specify None if your additional data source is not compressed.
A data source used for training or inference that is in addition to the input dataset\n or model data.
" + } + }, + "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { + "type": "enum", + "members": { + "S3OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + } + } + }, "com.amazonaws.sagemaker#AgentVersion": { "type": "structure", "members": { @@ -4293,7 +4332,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy.\n You can specify your batches as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker\n uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint\n is in service with a mix of the old and new endpoint configurations. For information about how to remedy\n this issue and restore the endpoint's status to InService, see\n Rolling Deployments.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to InService, see Rolling\n Deployments.
The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more\n information.
Specifies the location of ML model data to deploy. If specified, you must specify\n one and only one of the available data sources.
" + "smithy.api#documentation": "Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.
" } }, "com.amazonaws.sagemaker#ModelDeployConfig": { @@ -39568,6 +39607,12 @@ "traits": { "smithy.api#documentation": "The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.
The additional data source that is used during inference in the Docker container for\n your model package.
" + } } }, "traits": { @@ -42665,7 +42710,7 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#OutputCompressionType", "traits": { - "smithy.api#documentation": "The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
The model output compression type. Select None to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.
The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
", + "smithy.api#documentation": "The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.
", "smithy.api#required": {} } }, @@ -48787,7 +48838,7 @@ "RollbackMaximumBatchSize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new\n endpoint fleet. If this field is absent, the default value will be set to 100% of total\n capacity which means to bring up the whole capacity of the old fleet at once during rollback.
" + "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.
" } } }, @@ -48978,7 +49029,7 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#ModelCompressionType", "traits": { - "smithy.api#documentation": "Specifies how the ML model data is prepared.
\nIf you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.
If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri by\n slash (/), and use the last part as the filename of the file holding the content\n of the S3 object.
If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by S3Uri,\n SageMaker will trim its key by the prefix, and use the remainder as the path\n (relative to /opt/ml/model) of the file holding the content of the\n S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as\n directory names and the last part as filename of the file holding the content of\n the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example,\n if your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and s3://mybucket/model/weights/part1\n and you specify s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will result in name\n clash between /opt/ml/model/weights (a regular file) and\n /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in\n S3 console using folders.\n When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the\n folder name you provide. They key of the 0-byte object ends with a slash (/) which violates\n SageMaker restrictions on model artifact file names, leading to model deployment failure.\n
\nSpecifies how the ML model data is prepared.
\nIf you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.
If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.
If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by\n S3Uri, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to /opt/ml/model) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and\n s3://mybucket/model/weights/part1 and you specify\n s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will\n result in name clash between /opt/ml/model/weights (a regular file)\n and /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in S3 console using\n folders. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure.
\nThe ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.
The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.
A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.
" } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "The additional data source used during the training job.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json index 17bc5221df4..ba5b8987ae6 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json @@ -4877,6 +4877,297 @@ "smithy.api#documentation": "Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is\n only supported for HTTP APIs.
" } }, + "com.amazonaws.securityhub#AwsDmsEndpointDetails": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the \n replication instance.\n
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the endpoint database.
" + } + }, + "EndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the endpoint.\n
" + } + }, + "EndpointIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The database endpoint identifier.\n
" + } + }, + "EndpointType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The type of endpoint. Valid values are source and target.\n
" + } + }, + "EngineName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The type of engine for the endpoint, depending on the EndpointType value.\n
\n A value that can be used for cross-account validation.\n
" + } + }, + "ExtraConnectionAttributes": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n Additional attributes associated with the connection.\n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n An DMS key identifier that is used to encrypt the connection parameters for the endpoint.\n If you don't specify a value for the KmsKeyId parameter, then DMS uses your default \n encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your \n Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
\n The port used to access the endpoint.\n
" + } + }, + "ServerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the server where the endpoint database resides.
" + } + }, + "SslMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The SSL mode used to connect to the endpoint. The default is none.
" + } + }, + "Username": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The user name to be used to log in to the endpoint database.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data \n store type, and location information about your data store.\n
" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceDetails": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The amount of storage (in gigabytes) that is allocated for the replication instance.\n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance \n window.\n
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Availability Zone that the replication instance is created in. The default value is a random, system-chosen \n Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.
\n The engine version number of the replication instance. If an engine version number is not specified when a \n replication instance is created, the default is the latest engine version available.\n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n An KMS key identifier that is used to encrypt the data on the replication instance. If you don't \n specify a value for the KmsKeyId parameter, DMS uses your default encryption key. \n KMS creates the default encryption key for your Amazon Web Services account. Your \n Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
\n Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set the \n AvailabilityZone parameter if the MultiAZ parameter is set to true.
\n The maintenance window times for the replication instance. Upgrades to the replication instance are performed during \n this time.
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n Specifies the accessibility options for the replication instance. A value of true represents an instance \n with a public IP address. A value of false represents an instance with a private IP address. The default \n value is true.
\n The compute and memory capacity of the replication instance as defined for the specified replication instance class.
" + } + }, + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The replication instance identifier.
" + } + }, + "ReplicationSubnetGroup": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceReplicationSubnetGroupDetails", + "traits": { + "smithy.api#documentation": "\n The subnet group for the replication instance.
" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsList", + "traits": { + "smithy.api#documentation": "\n The virtual private cloud (VPC) security group for the replication instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about an Database Migration Service (DMS) replication instance. DMS uses a replication instance to connect to \n your source data store, read the source data, and format the data for consumption by the target data store.\n
" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceReplicationSubnetGroupDetails": { + "type": "structure", + "members": { + "ReplicationSubnetGroupIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The identifier of the replication subnet group.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about the replication subnet group.
" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsDetails": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The identifier of the VPC security group that’s associated with the replication instance.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about the virtual private cloud (VPC) security group that’s associated with the replication instance.
" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsDetails" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationTaskDetails": { + "type": "structure", + "members": { + "CdcStartPosition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or \n CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields \n is included.
\n Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime specifies \n when you want a CDC operation to start. Only a value for one of these fields is included.
\n Indicates when you want a CDC operation to stop. The value can be either server time or commit time.
" + } + }, + "MigrationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The migration type.\n
" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The identifier of the replication task.
" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n A display name for the resource identifier at the end of the EndpointArn response parameter. \n If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for \n the end of EndpointArn.
\n The Amazon Resource Name (ARN) of a replication instance.\n
" + } + }, + "ReplicationTaskIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The user-defined replication task identifier or name.
" + } + }, + "ReplicationTaskSettings": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The settings for the replication task.
" + } + }, + "SourceEndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ARN of the source endpoint.
" + } + }, + "TableMappings": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The table mappings for the replication task, in JSON format.
" + } + }, + "TargetEndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ARN of the target endpoint.
" + } + }, + "TaskData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n Supplemental information that the task requires to migrate the data for certain source and target endpoints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about an Database Migration Service (DMS) replication task. A replication task moves a set of data from the \n source endpoint to the target endpoint.
" + } + }, "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition": { "type": "structure", "members": { @@ -10015,6 +10306,12 @@ "traits": { "smithy.api#documentation": "The data volume definitions for the task.
" } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The status of the task definition.\n
" + } } }, "traits": { @@ -11797,55 +12094,251 @@ "smithy.api#documentation": "\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n
" } }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "com.amazonaws.securityhub#AwsEventsEndpointDetails": { "type": "structure", "members": { - "Status": { + "Arn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "\n Specifies whether CloudTrail is activated as a data source for the detector. \n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the endpoint.\n
" } - } - }, - "traits": { - "smithy.api#documentation": "\n An object that contains information on the status of CloudTrail as a data source for the detector. \n
" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { - "type": "structure", - "members": { - "CloudTrail": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "\n An object that contains information on the status of CloudTrail as a data source for the detector. \n
" + "smithy.api#documentation": "\n A description of the endpoint.\n
" } }, - "DnsLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "EndpointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "\n An object that contains information on the status of DNS logs as a data source for the detector.\n
" + "smithy.api#documentation": "\n The URL subdomain of the endpoint. For example, if EndpointUrl is \n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n
" + "smithy.api#documentation": "\n The URL of the endpoint.
" } }, - "Kubernetes": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "EventBuses": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointEventBusesList", "traits": { - "smithy.api#documentation": "\n An object that contains information on the status of Kubernetes data sources for the detector.\n
" + "smithy.api#documentation": "\n The event buses being used by the endpoint.
" } }, - "MalwareProtection": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "\n An object that contains information on the status of Malware Protection as a data source for the detector.\n
" + "smithy.api#documentation": "\n The name of the endpoint.
" } }, - "S3Logs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", + "ReplicationConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointReplicationConfigDetails", + "traits": { + "smithy.api#documentation": "\n Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED, which \n means you must supply a RoleArn. If you don't have a RoleArn or you don't want event \n replication enabled, set the state to DISABLED.
\n The ARN of the role used by event replication for the endpoint.
" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigDetails", + "traits": { + "smithy.api#documentation": "\n The routing configuration of the endpoint.
" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The current state of the endpoint.
" + } + }, + "StateReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The reason the endpoint is in its current state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s \n availability by making it Regional-fault tolerant.\n
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointEventBusesDetails": { + "type": "structure", + "members": { + "EventBusArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about the Amazon EventBridge event buses that the endpoint is associated with.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointEventBusesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointEventBusesDetails" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointReplicationConfigDetails": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The state of event replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Indicates whether replication is enabled or disabled for the endpoint. If enabled, the endpoint can replicate all \n events to a secondary Amazon Web Services Region.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigDetails": { + "type": "structure", + "members": { + "FailoverConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigDetails", + "traits": { + "smithy.api#documentation": "\n The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about the routing configuration of the endpoint.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigDetails": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails", + "traits": { + "smithy.api#documentation": "\n The main Region of the endpoint.
" + } + }, + "Secondary": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails", + "traits": { + "smithy.api#documentation": "\n The Region that events are routed to when failover is triggered or event replication is enabled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about the primary Amazon Web Services Region of the endpoint.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n Defines the secondary Region.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services Region that events are routed to when failover is triggered or event replication is enabled.
" + } + }, + "com.amazonaws.securityhub#AwsEventsEventbusDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the event bus.
" + } + }, + "Policy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The policy that enables the external account to send events to your account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about Amazon EventBridge event bus. An event bus is a router that receives events and delivers \n them to zero or more destinations, or targets. This can be a custom event bus which you can use to receive events \n from your custom applications and services, or it can be a partner event bus which can be matched to a partner event \n source.
" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n Specifies whether CloudTrail is activated as a data source for the detector. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of CloudTrail as a data source for the detector. \n
" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of CloudTrail as a data source for the detector. \n
" + } + }, + "DnsLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of DNS logs as a data source for the detector.\n
" + } + }, + "FlowLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n
" + } + }, + "Kubernetes": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of Kubernetes data sources for the detector.\n
" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information on the status of Malware Protection as a data source for the detector.\n
" + } + }, + "S3Logs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", "traits": { "smithy.api#documentation": "\n An object that contains information on the status of S3 Data event logs as a data source for the detector.\n
" } @@ -12982,178 +13475,398 @@ "PackageType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n
The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n
Details about an Lambda function's configuration.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "Environment variable key-value pairs.
" + } + }, + "Error": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "traits": { + "smithy.api#documentation": "An AwsLambdaFunctionEnvironmentError object.
A function's environment variable settings.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error messages for environment variables that could not be applied.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the function layer.
" + } + }, + "CodeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The size of the layer archive in bytes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Lambda layer.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The tracing mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The function's X-Ray tracing configuration.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "A list of VPC security groups IDs.
" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs.
" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a Lambda function.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version number.
" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "The layer's compatible runtimes. Maximum number of five items.
\nValid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n
Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Details about a Lambda layer version.
" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#AwsMountPoint": { + "type": "structure", + "members": { + "SourceVolume": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n
The path on the container to mount the host volume at.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details for a volume mount point that's used in a container definition.\n
" + } + }, + "com.amazonaws.securityhub#AwsMountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsMountPoint" + } + }, + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationDetails": { + "type": "structure", + "members": { + "Sasl": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslDetails", + "traits": { + "smithy.api#documentation": "\n Provides details for client authentication using SASL.
" + } + }, + "Unauthenticated": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails", + "traits": { + "smithy.api#documentation": "\n Provides details for allowing no client authentication.
" + } + }, + "Tls": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationTlsDetails", + "traits": { + "smithy.api#documentation": "\n Provides details for client authentication using TLS.
" } } }, "traits": { - "smithy.api#documentation": "Details about an Lambda function's configuration.
" + "smithy.api#documentation": "\n Provides details about different modes of client authentication.
" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslDetails": { "type": "structure", "members": { - "Variables": { - "target": "com.amazonaws.securityhub#FieldMap", + "Iam": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails", "traits": { - "smithy.api#documentation": "Environment variable key-value pairs.
" + "smithy.api#documentation": "\n Provides details for SASL client authentication using IAM.
" } }, - "Error": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "Scram": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails", "traits": { - "smithy.api#documentation": "An AwsLambdaFunctionEnvironmentError object.
\n Details for SASL client authentication using SCRAM.
" } } }, "traits": { - "smithy.api#documentation": "A function's environment variable settings.
" + "smithy.api#documentation": "\n Provides details for client authentication using SASL.
" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The error code.
" + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates whether SASL/IAM authentication is enabled or not.
" } - }, - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "\n Details for SASL/IAM client authentication.
" + } + }, + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The error message.
" + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates whether SASL/SCRAM authentication is enabled or not.
" } } }, "traits": { - "smithy.api#documentation": "Error messages for environment variables that could not be applied.
" + "smithy.api#documentation": "\n Details for SASL/SCRAM client authentication.
" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationTlsDetails": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CertificateAuthorityArnList": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "The ARN of the function layer.
" + "smithy.api#documentation": "\n List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web Services Private CA enables creation of \nprivate certificate authority (CA) hierarchies, including root and subordinate CAs, without the investment and maintenance costs \nof operating an on-premises CA.
" } }, - "CodeSize": { - "target": "com.amazonaws.securityhub#Integer", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The size of the layer archive in bytes.
" + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates whether TLS authentication is enabled or not.
" } } }, "traits": { - "smithy.api#documentation": "An Lambda layer.
" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + "smithy.api#documentation": "\n Provides details for client authentication using TLS.
" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails": { "type": "structure", "members": { - "Mode": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The tracing mode.
" + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates whether unauthenticated is allowed or not.
" } } }, "traits": { - "smithy.api#documentation": "The function's X-Ray tracing configuration.
" + "smithy.api#documentation": "\n Provides details for allowing no client authentication.\n
" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoDetails": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "EncryptionInfo": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoDetails", "traits": { - "smithy.api#documentation": "A list of VPC security groups IDs.
" + "smithy.api#documentation": "\n Includes encryption-related information, such as the KMS key used for encrypting data at rest and \nwhether you want Amazon MSK to encrypt your data in transit.
" } }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "CurrentVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "A list of VPC subnet IDs.
" + "smithy.api#documentation": "\n The current version of the MSK cluster.
" } }, - "VpcId": { + "NumberOfBrokerNodes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The number of broker nodes in the cluster.
" + } + }, + "ClusterName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The ID of the VPC.
" + "smithy.api#documentation": "\n The name of the cluster.
" + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationDetails", + "traits": { + "smithy.api#documentation": "\n Provides information for different modes of client authentication.
" } } }, "traits": { - "smithy.api#documentation": "The VPC security groups and subnets that are attached to a Lambda function.
" + "smithy.api#documentation": "\n Provide details about an Amazon MSK cluster.
" } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoDetails": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The version number.
" - } - }, - "CompatibleRuntimes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "EncryptionInTransit": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails", "traits": { - "smithy.api#documentation": "The layer's compatible runtimes. Maximum number of five items.
\nValid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n
\n The settings for encrypting data in transit.
" } }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "EncryptionAtRest": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails", "traits": { - "smithy.api#documentation": "Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
\n The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
" } } }, "traits": { - "smithy.api#documentation": "Details about a Lambda layer version.
" + "smithy.api#documentation": "\n Includes encryption-related information, such as the KMS key used for encrypting data at rest and \nwhether you want MSK to encrypt your data in transit.
" } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { - "type": "long", + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails": { + "type": "structure", + "members": { + "DataVolumeKMSKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a \nKMS key, MSK creates one for you and uses it.
" + } + } + }, "traits": { - "smithy.api#default": 0 + "smithy.api#documentation": "\n The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
" } }, - "com.amazonaws.securityhub#AwsMountPoint": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails": { "type": "structure", "members": { - "SourceVolume": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "InCluster": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n
\n When set to true, it indicates that data communication among the broker nodes of the cluster is \n encrypted. When set to false, the communication happens in plain text. The default value is \n true.
The path on the container to mount the host volume at.\n
" + "smithy.api#documentation": "\n Indicates the encryption setting for data in transit between clients and brokers.
" } } }, "traits": { - "smithy.api#documentation": "Details for a volume mount point that's used in a container definition.\n
" + "smithy.api#documentation": "\n The settings for encrypting data in transit.
" } }, - "com.amazonaws.securityhub#AwsMountPointList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsMountPoint" + "com.amazonaws.securityhub#AwsMskClusterDetails": { + "type": "structure", + "members": { + "ClusterInfo": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoDetails", + "traits": { + "smithy.api#documentation": "\n Provides information about a cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster. \n
" } }, "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { @@ -14039,6 +14752,13 @@ "smithy.api#default": false, "smithy.api#documentation": "Whether the mapping of IAM accounts to database accounts is enabled.
" } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n Indicates if minor version upgrades are automatically applied to the cluster.
" + } } }, "traits": { @@ -16218,6 +16938,124 @@ "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup" } }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneConfigDetails": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Any comments that you include about the hosted zone.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An object that contains an optional comment about your Amazon Route 53 hosted zone.
" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneDetails": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneObjectDetails", + "traits": { + "smithy.api#documentation": "\n An object that contains information about the specified hosted zone.
" + } + }, + "Vpcs": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcsList", + "traits": { + "smithy.api#documentation": "\n An object that contains information about the Amazon Virtual Private Clouds (Amazon VPCs) that are associated with \nthe specified hosted zone.
" + } + }, + "NameServers": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneNameServersList", + "traits": { + "smithy.api#documentation": "\n An object that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
" + } + }, + "QueryLoggingConfig": { + "target": "com.amazonaws.securityhub#AwsRoute53QueryLoggingConfigDetails", + "traits": { + "smithy.api#documentation": "\n An array that contains one QueryLoggingConfig element for each DNS query logging configuration that is \nassociated with the current Amazon Web Services account.
\n Provides details about a specified Amazon Route 53 hosted zone, including the four name servers assigned to \nthe hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent \ndomain name.
" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneNameServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneObjectDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ID that Route 53 assigns to the hosted zone when you create it.
" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
" + } + }, + "Config": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneConfigDetails", + "traits": { + "smithy.api#documentation": "\n An object that includes the Comment element.
\n An object that contains information about an Amazon Route 53 hosted zone.
" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The identifier of an Amazon VPC.\n
" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services Region that an Amazon VPC was created in.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n For private hosted zones, this is a complex type that contains information about an Amazon VPC.
" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcDetails" + } + }, + "com.amazonaws.securityhub#AwsRoute53QueryLoggingConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#CloudWatchLogsLogGroupArnConfigDetails", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about a specified Amazon Route 53 configuration for DNS query logging.
" + } + }, "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails": { "type": "structure", "members": { @@ -21030,6 +21868,32 @@ "smithy.api#documentation": "Provides details about the current status of the sensitive data detection.
" } }, + "com.amazonaws.securityhub#CloudWatchLogsLogGroupArnConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to.
" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ID of the hosted zone that CloudWatch Logs is logging queries for.
" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ID for a DNS query logging configuration.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs log group that Amazon Route 53 is \npublishing logs to.
" + } + }, "com.amazonaws.securityhub#CodeVulnerabilitiesFilePath": { "type": "structure", "members": { @@ -28189,6 +29053,48 @@ "traits": { "smithy.api#documentation": "\n Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, \n applications, or workloads. It also helps you set limits on data processing and track costs.\n
" } + }, + "AwsEventsEventbus": { + "target": "com.amazonaws.securityhub#AwsEventsEventbusDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events \nand delivers them to zero or more destinations, or targets.
" + } + }, + "AwsDmsEndpoint": { + "target": "com.amazonaws.securityhub#AwsDmsEndpointDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data \nstore type, and location information about your data store.
" + } + }, + "AwsEventsEndpoint": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s \navailability by making it Regional-fault tolerant.
" + } + }, + "AwsDmsReplicationTask": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationTaskDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an DMS replication task. A replication task moves a set of data from the source \nendpoint to the target endpoint.
" + } + }, + "AwsDmsReplicationInstance": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an DMS replication instance. DMS uses a replication instance to connect to your \nsource data store, read the source data, and format the data for consumption by the target data store.
" + } + }, + "AwsRoute53HostedZone": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted \nzone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.
" + } + }, + "AwsMskCluster": { + "target": "com.amazonaws.securityhub#AwsMskClusterDetails", + "traits": { + "smithy.api#documentation": "\n Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json b/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json index 067147d1b51..dfbfda5e9b3 100644 --- a/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json +++ b/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json @@ -890,7 +890,7 @@ "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { - "smithy.api#documentation": "The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.\n
" + "smithy.api#documentation": "The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.
\nFor Tape Gateway and Volume Gateway, the minimum value is 51200.
For S3 File Gateway and FSx File Gateway, the minimum value is\n 104857600.
Returns metadata about a gateway such as its name, network interfaces, configured time\n zone, and the state (whether the gateway is running or not). To specify which gateway to\n describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "smithy.api#documentation": "Returns metadata about a gateway such as its name, network interfaces, time zone,\n status, and software version. To specify which gateway to describe, use the Amazon Resource\n Name (ARN) of the gateway in your request.
", "smithy.api#examples": [ { "title": "To describe metadata about the gateway", @@ -3759,6 +3759,12 @@ "traits": { "smithy.api#documentation": "A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" } + }, + "SoftwareVersion": { + "target": "com.amazonaws.storagegateway#SoftwareVersion", + "traits": { + "smithy.api#documentation": "The version number of the software running on the gateway appliance.
" + } } }, "traits": { @@ -6211,7 +6217,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a file gateway to an Active Directory domain. This operation is only supported for\n file gateways that support the SMB file protocol.
" + "smithy.api#documentation": "Adds a file gateway to an Active Directory domain. This operation is only supported for\n file gateways that support the SMB file protocol.
\nJoining a domain creates an Active Directory computer account in the default\n organizational unit, using the gateway's Gateway ID as\n the account name (for example, SGW-1234ADE). If your Active Directory environment\n requires that you pre-stage accounts to facilitate the join domain process, you will\n need to create this account ahead of time.
\nTo create the gateway's computer account in an organizational unit other than the\n default, you must specify the organizational unit when joining the domain.
\nGets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling user account. This operation is only supported for S3\n File Gateways.
", + "smithy.api#documentation": "Gets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling Amazon Web Services account. This operation is only\n supported for S3 File Gateways.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -7386,7 +7392,8 @@ } }, "traits": { - "smithy.api#documentation": "Describes a gateway's network interface.
" + "smithy.api#documentation": "Describes a gateway's network interface.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#NetworkInterfaceId": { @@ -7441,7 +7448,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.
\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
\nFor more information, see Getting file upload notification in the Storage Gateway User\n Guide.
" + "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.
\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
\nFor more information, see Getting\n file upload notification in the Amazon S3 File Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -7700,7 +7707,7 @@ } ], "traits": { - "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
\nWait at least 60 seconds between consecutive RefreshCache API requests.
\nRefreshCache does not evict cache entries if invoked consecutively within 60\n seconds of a previous RefreshCache request.
\nIf you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n InvalidGatewayRequestException error because too many requests\n were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.
\nFor more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
" + "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
\nWait at least 60 seconds between consecutive RefreshCache API requests.
\nIf you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n InvalidGatewayRequestException error because too many requests\n were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.
\nFor more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -8076,7 +8083,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$" + "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\\S+)$" } }, "com.amazonaws.storagegateway#SMBFileShareInfo": { @@ -8514,6 +8521,9 @@ } } }, + "com.amazonaws.storagegateway#SoftwareVersion": { + "type": "string" + }, "com.amazonaws.storagegateway#Squash": { "type": "string", "traits": { @@ -10198,7 +10208,7 @@ "min": 50, "max": 500 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" + "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" } }, "com.amazonaws.storagegateway#TapeARNs": { @@ -10643,7 +10653,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not\n support bandwidth rate limits.
" + "smithy.api#documentation": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported for volume, tape, and S3 file gateways. S3 file gateways support\n bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate\n limits.
" } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput": { diff --git a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json index aae1322008e..381e997ce70 100644 --- a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json +++ b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json @@ -5779,7 +5779,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 4096 }, "smithy.api#pattern": "^[\\x09-\\x0D\\x20-\\x7E]*$" } @@ -5789,7 +5789,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 4096 }, "smithy.api#pattern": "^[\\x09-\\x0D\\x20-\\x7E]*$" } @@ -6385,7 +6385,7 @@ "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the key type is ssh-rsa.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the ssh-rsa.
For ECDSA keys, the ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
Create a review template.
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or\n other identifiable individuals in or via your review templates. If your review\n template or those shared with you and used in your account do include or collect PII\n you are responsible for: ensuring that the included PII is processed in accordance\n with applicable law, providing adequate privacy notices, and obtaining necessary\n consents for processing such data.
\nName of the review template.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#TemplateDescription", + "traits": { + "smithy.api#documentation": "The review template description.
", + "smithy.api#required": {} + } + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", + "traits": { + "smithy.api#documentation": "Lenses applied to the review template.
", + "smithy.api#required": {} + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the review template.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateReviewTemplateOutput": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateTemplateShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateTemplateShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateTemplateShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a review template share.
\nThe owner of a review template can share it with other Amazon Web Services accounts,\n users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.
\nShared access to a review template is not removed until the review template share\n invitation is deleted.
\nIf you share a review template with an organization or OU, all accounts in the\n organization or OU are granted access to the review template.
\n\n Disclaimer\n
\nBy sharing your review template with other Amazon Web Services accounts, you\n acknowledge that Amazon Web Services will make your review template available to\n those other accounts.
\nThe review template ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateTemplateShareOutput": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + }, + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wellarchitected#CreateWorkload": { "type": "operation", "input": { @@ -1551,7 +1736,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new workload.
\nThe owner of a workload can share the workload with other Amazon Web Services accounts, users,\n an organization, and organizational units (OUs) \n in the same Amazon Web Services Region. Only the owner of a workload can delete it.
\nFor more information, see Defining a Workload in the\n Well-Architected Tool User Guide.
\nEither AwsRegions, NonAwsRegions, or both must be specified when\n creating a workload.
You also must specify ReviewOwner, even though the\n parameter is listed as not being required in the following section.\n
Create a new workload.
\nThe owner of a workload can share the workload with other Amazon Web Services accounts, users,\n an organization, and organizational units (OUs) \n in the same Amazon Web Services Region. Only the owner of a workload can delete it.
\nFor more information, see Defining a Workload in the\n Well-Architected Tool User Guide.
\nEither AwsRegions, NonAwsRegions, or both must be specified when\n creating a workload.
You also must specify ReviewOwner, even though the\n parameter is listed as not being required in the following section.\n
When creating a workload using a review template, you must have the following IAM permissions:
\n\n wellarchitected:GetReviewTemplate\n
\n wellarchitected:GetReviewTemplateAnswer\n
\n wellarchitected:ListReviewTemplateAnswers\n
\n wellarchitected:GetReviewTemplateLensReview\n
The list of profile ARNs associated with the workload.
" } + }, + "ReviewTemplateArns": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateArns", + "traits": { + "smithy.api#documentation": "The list of review template ARNs to associate with the workload.
" + } } }, "traits": { @@ -2036,10 +2227,10 @@ "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DeleteWorkload": { + "com.amazonaws.wellarchitected#DeleteReviewTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + "target": "com.amazonaws.wellarchitected#DeleteReviewTemplateInput" }, "output": { "target": "smithy.api#Unit" @@ -2065,20 +2256,21 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing workload.
", + "smithy.api#documentation": "Delete a review template.
\nOnly the owner of a review template can delete it.
\nAfter the review template is deleted, Amazon Web Services accounts, users,\n organizations, and organizational units (OUs) that you shared the review template with\n will no longer be able to apply it to new workloads.
", "smithy.api#http": { "method": "DELETE", - "uri": "/workloads/{WorkloadId}", + "uri": "/reviewTemplates/{TemplateArn}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DeleteWorkloadInput": { + "com.amazonaws.wellarchitected#DeleteReviewTemplateInput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { + "smithy.api#documentation": "The review template ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2093,14 +2285,13 @@ } }, "traits": { - "smithy.api#documentation": "Input for workload deletion.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "com.amazonaws.wellarchitected#DeleteTemplateShare": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + "target": "com.amazonaws.wellarchitected#DeleteTemplateShareInput" }, "output": { "target": "smithy.api#Unit" @@ -2126,15 +2317,15 @@ } ], "traits": { - "smithy.api#documentation": "Delete a workload share.
", + "smithy.api#documentation": "Delete a review template share.
\nAfter the review template share is deleted, Amazon Web Services accounts, users,\n organizations, and organizational units (OUs) that you shared the review template with\n will no longer be able to apply it to new workloads.
", "smithy.api#http": { "method": "DELETE", - "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "uri": "/templates/shares/{TemplateArn}/{ShareId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "com.amazonaws.wellarchitected#DeleteTemplateShareInput": { "type": "structure", "members": { "ShareId": { @@ -2144,9 +2335,10 @@ "smithy.api#required": {} } }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { + "smithy.api#documentation": "The review template ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2161,37 +2353,13 @@ } }, "traits": { - "smithy.api#documentation": "Input for Delete Workload Share
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DifferenceStatus": { - "type": "enum", - "members": { - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.wellarchitected#DisassociateLenses": { + "com.amazonaws.wellarchitected#DeleteWorkload": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" }, "output": { "target": "smithy.api#Unit" @@ -2217,15 +2385,15 @@ } ], "traits": { - "smithy.api#documentation": "Disassociate a lens from a workload.
\nUp to 10 lenses can be disassociated from a workload in a single API operation.
\nThe Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.
Delete an existing workload.
", "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/disassociateLenses", + "method": "DELETE", + "uri": "/workloads/{WorkloadId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DisassociateLensesInput": { + "com.amazonaws.wellarchitected#DeleteWorkloadInput": { "type": "structure", "members": { "WorkloadId": { @@ -2235,22 +2403,24 @@ "smithy.api#required": {} } }, - "LensAliases": { - "target": "com.amazonaws.wellarchitected#LensAliases", + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Input to disassociate lens reviews.
", + "smithy.api#documentation": "Input for workload deletion.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DisassociateProfiles": { + "com.amazonaws.wellarchitected#DeleteWorkloadShare": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DisassociateProfilesInput" + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" }, "output": { "target": "smithy.api#Unit" @@ -2276,17 +2446,24 @@ } ], "traits": { - "smithy.api#documentation": "Disassociate a profile from a workload.
", + "smithy.api#documentation": "Delete a workload share.
", "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/disassociateProfiles", + "method": "DELETE", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DisassociateProfilesInput": { + "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { "type": "structure", "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { @@ -2294,34 +2471,177 @@ "smithy.api#required": {} } }, - "ProfileArns": { - "target": "com.amazonaws.wellarchitected#ProfileArns", + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { - "smithy.api#documentation": "The list of profile ARNs to disassociate from the workload.
", + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { + "smithy.api#documentation": "Input for Delete Workload Share
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { + "com.amazonaws.wellarchitected#DifferenceStatus": { "type": "enum", "members": { - "ENABLED": { + "UPDATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "UPDATED" } }, - "DISABLED": { + "NEW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "NEW" } - } - } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.wellarchitected#DisassociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociate a lens from a workload.
\nUp to 10 lenses can be disassociated from a workload in a single API operation.
\nThe Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.
Input to disassociate lens reviews.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DisassociateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateProfilesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociate a profile from a workload.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/disassociateProfiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DisassociateProfilesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#ProfileArns", + "traits": { + "smithy.api#documentation": "The list of profile ARNs to disassociate from the workload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } }, "com.amazonaws.wellarchitected#DisplayText": { "type": "string", @@ -3178,13 +3498,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#GetWorkload": { + "com.amazonaws.wellarchitected#GetReviewTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + "target": "com.amazonaws.wellarchitected#GetReviewTemplateInput" }, "output": { - "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + "target": "com.amazonaws.wellarchitected#GetReviewTemplateOutput" }, "errors": [ { @@ -3204,76 +3524,32 @@ } ], "traits": { - "smithy.api#documentation": "Get an existing workload.
", + "smithy.api#documentation": "Get review template.
", "smithy.api#http": { "method": "GET", - "uri": "/workloads/{WorkloadId}", + "uri": "/reviewTemplates/{TemplateArn}", "code": 200 } } }, - "com.amazonaws.wellarchitected#GetWorkloadInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Input to get a workload.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetWorkloadOutput": { - "type": "structure", - "members": { - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" - } - }, - "traits": { - "smithy.api#documentation": "Output of a get workload call.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#HelpfulResourceUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "The helpful resource URL.
\nFor Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
\nFor custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.
Import a new custom lens or update an existing custom lens.
\nTo update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.
\nA custom lens cannot exceed 500 KB in size.
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nGet review template answer.
", "smithy.api#http": { - "method": "PUT", - "uri": "/importLens", + "method": "GET", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#ImportLensInput": { + "com.amazonaws.wellarchitected#GetReviewTemplateAnswerInput": { "type": "structure", "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "JSONString": { - "target": "com.amazonaws.wellarchitected#LensJSON", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#documentation": "The JSON representation of a lens.
", + "smithy.api#documentation": "The review template ARN.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { - "smithy.api#idempotencyToken": {}, + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { - "smithy.api#documentation": "Tags to associate to a lens.
" + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -3321,19 +3596,22 @@ "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ImportLensOutput": { + "com.amazonaws.wellarchitected#GetReviewTemplateAnswerOutput": { "type": "structure", "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#documentation": "The ARN for the lens that was created or updated.
" + "smithy.api#documentation": "The review template ARN.
" } }, - "Status": { - "target": "com.amazonaws.wellarchitected#ImportLensStatus", + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswer", "traits": { - "smithy.api#documentation": "The status of the imported lens.
" + "smithy.api#documentation": "An answer of the question.
" } } }, @@ -3341,174 +3619,444 @@ "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ImportLensStatus": { - "type": "enum", + "com.amazonaws.wellarchitected#GetReviewTemplateInput": { + "type": "structure", "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#enumValue": "ERROR" + "smithy.api#documentation": "The review template ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ImprovementPlanUrl": { - "type": "string", + "com.amazonaws.wellarchitected#GetReviewTemplateLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "The improvement plan URL for a question in an Amazon Web Services official lenses.
\nThis value is only available if the question has been answered.
\nThis value does not apply to custom lenses.
", - "smithy.api#length": { - "min": 1, - "max": 2048 + "smithy.api#documentation": "Get a lens review associated with a review template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}", + "code": 200 } } }, - "com.amazonaws.wellarchitected#ImprovementSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ImprovementSummary" + "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewInput": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } }, "traits": { - "smithy.api#documentation": "List of improvement summaries of lens review in a workload.
" + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ImprovementSummary": { + "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewOutput": { "type": "structure", "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "QuestionTitle": { - "target": "com.amazonaws.wellarchitected#QuestionTitle" - }, - "Risk": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "ImprovementPlanUrl": { - "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } }, - "ImprovementPlans": { - "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", + "LensReview": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLensReview", "traits": { - "smithy.api#documentation": "The improvement plan details.
" + "smithy.api#documentation": "A lens review of a question.
" } } }, "traits": { - "smithy.api#documentation": "An improvement summary of a lens review in a workload.
" + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#IncludeSharedResources": { - "type": "boolean", + "com.amazonaws.wellarchitected#GetReviewTemplateOutput": { + "type": "structure", + "members": { + "ReviewTemplate": { + "target": "com.amazonaws.wellarchitected#ReviewTemplate", + "traits": { + "smithy.api#documentation": "The review template.
" + } + } + }, "traits": { - "smithy.api#default": false + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#InternalServerException": { + "com.amazonaws.wellarchitected#GetWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an existing workload.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetWorkloadInput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "There is a problem with the Well-Architected Tool API service.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "Input to get a workload.
", + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#IsApplicable": { - "type": "boolean", + "com.amazonaws.wellarchitected#GetWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Defines whether this question is applicable to a lens review.
" + "smithy.api#documentation": "Output of a get workload call.
", + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#IsMajorVersion": { - "type": "boolean", + "com.amazonaws.wellarchitected#HelpfulResourceUrl": { + "type": "string", "traits": { - "smithy.api#default": false + "smithy.api#documentation": "The helpful resource URL.
\nFor Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
\nFor custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.
Import a new custom lens or update an existing custom lens.
\nTo update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.
\nA custom lens cannot exceed 500 KB in size.
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nThe ARN of a lens.
" - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "The version of a lens.
" - } - }, - "Name": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "Description": { - "target": "com.amazonaws.wellarchitected#LensDescription" + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" }, - "Owner": { - "target": "com.amazonaws.wellarchitected#LensOwner", + "JSONString": { + "target": "com.amazonaws.wellarchitected#LensJSON", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID that owns the lens.
" + "smithy.api#documentation": "The JSON representation of a lens.
", + "smithy.api#required": {} } }, - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { - "smithy.api#documentation": "The ID assigned to the share invitation.
" + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { - "smithy.api#documentation": "The tags assigned to the lens.
" + "smithy.api#documentation": "Tags to associate to a lens.
" } } }, "traits": { - "smithy.api#documentation": "A lens return object.
" + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#LensAlias": { - "type": "string", - "traits": { - "smithy.api#documentation": "The alias of the lens.
\nFor Amazon Web Services official lenses, this is either the lens alias, such as\n serverless, or the lens ARN, such as\n arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some\n operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as\n arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.
Each lens is identified by its LensSummary$LensAlias.
", - "smithy.api#length": { - "min": 1, - "max": 128 + "com.amazonaws.wellarchitected#ImportLensOutput": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens that was created or updated.
" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ImportLensStatus", + "traits": { + "smithy.api#documentation": "The status of the imported lens.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#LensAliases": { - "type": "list", + "com.amazonaws.wellarchitected#ImportLensStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.wellarchitected#ImprovementPlanUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "The improvement plan URL for a question in an Amazon Web Services official lenses.
\nThis value is only available if the question has been answered.
\nThis value does not apply to custom lenses.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ImprovementSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ImprovementSummary" + }, + "traits": { + "smithy.api#documentation": "List of improvement summaries of lens review in a workload.
" + } + }, + "com.amazonaws.wellarchitected#ImprovementSummary": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "ImprovementPlans": { + "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", + "traits": { + "smithy.api#documentation": "The improvement plan details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An improvement summary of a lens review in a workload.
" + } + }, + "com.amazonaws.wellarchitected#IncludeSharedResources": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "There is a problem with the Well-Architected Tool API service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.wellarchitected#IsApplicable": { + "type": "boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Defines whether this question is applicable to a lens review.
" + } + }, + "com.amazonaws.wellarchitected#IsMajorVersion": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#Lens": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN of a lens.
" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The version of a lens.
" + } + }, + "Name": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#LensOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the lens.
" + } + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the share invitation.
" + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the lens.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A lens return object.
" + } + }, + "com.amazonaws.wellarchitected#LensAlias": { + "type": "string", + "traits": { + "smithy.api#documentation": "The alias of the lens.
\nFor Amazon Web Services official lenses, this is either the lens alias, such as\n serverless, or the lens ARN, such as\n arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some\n operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as\n arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.
Each lens is identified by its LensSummary$LensAlias.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#LensAliases": { + "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, @@ -3922,6 +4470,15 @@ "traits": { "smithy.api#documentation": "The latest version of the lens.
" } + }, + "ResourceArn": { + "target": "com.amazonaws.wellarchitected#ResourceArn", + "traits": { + "smithy.api#documentation": "\n ResourceArn of the lens being upgraded
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.
", "smithy.api#httpQuery": "SharedWithPrefix" } }, @@ -4857,6 +5414,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return for this request.
" } + }, + "ResourceArn": { + "target": "com.amazonaws.wellarchitected#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN for the related resource for the notification.
\nOnly one of WorkloadID or ResourceARN should be specified.
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
", "smithy.api#httpQuery": "SharedWithPrefix" } }, @@ -5121,7 +5684,7 @@ "ProfileNamePrefix": { "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", "traits": { - "smithy.api#documentation": "Prefix for profile name.
", + "smithy.api#documentation": "An optional string added to the beginning of each profile name returned in the\n results.
", "smithy.api#httpQuery": "ProfileNamePrefix" } }, @@ -5167,13 +5730,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListShareInvitations": { + "com.amazonaws.wellarchitected#ListReviewTemplateAnswers": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" + "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswersInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" + "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswersOutput" }, "errors": [ { @@ -5182,6 +5745,9 @@ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, @@ -5190,10 +5756,10 @@ } ], "traits": { - "smithy.api#documentation": "List the workload invitations.
", + "smithy.api#documentation": "List the answers of a review template.
", "smithy.api#http": { "method": "GET", - "uri": "/shareInvitations", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers", "code": 200 }, "smithy.api#paginated": { @@ -5203,27 +5769,28 @@ } } }, - "com.amazonaws.wellarchitected#ListShareInvitationsInput": { + "com.amazonaws.wellarchitected#ListReviewTemplateAnswersInput": { "type": "structure", "members": { - "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#httpQuery": "WorkloadNamePrefix" + "smithy.api#documentation": "The ARN of the review template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "LensNamePrefix": { - "target": "com.amazonaws.wellarchitected#LensNamePrefix", + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { - "smithy.api#documentation": "An optional string added to the beginning of each lens name returned in the results.
", - "smithy.api#httpQuery": "LensNamePrefix" + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", "traits": { - "smithy.api#documentation": "The type of share invitations to be returned.
", - "smithy.api#httpQuery": "ShareResourceType" + "smithy.api#httpQuery": "PillarId" } }, "NextToken": { @@ -5233,27 +5800,19 @@ } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", + "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswersMaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return for this request.
", "smithy.api#httpQuery": "MaxResults" } - }, - "ProfileNamePrefix": { - "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", - "traits": { - "smithy.api#documentation": "Profile name prefix.
", - "smithy.api#httpQuery": "ProfileNamePrefix" - } } }, "traits": { - "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { + "com.amazonaws.wellarchitected#ListReviewTemplateAnswersMaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, @@ -5263,13 +5822,22 @@ } } }, - "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { + "com.amazonaws.wellarchitected#ListReviewTemplateAnswersOutput": { "type": "structure", "members": { - "ShareInvitationSummaries": { - "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#documentation": "List of share invitation summaries in a workload.
" + "smithy.api#documentation": "The ARN of the review template.
" + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "AnswerSummaries": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummaries", + "traits": { + "smithy.api#documentation": "List of answer summaries of a lens review in a review template.
" } }, "NextToken": { @@ -5277,71 +5845,90 @@ } }, "traits": { - "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListTagsForResource": { + "com.amazonaws.wellarchitected#ListReviewTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" + "target": "com.amazonaws.wellarchitected#ListReviewTemplatesInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" + "target": "com.amazonaws.wellarchitected#ListReviewTemplatesOutput" }, "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { - "smithy.api#documentation": "List the tags for a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nList review templates.
", "smithy.api#http": { "method": "GET", - "uri": "/tags/{WorkloadArn}", + "uri": "/reviewTemplates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" } } }, - "com.amazonaws.wellarchitected#ListTagsForResourceInput": { + "com.amazonaws.wellarchitected#ListReviewTemplatesInput": { "type": "structure", "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#httpQuery": "NextToken" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListTagsForResourceOutput": { + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListReviewTemplatesOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", + "ReviewTemplates": { + "target": "com.amazonaws.wellarchitected#ReviewTemplates", "traits": { - "smithy.api#documentation": "The tags for the resource.
" + "smithy.api#documentation": "List of review templates.
" } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadShares": { + "com.amazonaws.wellarchitected#ListShareInvitations": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" }, "errors": [ { @@ -5350,9 +5937,6 @@ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, @@ -5361,10 +5945,10 @@ } ], "traits": { - "smithy.api#documentation": "List the workload shares associated with the workload.
", + "smithy.api#documentation": "List the share invitations.
\n\n WorkloadNamePrefix, LensNamePrefix,\n ProfileNamePrefix, and TemplateNamePrefix are mutually\n exclusive. Use the parameter that matches your ShareResourceType.
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
", - "smithy.api#httpQuery": "SharedWithPrefix" + "smithy.api#documentation": "An optional string added to the beginning of each lens name returned in the results.
", + "smithy.api#httpQuery": "LensNamePrefix" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The type of share invitations to be returned.
", + "smithy.api#httpQuery": "ShareResourceType" } }, "NextToken": { @@ -5398,26 +5988,34 @@ } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return for this request.
", "smithy.api#httpQuery": "MaxResults" } }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus", + "ProfileNamePrefix": { + "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", "traits": { - "smithy.api#httpQuery": "Status" + "smithy.api#documentation": "An optional string added to the beginning of each profile name returned in the\n results.
", + "smithy.api#httpQuery": "ProfileNamePrefix" + } + }, + "TemplateNamePrefix": { + "target": "com.amazonaws.wellarchitected#TemplateNamePrefix", + "traits": { + "smithy.api#documentation": "An optional string added to the beginning of each review template name returned in the\n results.
", + "smithy.api#httpQuery": "TemplateNamePrefix" } } }, "traits": { - "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, @@ -5427,31 +6025,85 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadShareSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + "ShareInvitationSummaries": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "traits": { + "smithy.api#documentation": "List of share invitation summaries in a workload.
" + } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { - "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListWorkloads": { + "com.amazonaws.wellarchitected#ListTagsForResource": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "List the tags for a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
\nThe tags for the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListTemplateShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListTemplateSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListTemplateSharesOutput" }, "errors": [ { @@ -5460,6 +6112,9 @@ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, @@ -5468,10 +6123,10 @@ } ], "traits": { - "smithy.api#documentation": "Paginated list of workloads.
", + "smithy.api#documentation": "List review template shares.
", "smithy.api#http": { - "method": "POST", - "uri": "/workloadsSummaries", + "method": "GET", + "uri": "/templates/shares/{TemplateArn}", "code": 200 }, "smithy.api#paginated": { @@ -5481,29 +6136,50 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "com.amazonaws.wellarchitected#ListTemplateSharesInput": { "type": "structure", "members": { - "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID, organization ID, or organizational unit\n (OU) ID with which the profile is shared.
", + "smithy.api#httpQuery": "SharedWithPrefix" + } }, "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "target": "com.amazonaws.wellarchitected#ListTemplateSharesMaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for this request.
" + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" } } }, "traits": { - "smithy.api#documentation": "Input to list all workloads.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "com.amazonaws.wellarchitected#ListTemplateSharesMaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, @@ -5513,62 +6189,263 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "com.amazonaws.wellarchitected#ListTemplateSharesOutput": { "type": "structure", "members": { - "WorkloadSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + }, + "TemplateShareSummaries": { + "target": "com.amazonaws.wellarchitected#TemplateShareSummaries", + "traits": { + "smithy.api#documentation": "A review template share summary return object.
" + } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { - "smithy.api#documentation": "Output of a list workloads call.
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for this request.
", - "smithy.api#range": { - "min": 1, - "max": 50 + "com.amazonaws.wellarchitected#ListWorkloadShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" } - } - }, - "com.amazonaws.wellarchitected#MaxSelectedProfileChoices": { - "type": "integer", + ], "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wellarchitected#MetricType": { - "type": "enum", - "members": { - "WORKLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKLOAD" - } + "smithy.api#documentation": "List the workload shares associated with the workload.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" } } }, - "com.amazonaws.wellarchitected#Milestone": { + "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { "type": "structure", "members": { - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { - "smithy.api#default": 0 + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "MilestoneName": { + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.
", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShareSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloads": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Paginated list of workloads.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workloadsSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input to list all workloads.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "type": "structure", + "members": { + "WorkloadSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "Output of a list workloads call.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#MaxSelectedProfileChoices": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#MetricType": { + "type": "enum", + "members": { + "WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD" + } + } + } + }, + "com.amazonaws.wellarchitected#Milestone": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "RecordedAt": { @@ -5653,7 +6530,7 @@ "com.amazonaws.wellarchitected#Notes": { "type": "string", "traits": { - "smithy.api#documentation": "The notes associated with the workload.
", + "smithy.api#documentation": "The notes associated with the workload.
\nFor a review template, these are the notes that will be associated with the workload when the template is applied.
", "smithy.api#length": { "min": 0, "max": 2084 @@ -5827,7 +6704,7 @@ "target": "com.amazonaws.wellarchitected#Notes" }, "traits": { - "smithy.api#documentation": "List of pillar notes of a lens review in a workload.
" + "smithy.api#documentation": "List of pillar notes of a lens review in a workload.
\nFor a review template, these are the notes that will be associated with the workload when the template is applied.
" } }, "com.amazonaws.wellarchitected#PillarReviewSummaries": { @@ -6323,6 +7200,32 @@ "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, + "com.amazonaws.wellarchitected#Question": { + "type": "enum", + "members": { + "UNANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNANSWERED" + } + }, + "ANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWERED" + } + } + } + }, + "com.amazonaws.wellarchitected#QuestionCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#Question" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Count" + } + }, "com.amazonaws.wellarchitected#QuestionDescription": { "type": "string", "traits": { @@ -6462,6 +7365,16 @@ } } }, + "com.amazonaws.wellarchitected#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 250 + }, + "smithy.api#pattern": "^arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}$" + } + }, "com.amazonaws.wellarchitected#ResourceNotFoundException": { "type": "structure", "members": { @@ -6490,433 +7403,1202 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.wellarchitected#Risk": { - "type": "enum", + "com.amazonaws.wellarchitected#ReviewTemplate": { + "type": "structure", "members": { - "UNANSWERED": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.wellarchitected#TemplateDescription", "traits": { - "smithy.api#enumValue": "UNANSWERED" + "smithy.api#documentation": "The review template description.
" } }, - "HIGH": { - "target": "smithy.api#Unit", + "Lenses": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", "traits": { - "smithy.api#enumValue": "HIGH" + "smithy.api#documentation": "The lenses applied to the review template.
" } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "QuestionCounts": { + "target": "com.amazonaws.wellarchitected#QuestionCounts", "traits": { - "smithy.api#enumValue": "MEDIUM" + "smithy.api#documentation": "A count of how many total questions are answered and unanswered in the review template.
" } }, - "NONE": { - "target": "smithy.api#Unit", + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#documentation": "The review template ARN.
" } }, - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", + "TemplateName": { + "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" + "smithy.api#documentation": "The name of the review template.
" + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the review template.
" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus", + "traits": { + "smithy.api#documentation": "The latest status of a review template.
" + } + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the template share invitation.
" } } }, "traits": { - "smithy.api#documentation": "The risk for a given workload, lens review, pillar, or question.
" + "smithy.api#documentation": "A review template.
" } }, - "com.amazonaws.wellarchitected#RiskCounts": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "value": { - "target": "com.amazonaws.wellarchitected#Count" - }, - "traits": { - "smithy.api#documentation": "A map from risk names to the count of how many questions have that rating.
" - } - }, - "com.amazonaws.wellarchitected#SelectedChoiceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - } - }, - "com.amazonaws.wellarchitected#SelectedChoices": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "traits": { - "smithy.api#documentation": "List of selected choice IDs in a question answer.
\nThe values entered replace the previously selected choices.
" - } - }, - "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - } - }, - "com.amazonaws.wellarchitected#ServiceCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service.
" - } - }, - "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { + "com.amazonaws.wellarchitected#ReviewTemplateAnswer": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" }, - "ResourceId": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceId" + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" }, - "ResourceType": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceType" + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" }, - "QuotaCode": { - "target": "com.amazonaws.wellarchitected#QuotaCode", - "traits": { - "smithy.api#required": {} - } + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" }, - "ServiceCode": { - "target": "com.amazonaws.wellarchitected#ServiceCode", + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "HelpfulResourceUrl": { + "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" + }, + "HelpfulResourceDisplayText": { + "target": "com.amazonaws.wellarchitected#DisplayText", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "The helpful resource text to be displayed for a custom lens.
\nThis field does not apply to Amazon Web Services official lenses.
\nThe user has reached their resource quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.wellarchitected#ShareId": { - "type": "string", - "traits": { - "smithy.api#documentation": "The ID associated with the share.
", - "smithy.api#pattern": "^[0-9a-f]{32}$" - } - }, - "com.amazonaws.wellarchitected#ShareInvitation": { - "type": "structure", - "members": { - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", + }, + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceAnswers": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswers", "traits": { - "smithy.api#documentation": "The ID assigned to the share invitation.
" + "smithy.api#documentation": "A list of selected choices to a question in your review template.
" } }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", "traits": { - "smithy.api#documentation": "The resource type of the share invitation.
" + "smithy.api#default": false } }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", + "AnswerStatus": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus", "traits": { - "smithy.api#documentation": "The ARN for the lens.
" + "smithy.api#documentation": "The status of whether or not this question has been answered.
" } }, - "ProfileArn": { - "target": "com.amazonaws.wellarchitected#ProfileArn", + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { - "smithy.api#documentation": "The profile ARN.
" + "smithy.api#documentation": "The reason why the question is not applicable to your review template.
" } } }, "traits": { - "smithy.api#documentation": "The share invitation.
" + "smithy.api#documentation": "An answer of the question.
" } }, - "com.amazonaws.wellarchitected#ShareInvitationAction": { + "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus": { "type": "enum", "members": { - "ACCEPT": { + "UNANSWERED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ACCEPT" + "smithy.api#enumValue": "UNANSWERED" } }, - "REJECT": { + "ANSWERED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "REJECT" + "smithy.api#enumValue": "ANSWERED" } } - }, - "traits": { - "smithy.api#documentation": "Share invitation action taken by contributor.
" - } - }, - "com.amazonaws.wellarchitected#ShareInvitationId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-f]{32}$" } }, - "com.amazonaws.wellarchitected#ShareInvitationSummaries": { + "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummaries": { "type": "list", "member": { - "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummary" } }, - "com.amazonaws.wellarchitected#ShareInvitationSummary": { + "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummary": { "type": "structure", "members": { - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "The ID assigned to the share invitation.
" - } + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" }, - "SharedBy": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith" + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType" + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceAnswerSummaries": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummaries", "traits": { - "smithy.api#documentation": "The resource type of the share invitation.
" + "smithy.api#documentation": "A list of selected choices to a question in the review template.
" } }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", + "traits": { + "smithy.api#default": false + } }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", + "AnswerStatus": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus", "traits": { - "smithy.api#documentation": "The ARN for the lens.
" + "smithy.api#documentation": "The status of whether or not this question has been answered.
" } }, - "ProfileName": { - "target": "com.amazonaws.wellarchitected#ProfileName", + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { - "smithy.api#documentation": "The profile name.
" + "smithy.api#documentation": "The reason why a choice is not-applicable to a question in the review template.
" } }, - "ProfileArn": { - "target": "com.amazonaws.wellarchitected#ProfileArn", + "QuestionType": { + "target": "com.amazonaws.wellarchitected#QuestionType", "traits": { - "smithy.api#documentation": "The profile ARN.
" + "smithy.api#documentation": "The type of question.
" } } }, "traits": { - "smithy.api#documentation": "A share invitation summary return object.
" + "smithy.api#documentation": "The summary of review template answers.
" } }, - "com.amazonaws.wellarchitected#ShareResourceType": { - "type": "enum", - "members": { - "WORKLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKLOAD" - } - }, - "LENS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENS" - } - }, - "PROFILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROFILE" - } + "com.amazonaws.wellarchitected#ReviewTemplateArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#TemplateArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 } } }, - "com.amazonaws.wellarchitected#ShareStatus": { - "type": "enum", + "com.amazonaws.wellarchitected#ReviewTemplateLensAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.wellarchitected#ReviewTemplateLensReview": { + "type": "structure", "members": { - "ACCEPTED": { - "target": "smithy.api#Unit", + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", "traits": { - "smithy.api#enumValue": "ACCEPTED" + "smithy.api#documentation": "The lens ARN.
" } }, - "REJECTED": { - "target": "smithy.api#Unit", + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { - "smithy.api#enumValue": "REJECTED" + "smithy.api#documentation": "The version of the lens.
" } }, - "PENDING": { + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "The status of the lens.
" + } + }, + "PillarReviewSummaries": { + "target": "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummaries", + "traits": { + "smithy.api#documentation": "Pillar review summaries of a lens review.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "QuestionCounts": { + "target": "com.amazonaws.wellarchitected#QuestionCounts", + "traits": { + "smithy.api#documentation": "A count of how many questions are answered and unanswered in the lens review.
" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "The lens review of a review template.
" + } + }, + "com.amazonaws.wellarchitected#ReviewTemplateLenses": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + } + }, + "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummary" + } + }, + "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummary": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "QuestionCounts": { + "target": "com.amazonaws.wellarchitected#QuestionCounts", + "traits": { + "smithy.api#documentation": "A count of how many questions are answered and unanswered in the requested pillar of the lens review.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a review template.
" + } + }, + "com.amazonaws.wellarchitected#ReviewTemplateSummary": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.wellarchitected#TemplateDescription", + "traits": { + "smithy.api#documentation": "Description of the review template.
" + } + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", + "traits": { + "smithy.api#documentation": "Lenses associated with the review template.
" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + }, + "TemplateName": { + "target": "com.amazonaws.wellarchitected#TemplateName", + "traits": { + "smithy.api#documentation": "The name of the review template.
" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus", + "traits": { + "smithy.api#documentation": "The latest status of a review template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a review template.
" + } + }, + "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus": { + "type": "enum", + "members": { + "CURRENT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PENDING" + "smithy.api#enumValue": "CURRENT" } }, - "REVOKED": { + "LENS_NOT_CURRENT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "REVOKED" + "smithy.api#enumValue": "LENS_NOT_CURRENT" + } + } + } + }, + "com.amazonaws.wellarchitected#ReviewTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateSummary" + } + }, + "com.amazonaws.wellarchitected#Risk": { + "type": "enum", + "members": { + "UNANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNANSWERED" } }, - "EXPIRED": { + "HIGH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXPIRED" + "smithy.api#enumValue": "HIGH" } }, - "ASSOCIATING": { + "MEDIUM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ASSOCIATING" + "smithy.api#enumValue": "MEDIUM" } }, - "ASSOCIATED": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ASSOCIATED" + "smithy.api#enumValue": "NONE" } }, - "FAILED": { + "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#enumValue": "NOT_APPLICABLE" } } }, "traits": { - "smithy.api#documentation": "The status of the share request.
" + "smithy.api#documentation": "The risk for a given workload, lens review, pillar, or question.
" } }, - "com.amazonaws.wellarchitected#SharedWith": { - "type": "string", + "com.amazonaws.wellarchitected#RiskCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Count" + }, "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
", - "smithy.api#length": { - "min": 12, - "max": 2048 - } + "smithy.api#documentation": "A map from risk names to the count of how many questions have that rating.
" } }, - "com.amazonaws.wellarchitected#SharedWithPrefix": { - "type": "string", + "com.amazonaws.wellarchitected#SelectedChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } + }, + "com.amazonaws.wellarchitected#SelectedChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } + "smithy.api#documentation": "List of selected choice IDs in a question answer.
\nThe values entered replace the previously selected choices.
" } }, - "com.amazonaws.wellarchitected#StatusMessage": { + "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } + }, + "com.amazonaws.wellarchitected#ServiceCode": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 + "smithy.api#documentation": "Service Quotas requirement to identify originating service.
" + } + }, + "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId" + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType" + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode", + "traits": { + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode", + "traits": { + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "The user has reached their resource quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 } }, - "com.amazonaws.wellarchitected#TagKey": { + "com.amazonaws.wellarchitected#ShareId": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } + "smithy.api#documentation": "The ID associated with the share.
", + "smithy.api#pattern": "^[0-9a-f]{32}$" } }, - "com.amazonaws.wellarchitected#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#TagKey" + "com.amazonaws.wellarchitected#ShareInvitation": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the share invitation.
" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the share invitation.
" + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 + "smithy.api#documentation": "The share invitation.
" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationAction": { + "type": "enum", + "members": { + "ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + } + }, + "traits": { + "smithy.api#documentation": "Share invitation action taken by contributor.
" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{32}$" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationSummary": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the share invitation.
" + } + }, + "SharedBy": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the share invitation.
" + } + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The profile name.
" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "TemplateName": { + "target": "com.amazonaws.wellarchitected#TemplateName", + "traits": { + "smithy.api#documentation": "The name of the review template.
" + } + }, + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A share invitation summary return object.
" + } + }, + "com.amazonaws.wellarchitected#ShareResourceType": { + "type": "enum", + "members": { + "WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD" + } + }, + "LENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + }, + "TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPLATE" + } + } + } + }, + "com.amazonaws.wellarchitected#ShareStatus": { + "type": "enum", + "members": { + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPTED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATING" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the share request.
" + } + }, + "com.amazonaws.wellarchitected#SharedWith": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which \n the workload, lens, profile, or review template is shared.
", + "smithy.api#length": { + "min": 12, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#SharedWithPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#StatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.wellarchitected#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#TagKey" + }, + "value": { + "target": "com.amazonaws.wellarchitected#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds one or more tags to the specified resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
\nThe tags for the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.wellarchitected#TemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 250 + }, + "smithy.api#pattern": "^arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}$" + } + }, + "com.amazonaws.wellarchitected#TemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 250 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#TemplateNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#TemplateQuestions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestion" + } + }, + "com.amazonaws.wellarchitected#TemplateShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#TemplateShareSummary" + } + }, + "com.amazonaws.wellarchitected#TemplateShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "Review template share invitation status message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a review template share.
" + } + }, + "com.amazonaws.wellarchitected#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode" + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode" + } + }, + "traits": { + "smithy.api#documentation": "Request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.wellarchitected#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "The date and time recorded.
" + } + }, + "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.wellarchitected#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes specified tags from a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
\nTo specify multiple tags, use separate tagKeys parameters, for example:
\n\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n
A list of tag keys. Existing tags of the resource \n whose keys are members of this list are removed from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#UpdateAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the answer to a specific question in a workload review.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateAnswerInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceUpdates": { + "target": "com.amazonaws.wellarchitected#ChoiceUpdates", + "traits": { + "smithy.api#documentation": "A list of choices to update on a question in your workload. The String key \n corresponds to the choice ID to be updated.
" + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", + "traits": { + "smithy.api#default": false + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", + "traits": { + "smithy.api#documentation": "The reason why a question is not applicable to your workload.
" + } } + }, + "traits": { + "smithy.api#documentation": "Input to update answer.
", + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#TagKey" - }, - "value": { - "target": "com.amazonaws.wellarchitected#TagValue" + "com.amazonaws.wellarchitected#UpdateAnswerOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#Answer" + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } + "smithy.api#documentation": "Output of a update answer call.
", + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#TagResource": { + "com.amazonaws.wellarchitected#UpdateGlobalSettings": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#TagResourceInput" + "target": "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput" }, "output": { - "target": "com.amazonaws.wellarchitected#TagResourceOutput" + "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { - "smithy.api#documentation": "Adds one or more tags to the specified resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nUpdates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
", "smithy.api#http": { - "method": "POST", - "uri": "/tags/{WorkloadArn}", + "method": "PATCH", + "uri": "/global-settings", "code": 200 } } }, - "com.amazonaws.wellarchitected#TagResourceInput": { + "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput": { "type": "structure", "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", + "OrganizationSharingStatus": { + "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The status of organization sharing settings.
" } }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", + "DiscoveryIntegrationStatus": { + "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", "traits": { - "smithy.api#documentation": "The tags for the resource.
", - "smithy.api#required": {} + "smithy.api#documentation": "The status of discovery support settings.
" } } }, @@ -6924,114 +8606,145 @@ "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#TagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#TagValue": { - "type": "string", + "com.amazonaws.wellarchitected#UpdateLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 + "smithy.api#documentation": "Update lens review for a particular workload.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "code": 200 } } }, - "com.amazonaws.wellarchitected#TemplateQuestions": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestion" - } - }, - "com.amazonaws.wellarchitected#ThrottlingException": { + "com.amazonaws.wellarchitected#UpdateLensReviewInput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "QuotaCode": { - "target": "com.amazonaws.wellarchitected#QuotaCode" + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "ServiceCode": { - "target": "com.amazonaws.wellarchitected#ServiceCode" + "LensNotes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "PillarNotes": { + "target": "com.amazonaws.wellarchitected#PillarNotes" } }, "traits": { - "smithy.api#documentation": "Request was denied due to request throttling.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.wellarchitected#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#documentation": "The date and time recorded.
" + "smithy.api#documentation": "Input for update lens review.
", + "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus": { - "type": "enum", + "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { + "type": "structure", "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } + "LensReview": { + "target": "com.amazonaws.wellarchitected#LensReview" } + }, + "traits": { + "smithy.api#documentation": "Output of a update lens review call.
", + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#UntagResource": { + "com.amazonaws.wellarchitected#UpdateProfile": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#UntagResourceInput" + "target": "com.amazonaws.wellarchitected#UpdateProfileInput" }, "output": { - "target": "com.amazonaws.wellarchitected#UntagResourceOutput" + "target": "com.amazonaws.wellarchitected#UpdateProfileOutput" }, "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { - "smithy.api#documentation": "Deletes specified tags from a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nTo specify multiple tags, use separate tagKeys parameters, for example:
\n\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n
Update a profile.
", "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{WorkloadArn}", + "method": "PATCH", + "uri": "/profiles/{ProfileArn}", "code": 200 } } }, - "com.amazonaws.wellarchitected#UntagResourceInput": { + "com.amazonaws.wellarchitected#UpdateProfileInput": { "type": "structure", "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { + "smithy.api#documentation": "The profile ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.wellarchitected#TagKeyList", + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", "traits": { - "smithy.api#documentation": "A list of tag keys. Existing tags of the resource \n whose keys are members of this list are removed from the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} + "smithy.api#documentation": "The profile description.
" + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "traits": { + "smithy.api#documentation": "Profile questions.
" } } }, @@ -7039,20 +8752,64 @@ "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#UntagResourceOutput": { + "com.amazonaws.wellarchitected#UpdateProfileOutput": { "type": "structure", - "members": {}, + "members": { + "Profile": { + "target": "com.amazonaws.wellarchitected#Profile", + "traits": { + "smithy.api#documentation": "The profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#UpdateReviewTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Update a review template.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/reviewTemplates/{TemplateArn}", + "code": 200 + } } }, - "com.amazonaws.wellarchitected#UpdateAnswer": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswer": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerInput" }, "output": { - "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerOutput" }, "errors": [ { @@ -7075,20 +8832,21 @@ } ], "traits": { - "smithy.api#documentation": "Update the answer to a specific question in a workload review.
", + "smithy.api#documentation": "Update a review template answer.
", "smithy.api#http": { "method": "PATCH", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#UpdateAnswerInput": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerInput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { + "smithy.api#documentation": "The review template ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7113,7 +8871,7 @@ "ChoiceUpdates": { "target": "com.amazonaws.wellarchitected#ChoiceUpdates", "traits": { - "smithy.api#documentation": "A list of choices to update on a question in your workload. The String key \n corresponds to the choice ID to be updated.
" + "smithy.api#documentation": "A list of choices to be updated.
" } }, "Notes": { @@ -7128,86 +8886,73 @@ "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { - "smithy.api#documentation": "The reason why a question is not applicable to your workload.
" + "smithy.api#documentation": "The update reason.
" } } }, "traits": { - "smithy.api#documentation": "Input to update answer.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#UpdateAnswerOutput": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerOutput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
" + } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", + "Answer": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswer", "traits": { - "smithy.api#documentation": "The ARN for the lens.
" + "smithy.api#documentation": "An answer of the question.
" } - }, - "Answer": { - "target": "com.amazonaws.wellarchitected#Answer" } }, "traits": { - "smithy.api#documentation": "Output of a update answer call.
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#UpdateGlobalSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" + "com.amazonaws.wellarchitected#UpdateReviewTemplateInput": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The review template ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" + "TemplateName": { + "target": "com.amazonaws.wellarchitected#TemplateName", + "traits": { + "smithy.api#documentation": "The review template name.
" + } }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" + "Description": { + "target": "com.amazonaws.wellarchitected#TemplateDescription", + "traits": { + "smithy.api#documentation": "The review template description.
" + } }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
", - "smithy.api#http": { - "method": "PATCH", - "uri": "/global-settings", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput": { - "type": "structure", - "members": { - "OrganizationSharingStatus": { - "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", + "LensesToAssociate": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLensAliases", "traits": { - "smithy.api#documentation": "The status of organization sharing settings.
" + "smithy.api#documentation": "A list of lens aliases or ARNs to apply to the review template.
" } }, - "DiscoveryIntegrationStatus": { - "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", + "LensesToDisassociate": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLensAliases", "traits": { - "smithy.api#documentation": "The status of discovery support settings.
" + "smithy.api#documentation": "A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.
Update lens review for a particular workload.
", + "smithy.api#documentation": "Update a lens review associated with a review template.
", "smithy.api#http": { "method": "PATCH", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}", "code": 200 } } }, - "com.amazonaws.wellarchitected#UpdateLensReviewInput": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewInput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { + "smithy.api#documentation": "The review template ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7277,97 +9023,36 @@ } }, "traits": { - "smithy.api#documentation": "Input for update lens review.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensReview": { - "target": "com.amazonaws.wellarchitected#LensReview" - } - }, - "traits": { - "smithy.api#documentation": "Output of a update lens review call.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateProfileInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateProfileOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Update a profile.
", - "smithy.api#http": { - "method": "PATCH", - "uri": "/profiles/{ProfileArn}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateProfileInput": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewOutput": { "type": "structure", "members": { - "ProfileArn": { - "target": "com.amazonaws.wellarchitected#ProfileArn", - "traits": { - "smithy.api#documentation": "The profile ARN.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ProfileDescription": { - "target": "com.amazonaws.wellarchitected#ProfileDescription", + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { - "smithy.api#documentation": "The profile description.
" + "smithy.api#documentation": "The review template ARN.
" } }, - "ProfileQuestions": { - "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "LensReview": { + "target": "com.amazonaws.wellarchitected#ReviewTemplateLensReview", "traits": { - "smithy.api#documentation": "Profile questions.
" + "smithy.api#documentation": "A lens review of a question.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#UpdateProfileOutput": { + "com.amazonaws.wellarchitected#UpdateReviewTemplateOutput": { "type": "structure", "members": { - "Profile": { - "target": "com.amazonaws.wellarchitected#Profile", + "ReviewTemplate": { + "target": "com.amazonaws.wellarchitected#ReviewTemplate", "traits": { - "smithy.api#documentation": "The profile.
" + "smithy.api#documentation": "A review template.
" } } }, @@ -7790,6 +9475,69 @@ "smithy.api#input": {} } }, + "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReviewInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Upgrade the lens review of a review template.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReviewInput": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.wellarchitected#TemplateArn", + "traits": { + "smithy.api#documentation": "The ARN of the review template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.wellarchitected#Urls": { "type": "list", "member": { @@ -7924,6 +9672,12 @@ { "target": "com.amazonaws.wellarchitected#CreateProfileShare" }, + { + "target": "com.amazonaws.wellarchitected#CreateReviewTemplate" + }, + { + "target": "com.amazonaws.wellarchitected#CreateTemplateShare" + }, { "target": "com.amazonaws.wellarchitected#CreateWorkload" }, @@ -7942,6 +9696,12 @@ { "target": "com.amazonaws.wellarchitected#DeleteProfileShare" }, + { + "target": "com.amazonaws.wellarchitected#DeleteReviewTemplate" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteTemplateShare" + }, { "target": "com.amazonaws.wellarchitected#DeleteWorkload" }, @@ -7984,6 +9744,15 @@ { "target": "com.amazonaws.wellarchitected#GetProfileTemplate" }, + { + "target": "com.amazonaws.wellarchitected#GetReviewTemplate" + }, + { + "target": "com.amazonaws.wellarchitected#GetReviewTemplateAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReview" + }, { "target": "com.amazonaws.wellarchitected#GetWorkload" }, @@ -8026,12 +9795,21 @@ { "target": "com.amazonaws.wellarchitected#ListProfileShares" }, + { + "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswers" + }, + { + "target": "com.amazonaws.wellarchitected#ListReviewTemplates" + }, { "target": "com.amazonaws.wellarchitected#ListShareInvitations" }, { "target": "com.amazonaws.wellarchitected#ListTagsForResource" }, + { + "target": "com.amazonaws.wellarchitected#ListTemplateShares" + }, { "target": "com.amazonaws.wellarchitected#ListWorkloads" }, @@ -8056,6 +9834,15 @@ { "target": "com.amazonaws.wellarchitected#UpdateProfile" }, + { + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplate" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReview" + }, { "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" }, @@ -8070,6 +9857,9 @@ }, { "target": "com.amazonaws.wellarchitected#UpgradeProfileVersion" + }, + { + "target": "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReview" } ], "traits": { @@ -9225,7 +11015,7 @@ "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { - "smithy.api#documentation": "The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
" + "smithy.api#documentation": "The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
\nIf a review template that specifies lenses is applied to the workload, those lenses are applied\n to the workload in addition to these lenses.
" } }, "com.amazonaws.wellarchitected#WorkloadName": { diff --git a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json index ec356301e00..42f55cc09a2 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json +++ b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json @@ -164,6 +164,35 @@ } } }, + "com.amazonaws.workspaces#ApplicationAssociatedResourceType": { + "type": "enum", + "members": { + "WORKSPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKSPACE" + } + }, + "BUNDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUNDLE" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + } + } + }, + "com.amazonaws.workspaces#ApplicationAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceType" + } + }, "com.amazonaws.workspaces#ApplicationList": { "type": "list", "member": { @@ -176,6 +205,70 @@ } } }, + "com.amazonaws.workspaces#ApplicationNotSupportedException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified application is not supported.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ApplicationResourceAssociation": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the application.
" + } + }, + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the associated resource.
" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the associated resource.
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association was created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association status was last updated.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "The status of the application resource association.
" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "The reason the association deployment failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the association between an application and an application resource.
" + } + }, + "com.amazonaws.workspaces#ApplicationResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ApplicationResourceAssociation" + } + }, "com.amazonaws.workspaces#AssociateConnectionAlias": { "type": "operation", "input": { @@ -305,6 +398,200 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#AssociateWorkspaceApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplicationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ApplicationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ComputeNotCompatibleException" + }, + { + "target": "com.amazonaws.workspaces#IncompatibleApplicationsException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperatingSystemNotCompatibleException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified application to the specified WorkSpace.
" + } + }, + "com.amazonaws.workspaces#AssociateWorkspaceApplicationRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpace.
", + "smithy.api#required": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#AssociateWorkspaceApplicationResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation", + "traits": { + "smithy.api#documentation": "Information about the association between the specified WorkSpace and the specified application.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#AssociationErrorCode": { + "type": "enum", + "members": { + "INSUFFICIENT_DISKSPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.InsufficientDiskSpace" + } + }, + "INSUFFICIENT_MEMORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.InsufficientMemory" + } + }, + "UNSUPPORTED_OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.UnsupportedOperatingSystem" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentError.InternalServerError" + } + }, + "WORKSPACE_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentError.WorkspaceUnreachable" + } + } + } + }, + "com.amazonaws.workspaces#AssociationState": { + "type": "enum", + "members": { + "PENDING_INSTALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_INSTALL" + } + }, + "PENDING_INSTALL_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_INSTALL_DEPLOYMENT" + } + }, + "PENDING_UNINSTALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UNINSTALL" + } + }, + "PENDING_UNINSTALL_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UNINSTALL_DEPLOYMENT" + } + }, + "INSTALLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLING" + } + }, + "UNINSTALLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNINSTALLING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVED" + } + } + } + }, + "com.amazonaws.workspaces#AssociationStateReason": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.workspaces#AssociationErrorCode", + "traits": { + "smithy.api#documentation": "The error code of the association deployment failure.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#String2048", + "traits": { + "smithy.api#documentation": "The error message of the association deployment failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the reason that the association deployment failed, including the error code and error message.
" + } + }, "com.amazonaws.workspaces#AssociationStatus": { "type": "enum", "members": { @@ -407,6 +694,23 @@ "com.amazonaws.workspaces#BooleanObject": { "type": "boolean" }, + "com.amazonaws.workspaces#BundleAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#BundleAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceType" + } + }, "com.amazonaws.workspaces#BundleId": { "type": "string", "traits": { @@ -434,6 +738,62 @@ "com.amazonaws.workspaces#BundleOwner": { "type": "string" }, + "com.amazonaws.workspaces#BundleResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the associated resource.
" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the associated resources.
" + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "The identifier of the bundle.
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association is created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association status was last updated.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "The status of the bundle resource association.
" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "The reason the association deployment failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the association between an application and a bundle resource.
" + } + }, + "com.amazonaws.workspaces#BundleResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#BundleResourceAssociation" + } + }, "com.amazonaws.workspaces#BundleType": { "type": "enum", "members": { @@ -696,6 +1056,20 @@ } } }, + "com.amazonaws.workspaces#ComputeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Compute" + } + }, + "com.amazonaws.workspaces#ComputeNotCompatibleException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The compute type of the WorkSpace is not compatible with the application.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#ComputeType": { "type": "structure", "members": { @@ -2324,24 +2698,237 @@ } } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { - "type": "structure", - "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#IncompatibleApplicationsException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deploys associated applications to the specified WorkSpace
" + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplicationsRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpace.
", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, \n it allows previously failed deployments to be retried.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplicationsResult": { + "type": "structure", + "members": { + "Deployment": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationDeployment", + "traits": { + "smithy.api#documentation": "The list of deployed associations and information about them.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters the specified directory. This operation is asynchronous and returns before\n the WorkSpace directory is deregistered. If any WorkSpaces are registered to this\n directory, you must remove them before you can deregister the directory.
\nSimple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.
\nTo delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.
\nThe identifier of the directory. If any WorkSpaces are registered to this directory, you\n must remove them before you deregister the directory, or you will receive an\n OperationNotSupportedException error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.
" + } + }, + "com.amazonaws.workspaces#DescribeAccountModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.
" + } + }, + "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.
The list of modifications to the configuration of BYOL.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeAccountResult": { + "type": "structure", + "members": { + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "traits": { + "smithy.api#documentation": "The status of BYOL (whether BYOL is enabled or disabled).
" + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.
\nThe management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { + "com.amazonaws.workspaces#DescribeApplicationAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" + "target": "com.amazonaws.workspaces#DescribeApplicationAssociationsRequest" }, "output": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" + "target": "com.amazonaws.workspaces#DescribeApplicationAssociationsResult" }, "errors": [ { @@ -2350,9 +2937,6 @@ { "target": "com.amazonaws.workspaces#InvalidParameterValuesException" }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, { "target": "com.amazonaws.workspaces#OperationNotSupportedException" }, @@ -2361,16 +2945,40 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters the specified directory. This operation is asynchronous and returns before\n the WorkSpace directory is deregistered. If any WorkSpaces are registered to this\n directory, you must remove them before you can deregister the directory.
\nSimple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.
\nTo delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.
\nDescribes the associations between the application and the specified associated resources.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest": { + "com.amazonaws.workspaces#DescribeApplicationAssociationsRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", "traits": { - "smithy.api#documentation": "The identifier of the directory. If any WorkSpaces are registered to this directory, you\n must remove them before you deregister the directory, or you will receive an\n OperationNotSupportedException error.
", + "smithy.api#documentation": "The maximum number of associations to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The identifier of the specified application.
", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "The resource type of the associated resources.
", "smithy.api#required": {} } } @@ -2379,54 +2987,100 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { + "com.amazonaws.workspaces#DescribeApplicationAssociationsResult": { "type": "structure", - "members": {}, + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#ApplicationResourceAssociationList", + "traits": { + "smithy.api#documentation": "List of associations and information about them.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.
" - } - }, - "com.amazonaws.workspaces#DescribeAccountModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" - }, - "errors": [ + }, { - "target": "com.amazonaws.workspaces#AccessDeniedException" + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.
" + "smithy.api#documentation": "Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { + "com.amazonaws.workspaces#DescribeApplicationsRequest": { "type": "structure", "members": { + "ApplicationIds": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationIdList", + "traits": { + "smithy.api#documentation": "The identifiers of one or more applications.
" + } + }, + "ComputeTypeNames": { + "target": "com.amazonaws.workspaces#ComputeList", + "traits": { + "smithy.api#documentation": "The compute types supported by the applications.
" + } + }, + "LicenseType": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType", + "traits": { + "smithy.api#documentation": "The license availability for the applications.
" + } + }, + "OperatingSystemNames": { + "target": "com.amazonaws.workspaces#OperatingSystemNameList", + "traits": { + "smithy.api#documentation": "The operating systems supported by the applications.
" + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationOwner", + "traits": { + "smithy.api#documentation": "The owner of the applications.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "The maximum number of applications to return.
" + } + }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { - "smithy.api#documentation": "If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The list of modifications to the configuration of BYOL.
" + "smithy.api#documentation": "List of information about the specified applications.
" } }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Describes the associations between the applications and the specified bundle.
" } }, - "com.amazonaws.workspaces#DescribeAccountResult": { + "com.amazonaws.workspaces#DescribeBundleAssociationsRequest": { "type": "structure", "members": { - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", "traits": { - "smithy.api#documentation": "The status of BYOL (whether BYOL is enabled or disabled).
" + "smithy.api#documentation": "The identifier of the bundle.
", + "smithy.api#required": {} } }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceTypeList", "traits": { - "smithy.api#documentation": "The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.
\nThe management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
" + "smithy.api#documentation": "The resource types of the associated resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeBundleAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#BundleResourceAssociationList", + "traits": { + "smithy.api#documentation": "List of information about the specified associations.
" } } }, @@ -2839,6 +3528,68 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DescribeImageAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeImageAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeImageAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the associations between the applications and the specified image.
" + } + }, + "com.amazonaws.workspaces#DescribeImageAssociationsRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "The identifier of the image.
", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "The resource types of the associated resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeImageAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#ImageResourceAssociationList", + "traits": { + "smithy.api#documentation": "List of information about the specified associations.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DescribeIpGroups": { "type": "operation", "input": { @@ -2877,7 +3628,59 @@ "MaxResults": { "target": "com.amazonaws.workspaces#Limit", "traits": { - "smithy.api#documentation": "The maximum number of items to return.
" + "smithy.api#documentation": "The maximum number of items to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeIpGroupsResult": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", + "traits": { + "smithy.api#documentation": "Information about the IP access control groups.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeTagsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified tags for the specified WorkSpaces resource.
" + } + }, + "com.amazonaws.workspaces#DescribeTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.
", + "smithy.api#required": {} } } }, @@ -2885,19 +3688,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DescribeIpGroupsResult": { + "com.amazonaws.workspaces#DescribeTagsResult": { "type": "structure", "members": { - "Result": { - "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", - "traits": { - "smithy.api#documentation": "Information about the IP access control groups.
" - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", + "TagList": { + "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "The tags.
" } } }, @@ -2905,30 +3702,46 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DescribeTags": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#DescribeTagsRequest" + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociationsRequest" }, "output": { - "target": "com.amazonaws.workspaces#DescribeTagsResult" + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociationsResult" }, "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "Describes the specified tags for the specified WorkSpaces resource.
" + "smithy.api#documentation": "Describes the associations betweens applications and the specified WorkSpace.
" } }, - "com.amazonaws.workspaces#DescribeTagsRequest": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociationsRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.
", + "smithy.api#documentation": "The identifier of the WorkSpace.
", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "The resource types of the associated resources.
", "smithy.api#required": {} } } @@ -2937,13 +3750,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DescribeTagsResult": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociationsResult": { "type": "structure", "members": { - "TagList": { - "target": "com.amazonaws.workspaces#TagList", + "Associations": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociationList", "traits": { - "smithy.api#documentation": "The tags.
" + "smithy.api#documentation": "List of information about the specified associations.
" } } }, @@ -3577,6 +4390,71 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplicationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the specified application from a WorkSpace.
" + } + }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplicationRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpace.
", + "smithy.api#required": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplicationResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation", + "traits": { + "smithy.api#documentation": "Information about the targeted association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DnsIpAddresses": { "type": "list", "member": { @@ -3606,7 +4484,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides in-depth details about the error. These details include the \n possible causes of the errors and troubleshooting information.
" + "smithy.api#documentation": "Describes in-depth details about the error. These details include the \n possible causes of the error and troubleshooting information.
" } }, "com.amazonaws.workspaces#ErrorDetailsList": { @@ -3744,6 +4622,23 @@ "smithy.api#documentation": "Describes a WorkSpace that could not be rebooted. (RebootWorkspaces),\n rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
" } }, + "com.amazonaws.workspaces#ImageAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#ImageAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceType" + } + }, "com.amazonaws.workspaces#ImagePermission": { "type": "structure", "members": { @@ -3764,6 +4659,62 @@ "target": "com.amazonaws.workspaces#ImagePermission" } }, + "com.amazonaws.workspaces#ImageResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the associated resource.
" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the associated resources.
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association is created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association status was last updated.
" + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "The identifier of the image.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "The status of the image resource association.
" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "The reason the association deployment failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the association between an application and an image resource.
" + } + }, + "com.amazonaws.workspaces#ImageResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ImageResourceAssociation" + } + }, "com.amazonaws.workspaces#ImageType": { "type": "enum", "members": { @@ -3996,6 +4947,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#IncompatibleApplicationsException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified application is not compatible with the resource.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#InvalidParameterValuesException": { "type": "structure", "members": { @@ -4932,63 +5891,148 @@ { "target": "com.amazonaws.workspaces#OperationNotSupportedException" }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Sets the state of the specified WorkSpace.
\nTo maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.
Sets the state of the specified WorkSpace.
\nTo maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.
The identifier of the WorkSpace.
", + "smithy.api#required": {} + } + }, + "WorkspaceState": { + "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "traits": { + "smithy.api#documentation": "The WorkSpace state.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.workspaces#OperatingSystem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.workspaces#OperatingSystemType", + "traits": { + "smithy.api#documentation": "The operating system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The operating system that the image is running.
" + } + }, + "com.amazonaws.workspaces#OperatingSystemName": { + "type": "enum", + "members": { + "AMAZON_LINUX_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2" + } + }, + "UBUNTU_18_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_18_04" + } + }, + "UBUNTU_20_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_20_04" + } + }, + "UBUNTU_22_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_22_04" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "WINDOWS_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_10" + } + }, + "WINDOWS_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_11" + } + }, + "WINDOWS_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_7" + } + }, + "WINDOWS_SERVER_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016" + } + }, + "WINDOWS_SERVER_2019": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpace.
", - "smithy.api#required": {} + "smithy.api#enumValue": "WINDOWS_SERVER_2019" } }, - "WorkspaceState": { - "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "WINDOWS_SERVER_2022": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The WorkSpace state.
", - "smithy.api#required": {} + "smithy.api#enumValue": "WINDOWS_SERVER_2022" } } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.workspaces#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } + "com.amazonaws.workspaces#OperatingSystemNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#OperatingSystemName" } }, - "com.amazonaws.workspaces#OperatingSystem": { + "com.amazonaws.workspaces#OperatingSystemNotCompatibleException": { "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.workspaces#OperatingSystemType", - "traits": { - "smithy.api#documentation": "The operating system.
" - } - } - }, + "members": {}, "traits": { - "smithy.api#documentation": "The operating system that the image is running.
" + "smithy.api#documentation": "The operating system of the WorkSpace is not compatible with the application.
", + "smithy.api#error": "client" } }, "com.amazonaws.workspaces#OperatingSystemType": { @@ -5470,6 +6514,24 @@ } } }, + "com.amazonaws.workspaces#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the resource that is in use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource is currently in use.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#ResourceLimitExceededException": { "type": "structure", "members": { @@ -5991,6 +7053,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.workspaces#SubnetId": { "type": "string", "traits": { @@ -6559,6 +7630,175 @@ "com.amazonaws.workspaces#VolumeEncryptionKey": { "type": "string" }, + "com.amazonaws.workspaces#WorkSpaceApplication": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the application.
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the application is created.
" + } + }, + "Description": { + "target": "com.amazonaws.workspaces#String2048", + "traits": { + "smithy.api#documentation": "The description of the WorkSpace application.
" + } + }, + "LicenseType": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType", + "traits": { + "smithy.api#documentation": "The license availability for the applications.
" + } + }, + "Name": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the WorkSpace application.
" + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationOwner", + "traits": { + "smithy.api#documentation": "The owner of the WorkSpace application.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationState", + "traits": { + "smithy.api#documentation": "The status of WorkSpace application.
" + } + }, + "SupportedComputeTypeNames": { + "target": "com.amazonaws.workspaces#ComputeList", + "traits": { + "smithy.api#documentation": "The supported compute types of the WorkSpace application.
" + } + }, + "SupportedOperatingSystemNames": { + "target": "com.amazonaws.workspaces#OperatingSystemNameList", + "traits": { + "smithy.api#documentation": "The supported operating systems of the WorkSpace application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the WorkSpace application.
" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationDeployment": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociationList", + "traits": { + "smithy.api#documentation": "The associations between the applications and the associated resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the WorkSpace application deployment.
" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wsa-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType": { + "type": "enum", + "members": { + "LICENSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSED" + } + }, + "UNLICENSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNLICENSED" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceApplication" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationOwner": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}|AMAZON$" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNINSTALL_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNINSTALL_ONLY" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType" + } + }, "com.amazonaws.workspaces#Workspace": { "type": "structure", "members": { @@ -7185,7 +8425,7 @@ "ErrorDetails": { "target": "com.amazonaws.workspaces#ErrorDetailsList", "traits": { - "smithy.api#documentation": "The details of the error returned for the image.
" + "smithy.api#documentation": "Additional details of the error returned for the image, including the \n possible causes of the errors and troubleshooting information.
" } } }, @@ -7532,6 +8772,12 @@ "traits": { "smithy.api#documentation": "The protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.
\nOnly available for WorkSpaces created with PCoIP bundles.
\nThe Protocols property is case sensitive. Ensure you use PCOIP or WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles \n (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
\nThe name of the operating system.
" + } } }, "traits": { @@ -7609,6 +8855,62 @@ } } }, + "com.amazonaws.workspaces#WorkspaceResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the associated resource.
" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType", + "traits": { + "smithy.api#documentation": "The resource types of the associated resource.
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association is created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the association status was last updated.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "The status of the WorkSpace resource association.
" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "The reason the association deployment failed.
" + } + }, + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the association between an application and a WorkSpace resource.
" + } + }, + "com.amazonaws.workspaces#WorkspaceResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation" + } + }, "com.amazonaws.workspaces#WorkspaceState": { "type": "enum", "members": { @@ -7776,6 +9078,9 @@ { "target": "com.amazonaws.workspaces#AssociateIpGroups" }, + { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplication" + }, { "target": "com.amazonaws.workspaces#AuthorizeIpRules" }, @@ -7830,6 +9135,9 @@ { "target": "com.amazonaws.workspaces#DeleteWorkspaceImage" }, + { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplications" + }, { "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectory" }, @@ -7839,6 +9147,15 @@ { "target": "com.amazonaws.workspaces#DescribeAccountModifications" }, + { + "target": "com.amazonaws.workspaces#DescribeApplicationAssociations" + }, + { + "target": "com.amazonaws.workspaces#DescribeApplications" + }, + { + "target": "com.amazonaws.workspaces#DescribeBundleAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeClientBranding" }, @@ -7854,12 +9171,18 @@ { "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" }, + { + "target": "com.amazonaws.workspaces#DescribeImageAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeIpGroups" }, { "target": "com.amazonaws.workspaces#DescribeTags" }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeWorkspaceBundles" }, @@ -7887,6 +9210,9 @@ { "target": "com.amazonaws.workspaces#DisassociateIpGroups" }, + { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplication" + }, { "target": "com.amazonaws.workspaces#ImportClientBranding" },