Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services services integrated with ACM.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.
Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
" + "documentation":"Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
" }, "RequestCertificate":{ "name":"RequestCertificate", @@ -274,7 +278,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" + "pattern":"arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" }, "AvailabilityErrorMessage":{"type":"string"}, "CertificateBody":{ @@ -1049,6 +1053,12 @@ "min":4, "sensitive":true }, + "PcaArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" + }, "PositiveInteger":{ "type":"integer", "min":1 @@ -1183,12 +1193,16 @@ "documentation":"Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
" }, "CertificateAuthorityArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Certificate Manager Private Certificate Authority user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
One or more resource tags to associate with the certificate.
" + }, + "KeyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate.
Default: RSA_2048
" } } }, diff --git a/services/acmpca/pom.xml b/services/acmpca/pom.xml index 87af56fe377a..045b39d6fdbe 100644 --- a/services/acmpca/pom.xml +++ b/services/acmpca/pom.xml @@ -21,7 +21,7 @@Deletes the pricing rule identified by the input Amazon Resource Name (ARN).
", + "documentation":"Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
", "idempotent":true }, "DisassociateAccounts":{ @@ -306,7 +306,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account.
" + "documentation":"This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.
" }, "ListBillingGroupCostReports":{ "name":"ListBillingGroupCostReports", @@ -344,6 +344,23 @@ ], "documentation":"A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.
" }, + "ListCustomLineItemVersions":{ + "name":"ListCustomLineItemVersions", + "http":{ + "method":"POST", + "requestUri":"/list-custom-line-item-versions", + "responseCode":200 + }, + "input":{"shape":"ListCustomLineItemVersionsInput"}, + "output":{"shape":"ListCustomLineItemVersionsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"A paginated call to get a list of all custom line item versions.
" + }, "ListCustomLineItems":{ "name":"ListCustomLineItems", "http":{ @@ -395,7 +412,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"A list of the pricing plans associated with a pricing rule.
" + "documentation":"A list of the pricing plans that are associated with a pricing rule.
" }, "ListPricingRules":{ "name":"ListPricingRules", @@ -430,7 +447,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists the pricing rules associated with a pricing plan.
" + "documentation":"Lists the pricing rules that are associated with a pricing plan.
" }, "ListResourcesAssociatedToCustomLineItem":{ "name":"ListResourcesAssociatedToCustomLineItem", @@ -448,7 +465,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"List the resources associated to a custom line item.
" + "documentation":"List the resources that are associated to a custom line item.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -623,7 +640,7 @@ "documentation":"The Amazon Web Services account email.
" } }, - "documentation":"Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
A representation of a linked account.
" + "documentation":"A representation of a linked account.
" }, "AccountEmail":{ "type":"string", @@ -717,11 +734,11 @@ "members":{ "Message":{ "shape":"String", - "documentation":"The reason the resource association failed.
" + "documentation":"The reason why the resource association failed.
" }, "Reason":{ "shape":"AssociateResourceErrorReason", - "documentation":"A static error code that used to classify the type of failure.
" + "documentation":"A static error code that's used to classify the type of failure.
" } }, "documentation":"A representation of a resource association error.
" @@ -732,14 +749,15 @@ "INVALID_ARN", "SERVICE_LIMIT_EXCEEDED", "ILLEGAL_CUSTOMLINEITEM", - "INTERNAL_SERVER_EXCEPTION" + "INTERNAL_SERVER_EXCEPTION", + "INVALID_BILLING_PERIOD_RANGE" ] }, "AssociateResourceResponseElement":{ "type":"structure", "members":{ "Arn":{ - "shape":"CustomLineItemArn", + "shape":"CustomLineItemAssociationElement", "documentation":"The resource ARN that was associated to the custom line item.
" }, "Error":{ @@ -755,7 +773,7 @@ }, "Association":{ "type":"string", - "pattern":"((arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}|MONITORED|UNMONITORED)" + "pattern":"((arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}|MONITORED|UNMONITORED)" }, "BatchAssociateResourcesToCustomLineItemInput":{ "type":"structure", @@ -821,7 +839,7 @@ }, "BillingGroupArn":{ "type":"string", - "pattern":"(arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}" + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}" }, "BillingGroupArnList":{ "type":"list", @@ -871,7 +889,7 @@ }, "BillingGroupFullArn":{ "type":"string", - "pattern":"arn:aws:billingconductor::[0-9]{12}:billinggroup/[0-9]{12}" + "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/[0-9]{12}" }, "BillingGroupList":{ "type":"list", @@ -882,7 +900,7 @@ "members":{ "Name":{ "shape":"BillingGroupName", - "documentation":"The billing group's name.
" + "documentation":"The name of the billing group.
" }, "Arn":{ "shape":"BillingGroupArn", @@ -890,7 +908,7 @@ }, "Description":{ "shape":"BillingGroupDescription", - "documentation":"The billing group description.
" + "documentation":"The description of the billing group.
" }, "PrimaryAccountId":{ "shape":"AccountId", @@ -903,11 +921,11 @@ }, "CreationTime":{ "shape":"Instant", - "documentation":"The time the billing group was created.
" + "documentation":"The time when the billing group was created.
" }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the billing group was modified.
" + "documentation":"The most recent time when the billing group was modified.
" }, "Status":{ "shape":"BillingGroupStatus", @@ -951,7 +969,7 @@ "members":{ "PricingPlanArn":{ "shape":"PricingPlanFullArn", - "documentation":"The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.
" + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.
" } }, "documentation":"The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
" @@ -972,6 +990,10 @@ "ResourceType":{ "shape":"String", "documentation":"Type of the resource in use.
" + }, + "Reason":{ + "shape":"ConflictExceptionReason", + "documentation":"Reason for the inconsistent state.
" } }, "documentation":"You can cause an inconsistent state by updating or deleting a resource.
", @@ -981,6 +1003,16 @@ }, "exception":true }, + "ConflictExceptionReason":{ + "type":"string", + "enum":[ + "RESOURCE_NAME_CONFLICT", + "PRICING_RULE_IN_PRICING_PLAN_CONFLICT", + "PRICING_PLAN_ATTACHED_TO_BILLING_GROUP_DELETE_CONFLICT", + "PRICING_RULE_ATTACHED_TO_PRICING_PLAN_DELETE_CONFLICT", + "WRITE_CONFLICT_RETRY" + ] + }, "CreateBillingGroupInput":{ "type":"structure", "required":[ @@ -1014,7 +1046,7 @@ }, "Description":{ "shape":"BillingGroupDescription", - "documentation":"The billing group description.
" + "documentation":"The description of the billing group.
" }, "Tags":{ "shape":"TagMap", @@ -1095,11 +1127,11 @@ }, "Name":{ "shape":"PricingPlanName", - "documentation":"The pricing plan name. The names must be unique to each pricing plan.
" + "documentation":"The name of the pricing plan. The names must be unique to each pricing plan.
" }, "Description":{ "shape":"PricingPlanDescription", - "documentation":"The pricing plan description.
" + "documentation":"The description of the pricing plan.
" }, "PricingRuleArns":{ "shape":"PricingRuleArnsInput", @@ -1131,7 +1163,7 @@ "members":{ "ClientToken":{ "shape":"ClientToken", - "documentation":"The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", + "documentation":"The token that's needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amzn-Client-Token" @@ -1146,7 +1178,7 @@ }, "Scope":{ "shape":"PricingRuleScope", - "documentation":"The scope of pricing rule that indicates if it is globally applicable, or is service-specific.
" + "documentation":"The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
" }, "Type":{ "shape":"PricingRuleType", @@ -1154,7 +1186,7 @@ }, "ModifierPercentage":{ "shape":"ModifierPercentage", - "documentation":"A percentage modifier applied on the public pricing rates.
" + "documentation":"A percentage modifier that's applied on the public pricing rates.
" }, "Service":{ "shape":"Service", @@ -1185,7 +1217,7 @@ }, "CustomLineItemArn":{ "type":"string", - "pattern":"(arn:aws:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}" + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}" }, "CustomLineItemArns":{ "type":"list", @@ -1195,7 +1227,7 @@ }, "CustomLineItemAssociationElement":{ "type":"string", - "pattern":"(arn:aws:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}" + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}" }, "CustomLineItemAssociationsList":{ "type":"list", @@ -1217,10 +1249,7 @@ }, "CustomLineItemBillingPeriodRange":{ "type":"structure", - "required":[ - "InclusiveStartBillingPeriod", - "ExclusiveEndBillingPeriod" - ], + "required":["InclusiveStartBillingPeriod"], "members":{ "InclusiveStartBillingPeriod":{ "shape":"BillingPeriod", @@ -1273,7 +1302,7 @@ "documentation":"The custom line item's fixed charge value in USD.
" } }, - "documentation":"A representation of the charge details associated with a flat custom line item.
" + "documentation":"A representation of the charge details that are associated with a flat custom line item.
" }, "CustomLineItemList":{ "type":"list", @@ -1304,7 +1333,7 @@ }, "ProductCode":{ "shape":"CustomLineItemProductCode", - "documentation":"The product code associated with the custom line item.
" + "documentation":"The product code that's associated with the custom line item.
" }, "BillingGroupArn":{ "shape":"BillingGroupArn", @@ -1316,7 +1345,7 @@ }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the custom line item was modified.
" + "documentation":"The most recent time when the custom line item was modified.
" }, "AssociationSize":{ "shape":"NumberOfAssociations", @@ -1351,7 +1380,7 @@ "documentation":"A list of resource ARNs to associate to the percentage custom line item.
" } }, - "documentation":"A representation of the charge details associated with a percentage custom line item.
" + "documentation":"A representation of the charge details that are associated with a percentage custom line item.
" }, "CustomLineItemPercentageChargeValue":{ "type":"double", @@ -1378,13 +1407,64 @@ "FEE" ] }, + "CustomLineItemVersionList":{ + "type":"list", + "member":{"shape":"CustomLineItemVersionListElement"} + }, + "CustomLineItemVersionListElement":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The name of the custom line item.
" + }, + "ChargeDetails":{"shape":"ListCustomLineItemChargeDetails"}, + "CurrencyCode":{ + "shape":"CurrencyCode", + "documentation":"The charge value currency of the custom line item.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The description of the custom line item.
" + }, + "ProductCode":{ + "shape":"CustomLineItemProductCode", + "documentation":"The product code that’s associated with the custom line item.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that the custom line item applies to.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time when the custom line item version was created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time that the custom line item version was modified.
" + }, + "AssociationSize":{ + "shape":"NumberOfAssociations", + "documentation":"The number of resources that are associated with the custom line item.
" + }, + "StartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The start billing period of the custom line item version.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The end billing period of the custom line item version.
" + } + }, + "documentation":"A representation of a custom line item version.
" + }, "DeleteBillingGroupInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"BillingGroupArn", - "documentation":"The Amazon Resource Name (ARN) of the billing group you're deleting.
" + "documentation":"The Amazon Resource Name (ARN) of the billing group that you're deleting.
" } } }, @@ -1423,7 +1503,7 @@ "members":{ "Arn":{ "shape":"PricingPlanArn", - "documentation":"The Amazon Resource Name (ARN) of the pricing plan you're deleting.
" + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that you're deleting.
" } } }, @@ -1442,7 +1522,7 @@ "members":{ "Arn":{ "shape":"PricingRuleArn", - "documentation":"The Amazon Resource Name (ARN) of the pricing rule you are deleting.
" + "documentation":"The Amazon Resource Name (ARN) of the pricing rule that you are deleting.
" } } }, @@ -1511,12 +1591,12 @@ "type":"structure", "members":{ "Arn":{ - "shape":"CustomLineItemArn", + "shape":"CustomLineItemAssociationElement", "documentation":"The resource ARN that was disassociated from the custom line item.
" }, "Error":{ "shape":"AssociateResourceError", - "documentation":" An AssociateResourceError shown if the resource disassociation fails.
An AssociateResourceError that's shown if the resource disassociation fails.
A resource disassociation result for a percentage custom line item.
" @@ -1566,11 +1646,11 @@ }, "Filters":{ "shape":"ListAccountAssociationsFilter", - "documentation":"The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that are not associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided billing group Arn.
The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that aren't associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided billing group Arn.
The pagination token used on subsequent calls to retrieve accounts.
" + "documentation":"The pagination token that's used on subsequent calls to retrieve accounts.
" } } }, @@ -1583,7 +1663,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get accounts.
" + "documentation":"The pagination token that's used on subsequent calls to get accounts.
" } } }, @@ -1610,7 +1690,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get reports.
" + "documentation":"The pagination token that's used on subsequent calls to get reports.
" }, "Filters":{ "shape":"ListBillingGroupCostReportsFilter", @@ -1627,7 +1707,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get reports.
" + "documentation":"The pagination token that's used on subsequent calls to get reports.
" } } }, @@ -1658,7 +1738,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get billing groups.
" + "documentation":"The pagination token that's used on subsequent calls to get billing groups.
" }, "Filters":{ "shape":"ListBillingGroupsFilter", @@ -1675,7 +1755,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get billing groups.
" + "documentation":"The pagination token that's used on subsequent calls to get billing groups.
" } } }, @@ -1707,7 +1787,7 @@ "documentation":"The custom line item's fixed charge value in USD.
" } }, - "documentation":"A representation of the charge details associated with a flat custom line item.
" + "documentation":"A representation of the charge details that are associated with a flat custom line item.
" }, "ListCustomLineItemPercentageChargeDetails":{ "type":"structure", @@ -1718,7 +1798,66 @@ "documentation":"The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
" } }, - "documentation":"A representation of the charge details associated with a percentage custom line item.
" + "documentation":"A representation of the charge details that are associated with a percentage custom line item.
" + }, + "ListCustomLineItemVersionsBillingPeriodRangeFilter":{ + "type":"structure", + "members":{ + "StartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The inclusive start billing period that defines a billing period range where a custom line item version is applied.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The exclusive end billing period that defines a billing period range where a custom line item version is applied.
" + } + }, + "documentation":"A billing period filter that specifies the custom line item versions to retrieve.
" + }, + "ListCustomLineItemVersionsFilter":{ + "type":"structure", + "members":{ + "BillingPeriodRange":{ + "shape":"ListCustomLineItemVersionsBillingPeriodRangeFilter", + "documentation":"The billing period range in which the custom line item version is applied.
" + } + }, + "documentation":"A filter that specifies the billing period range where the custom line item versions reside.
" + }, + "ListCustomLineItemVersionsInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The Amazon Resource Name (ARN) for the custom line item.
" + }, + "MaxResults":{ + "shape":"MaxCustomLineItemResults", + "documentation":"The maximum number of custom line item versions to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to retrieve custom line item versions.
" + }, + "Filters":{ + "shape":"ListCustomLineItemVersionsFilter", + "documentation":"A ListCustomLineItemVersionsFilter that specifies the billing period range in which the custom line item versions are applied.
A list of CustomLineItemVersionListElements that are received.
The pagination token that's used on subsequent calls to retrieve custom line item versions.
" + } + } }, "ListCustomLineItemsFilter":{ "type":"structure", @@ -1746,12 +1885,12 @@ "documentation":"The preferred billing period to get custom line items (FFLIs).
" }, "MaxResults":{ - "shape":"MaxBillingGroupResults", + "shape":"MaxCustomLineItemResults", "documentation":"The maximum number of billing groups to retrieve.
" }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get custom line items (FFLIs).
" + "documentation":"The pagination token that's used on subsequent calls to get custom line items (FFLIs).
" }, "Filters":{ "shape":"ListCustomLineItemsFilter", @@ -1768,7 +1907,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get custom line items (FFLIs).
" + "documentation":"The pagination token that's used on subsequent calls to get custom line items (FFLIs).
" } } }, @@ -1807,7 +1946,7 @@ }, "PricingPlanArns":{ "shape":"PricingPlanArns", - "documentation":"The list containing pricing plans associated with the requested pricing rule.
" + "documentation":"The list containing pricing plans that are associated with the requested pricing rule.
" }, "NextToken":{ "shape":"Token", @@ -1842,7 +1981,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent call to get pricing plans.
" + "documentation":"The pagination token that's used on subsequent call to get pricing plans.
" } } }, @@ -1859,7 +1998,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get pricing plans.
" + "documentation":"The pagination token that's used on subsequent calls to get pricing plans.
" } } }, @@ -1898,7 +2037,7 @@ }, "PricingRuleArns":{ "shape":"PricingRuleArns", - "documentation":"A list containing pricing rules associated with the requested pricing plan.
" + "documentation":"A list containing pricing rules that are associated with the requested pricing plan.
" }, "NextToken":{ "shape":"Token", @@ -1933,7 +2072,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent call to get pricing rules.
" + "documentation":"The pagination token that's used on subsequent call to get pricing rules.
" } } }, @@ -1950,7 +2089,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"The pagination token used on subsequent calls to get pricing rules.
" + "documentation":"The pagination token that's used on subsequent calls to get pricing rules.
" } } }, @@ -1982,7 +2121,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"(Optional) The pagination token returned by a previous request.
" + "documentation":"(Optional) The pagination token that's returned by a previous request.
" }, "Filters":{ "shape":"ListResourcesAssociatedToCustomLineItemFilter", @@ -2017,6 +2156,10 @@ "Relationship":{ "shape":"CustomLineItemRelationship", "documentation":"The type of relationship between the custom line item and the associated resource.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The end billing period of the associated resource.
" } }, "documentation":"A representation of a resource association for a custom line item.
" @@ -2095,7 +2238,7 @@ }, "PricingPlanArn":{ "type":"string", - "pattern":"(arn:aws:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}" + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}" }, "PricingPlanArns":{ "type":"list", @@ -2111,7 +2254,7 @@ }, "PricingPlanFullArn":{ "type":"string", - "pattern":"arn:aws:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}" + "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}" }, "PricingPlanList":{ "type":"list", @@ -2134,15 +2277,15 @@ }, "Size":{ "shape":"NumberOfAssociatedPricingRules", - "documentation":"The pricing rules count currently associated with this pricing plan list element.
" + "documentation":"The pricing rules count that's currently associated with this pricing plan list element.
" }, "CreationTime":{ "shape":"Instant", - "documentation":"The time the pricing plan was created.
" + "documentation":"The time when the pricing plan was created.
" }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the pricing plan was modified.
" + "documentation":"The most recent time when the pricing plan was modified.
" } }, "documentation":"A representation of a pricing plan.
" @@ -2156,7 +2299,7 @@ }, "PricingRuleArn":{ "type":"string", - "pattern":"(arn:aws:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}" + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}" }, "PricingRuleArns":{ "type":"list", @@ -2223,11 +2366,11 @@ }, "CreationTime":{ "shape":"Instant", - "documentation":"The time the pricing rule was created.
" + "documentation":"The time when the pricing rule was created.
" }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the pricing rule was modified.
" + "documentation":"The most recent time when the pricing rule was modified.
" } }, "documentation":"A representation of a pricing rule.
" @@ -2468,7 +2611,7 @@ }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the billing group was modified.
" + "documentation":"The most recent time when the billing group was modified.
" }, "Status":{ "shape":"BillingGroupStatus", @@ -2503,7 +2646,7 @@ "documentation":"The custom line item's new fixed charge value in USD.
" } }, - "documentation":"A representation of the new charge details associated with a flat custom line item.
" + "documentation":"A representation of the new charge details that are associated with a flat custom line item.
" }, "UpdateCustomLineItemInput":{ "type":"structure", @@ -2514,7 +2657,7 @@ "documentation":"The ARN of the custom line item to be updated.
" }, "Name":{ - "shape":"BillingGroupName", + "shape":"CustomLineItemName", "documentation":"The new name for the custom line item.
" }, "Description":{ @@ -2553,7 +2696,7 @@ }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the custom line item was modified.
" + "documentation":"The most recent time when the custom line item was modified.
" }, "AssociationSize":{ "shape":"NumberOfAssociations", @@ -2570,7 +2713,7 @@ "documentation":"The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
" } }, - "documentation":"A representation of the new charge details associated with a percentage custom line item.
" + "documentation":"A representation of the new charge details that are associated with a percentage custom line item.
" }, "UpdatePricingPlanInput":{ "type":"structure", @@ -2578,7 +2721,7 @@ "members":{ "Arn":{ "shape":"PricingPlanArn", - "documentation":"The Amazon Resource Name (ARN) of the pricing plan you're updating.
" + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that you're updating.
" }, "Name":{ "shape":"PricingPlanName", @@ -2586,7 +2729,7 @@ }, "Description":{ "shape":"PricingPlanDescription", - "documentation":"The pricing plan description.
" + "documentation":"The description of the pricing plan.
" } } }, @@ -2607,11 +2750,11 @@ }, "Size":{ "shape":"NumberOfAssociatedPricingRules", - "documentation":"The pricing rules count currently associated with this pricing plan list.
" + "documentation":"The pricing rules count that's currently associated with this pricing plan list.
" }, "LastModifiedTime":{ "shape":"Instant", - "documentation":"The most recent time the pricing plan was modified.
" + "documentation":"The most recent time when the pricing plan was modified.
" } } }, @@ -2658,7 +2801,7 @@ }, "Scope":{ "shape":"PricingRuleScope", - "documentation":"The scope of pricing rule that indicates if it is globally applicable, or is service-specific.
" + "documentation":"The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
" }, "Type":{ "shape":"PricingRuleType", @@ -2771,9 +2914,13 @@ "MISSING_LINKED_ACCOUNT_IDS", "MULTIPLE_LINKED_ACCOUNT_IDS", "MISSING_PRICING_PLAN_ARN", - "MULTIPLE_PRICING_PLAN_ARN" + "MULTIPLE_PRICING_PLAN_ARN", + "ILLEGAL_CHILD_ASSOCIATE_RESOURCE", + "CUSTOM_LINE_ITEM_ASSOCIATION_EXISTS", + "INVALID_BILLING_PERIOD_FOR_OPERATION", + "INVALID_BILLING_GROUP" ] } }, - "documentation":"Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a pro forma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Enterprise Billing Console User Guide.
" + "documentation":"Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a pro forma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.
" } diff --git a/services/braket/pom.xml b/services/braket/pom.xml index 2a1cc237825e..882369754bd0 100644 --- a/services/braket/pom.xml +++ b/services/braket/pom.xml @@ -21,7 +21,7 @@The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement group.
", + "locationName":"groupId" } }, "documentation":"Describes the placement of an instance.
" @@ -35125,6 +35130,10 @@ "PartitionNumber":{ "shape":"Integer", "documentation":"The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" } }, "documentation":"Describes the placement of an instance.
" @@ -37078,6 +37087,10 @@ "HostResourceGroupArn":{ "shape":"String", "documentation":"The ARN of the host resource group in which to place the instance.
" + }, + "GroupId":{ + "shape":"PlacementGroupId", + "documentation":"The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" } } }, @@ -40694,6 +40707,11 @@ "shape":"String", "documentation":"The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
", "locationName":"hostResourceGroupArn" + }, + "GroupId":{ + "shape":"PlacementGroupId", + "documentation":"The Group Id of the placement group.
", + "locationName":"groupId" } }, "documentation":"Describes the placement of an instance.
" diff --git a/services/ec2instanceconnect/pom.xml b/services/ec2instanceconnect/pom.xml index 3d6ffb15021e..32396fc03583 100644 --- a/services/ec2instanceconnect/pom.xml +++ b/services/ec2instanceconnect/pom.xml @@ -21,7 +21,7 @@Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.
" }, + "BatchAssociateResource":{ + "name":"BatchAssociateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchAssociateResourceRequest"}, + "output":{"shape":"BatchAssociateResourceResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Associate resources to a Firewall Manager resource set.
" + }, + "BatchDisassociateResource":{ + "name":"BatchDisassociateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDisassociateResourceRequest"}, + "output":{"shape":"BatchDisassociateResourceResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disassociates resources from a Firewall Manager resource set.
" + }, "DeleteAppsList":{ "name":"DeleteAppsList", "http":{ @@ -103,6 +136,21 @@ ], "documentation":"Permanently deletes an Firewall Manager protocols list.
" }, + "DeleteResourceSet":{ + "name":"DeleteResourceSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceSetRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"Deletes the specified ResourceSet.
" + }, "DisassociateAdminAccount":{ "name":"DisassociateAdminAccount", "http":{ @@ -240,6 +288,22 @@ ], "documentation":"Returns information about the specified Firewall Manager protocols list.
" }, + "GetResourceSet":{ + "name":"GetResourceSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceSetRequest"}, + "output":{"shape":"GetResourceSetResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"Gets information about a specific resource set.
" + }, "GetThirdPartyFirewallAssociationStatus":{ "name":"GetThirdPartyFirewallAssociationStatus", "http":{ @@ -301,6 +365,21 @@ ], "documentation":"Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
" + }, "ListMemberAccounts":{ "name":"ListMemberAccounts", "http":{ @@ -346,6 +425,37 @@ ], "documentation":"Returns an array of ProtocolsListDataSummary objects.
Returns an array of resources that are currently associated to a resource set.
" + }, + "ListResourceSets":{ + "name":"ListResourceSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceSetsRequest"}, + "output":{"shape":"ListResourceSetsResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"Returns an array of ResourceSetSummary objects.
Creates an Firewall Manager protocols list.
" }, + "PutResourceSet":{ + "name":"PutResourceSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourceSetRequest"}, + "output":{"shape":"PutResourceSetResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"Creates the resource set.
An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.
" + }, "TagResource":{ "name":"TagResource", "http":{ @@ -485,6 +611,10 @@ "min":1, "pattern":"^[0-9]+$" }, + "AWSAccountIdList":{ + "type":"list", + "member":{"shape":"AWSAccountId"} + }, "AccountRoleStatus":{ "type":"string", "enum":[ @@ -683,11 +813,85 @@ }, "documentation":"Violation detail for the rule violation in a security group when compared to the primary security group of the Firewall Manager policy.
" }, + "Base62Id":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[a-z0-9A-Z]{22}$" + }, "BasicInteger":{ "type":"integer", "max":2147483647, "min":-2147483648 }, + "BatchAssociateResourceRequest":{ + "type":"structure", + "required":[ + "ResourceSetIdentifier", + "Items" + ], + "members":{ + "ResourceSetIdentifier":{ + "shape":"Identifier", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + }, + "Items":{ + "shape":"IdentifierList", + "documentation":"The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).
" + } + } + }, + "BatchAssociateResourceResponse":{ + "type":"structure", + "required":[ + "ResourceSetIdentifier", + "FailedItems" + ], + "members":{ + "ResourceSetIdentifier":{ + "shape":"Identifier", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + }, + "FailedItems":{ + "shape":"FailedItemList", + "documentation":"The resources that failed to associate to the resource set.
" + } + } + }, + "BatchDisassociateResourceRequest":{ + "type":"structure", + "required":[ + "ResourceSetIdentifier", + "Items" + ], + "members":{ + "ResourceSetIdentifier":{ + "shape":"Identifier", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + }, + "Items":{ + "shape":"IdentifierList", + "documentation":"The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).
" + } + } + }, + "BatchDisassociateResourceResponse":{ + "type":"structure", + "required":[ + "ResourceSetIdentifier", + "FailedItems" + ], + "members":{ + "ResourceSetIdentifier":{ + "shape":"Identifier", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + }, + "FailedItems":{ + "shape":"FailedItemList", + "documentation":"The resources that failed to disassociate from the resource set.
" + } + } + }, "Boolean":{"type":"boolean"}, "CIDR":{ "type":"string", @@ -787,6 +991,16 @@ } } }, + "DeleteResourceSetRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"Base62Id", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + } + } + }, "DependentServiceName":{ "type":"string", "enum":[ @@ -796,6 +1010,11 @@ "AWSVPC" ] }, + "Description":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, "DestinationType":{ "type":"string", "enum":[ @@ -806,7 +1025,7 @@ }, "DetailedInfo":{ "type":"string", - "max":1024, + "max":4096, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=,+\\-@]*)$" }, @@ -834,6 +1053,32 @@ } } }, + "DiscoveredResource":{ + "type":"structure", + "members":{ + "URI":{ + "shape":"Identifier", + "documentation":"The universal resource identifier (URI) of the discovered resource.
" + }, + "AccountId":{ + "shape":"AWSAccountId", + "documentation":"The Amazon Web Services account ID associated with the discovered resource.
" + }, + "Type":{ + "shape":"ResourceType", + "documentation":"The type of the discovered resource.
" + }, + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the discovered resource.
" + } + }, + "documentation":"A resource in the organization that's available to be associated with a Firewall Manager resource set.
" + }, + "DiscoveredResourceList":{ + "type":"list", + "member":{"shape":"DiscoveredResource"} + }, "DnsDuplicateRuleGroupViolation":{ "type":"structure", "members":{ @@ -1147,6 +1392,35 @@ }, "documentation":"Contains information about the actions that you can take to remediate scope violations caused by your policy's FirewallCreationConfig. FirewallCreationConfig is an optional configuration that you can use to choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.
The univeral resource indicator (URI) of the resource that failed.
" + }, + "Reason":{ + "shape":"FailedItemReason", + "documentation":"The reason the resource's association could not be updated.
" + } + }, + "documentation":"Details of a resource that failed when trying to update it's association to a resource set.
" + }, + "FailedItemList":{ + "type":"list", + "member":{"shape":"FailedItem"} + }, + "FailedItemReason":{ + "type":"string", + "enum":[ + "NOT_VALID_ARN", + "NOT_VALID_PARTITION", + "NOT_VALID_REGION", + "NOT_VALID_SERVICE", + "NOT_VALID_RESOURCE_TYPE", + "NOT_VALID_ACCOUNT_ID" + ] + }, "FirewallDeploymentModel":{ "type":"string", "enum":[ @@ -1404,6 +1678,33 @@ } } }, + "GetResourceSetRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"Base62Id", + "documentation":"A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + } + } + }, + "GetResourceSetResponse":{ + "type":"structure", + "required":[ + "ResourceSet", + "ResourceSetArn" + ], + "members":{ + "ResourceSet":{ + "shape":"ResourceSet", + "documentation":"Information about the specified resource set.
" + }, + "ResourceSetArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource set.
" + } + } + }, "GetThirdPartyFirewallAssociationStatusRequest":{ "type":"structure", "required":["ThirdPartyFirewall"], @@ -1468,6 +1769,16 @@ "max":65535, "min":0 }, + "Identifier":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "IdentifierList":{ + "type":"list", + "member":{"shape":"Identifier"} + }, "InternalErrorException":{ "type":"structure", "members":{ @@ -1584,6 +1895,44 @@ } } }, + "ListDiscoveredResourcesRequest":{ + "type":"structure", + "required":[ + "MemberAccountIds", + "ResourceType" + ], + "members":{ + "MemberAccountIds":{ + "shape":"AWSAccountIdList", + "documentation":"The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.
" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"The type of resources to discover.
" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Details of the resources that were discovered.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
A unique identifier for the resource set, used in a TODO to refer to the resource set.
" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
An array of the associated resources' uniform resource identifiers (URI).
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
An array of ResourceSetSummary objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
The unique identifiers of the resource sets used by the policy.
" + }, + "PolicyDescription":{ + "shape":"ResourceDescription", + "documentation":"The definition of the Network Firewall firewall policy.
" } }, "documentation":"An Firewall Manager policy.
" @@ -2594,6 +3015,37 @@ } } }, + "PutResourceSetRequest":{ + "type":"structure", + "required":["ResourceSet"], + "members":{ + "ResourceSet":{ + "shape":"ResourceSet", + "documentation":"Details about the resource set to be created or updated.>
" + }, + "TagList":{ + "shape":"TagList", + "documentation":"Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
" + } + } + }, + "PutResourceSetResponse":{ + "type":"structure", + "required":[ + "ResourceSet", + "ResourceSetArn" + ], + "members":{ + "ResourceSet":{ + "shape":"ResourceSet", + "documentation":"Details about the resource set.
" + }, + "ResourceSetArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource set.
" + } + } + }, "ReferenceRule":{"type":"string"}, "RemediationAction":{ "type":"structure", @@ -2664,6 +3116,21 @@ }, "documentation":"An ordered list of actions you can take to remediate a violation.
" }, + "Resource":{ + "type":"structure", + "required":["URI"], + "members":{ + "URI":{ + "shape":"Identifier", + "documentation":"The resource's universal resource indicator (URI).
" + }, + "AccountId":{ + "shape":"AWSAccountId", + "documentation":"The Amazon Web Services account ID that the associated resource belongs to.
" + } + }, + "documentation":"Details of a resource that is associated to an Firewall Manager resource set.
" + }, "ResourceArn":{ "type":"string", "max":1024, @@ -2674,6 +3141,11 @@ "type":"long", "min":0 }, + "ResourceDescription":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, "ResourceId":{ "type":"string", "max":1024, @@ -2684,6 +3156,10 @@ "type":"list", "member":{"shape":"ResourceId"} }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"} + }, "ResourceName":{ "type":"string", "max":128, @@ -2698,6 +3174,70 @@ "documentation":"The specified resource was not found.
", "exception":true }, + "ResourceSet":{ + "type":"structure", + "required":[ + "Name", + "ResourceTypeList" + ], + "members":{ + "Id":{ + "shape":"Base62Id", + "documentation":"A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The descriptive name of the resource set. You can't change the name of a resource set after you create it.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A description of the resource set.
" + }, + "UpdateToken":{ + "shape":"UpdateToken", + "documentation":"An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.
To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
" + }, + "LastUpdateTime":{ + "shape":"TimeStamp", + "documentation":"The last time that the resource set was changed.
" + } + }, + "documentation":"A set of resources to include in a policy.
" + }, + "ResourceSetIds":{ + "type":"list", + "member":{"shape":"Base62Id"} + }, + "ResourceSetSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Base62Id", + "documentation":"A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The descriptive name of the resource set. You can't change the name of a resource set after you create it.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A description of the resource set.
" + }, + "LastUpdateTime":{ + "shape":"TimeStamp", + "documentation":"The last time that the resource set was changed.
" + } + }, + "documentation":"Summarizes the resource sets used in a policy.
" + }, + "ResourceSetSummaryList":{ + "type":"list", + "member":{"shape":"ResourceSetSummary"} + }, "ResourceTag":{ "type":"structure", "required":["Key"], @@ -3012,7 +3552,8 @@ "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "DNS_FIREWALL", - "THIRD_PARTY_FIREWALL" + "THIRD_PARTY_FIREWALL", + "IMPORT_NETWORK_FIREWALL" ] }, "StatefulEngineOptions":{ diff --git a/services/forecast/pom.xml b/services/forecast/pom.xml index bff686fae4b3..f1eb9180cdb0 100644 --- a/services/forecast/pom.xml +++ b/services/forecast/pom.xml @@ -21,7 +21,7 @@Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
" + "documentation":"Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
" }, "UpdateContainerService":{ "name":"UpdateContainerService", @@ -2775,7 +2775,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.
The AWS Region where this access key was most recently used.
This value is N/A if the access key has not been used.
The Amazon Web Services Region where this access key was most recently used.
This value is N/A if the access key has not been used.
The name of the AWS service with which this access key was most recently used.
This value is N/A if the access key has not been used.
The name of the Amazon Web Services service with which this access key was most recently used.
This value is N/A if the access key has not been used.
Describes the last time an access key was used.
This object does not include data in the response of a CreateBucketAccessKey action.
The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web Services Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
Describes the full details of an Amazon Lightsail SSL/TLS certificate.
To get a summary of a certificate, use the GetCertificates action and ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
Must be unique within each Amazon Web Services Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.
The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
Must be unique within each Amazon Web Services Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
Must be in the hh24:mi-hh24:mi format.
Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation.
Constraints:
Must be in the hh24:mi-hh24:mi format.
Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The status code for the automated DNS record creation.
Following are the possible values:
SUCCEEDED - The validation records were successfully added to the domain.
STARTED - The automatic DNS record creation has started.
FAILED - The validation records failed to be added to the domain.
The message that describes the reason for the status code.
" + } + }, + "documentation":"Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.
When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + }, + "DnsRecordCreationStateCode":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "STARTED", + "FAILED" + ] + }, "Domain":{ "type":"structure", "members":{ @@ -6352,6 +6382,10 @@ "domainEntries":{ "shape":"DomainEntryList", "documentation":"An array of key-value pairs containing information about the domain entries.
" + }, + "registeredDomainDelegationInfo":{ + "shape":"RegisteredDomainDelegationInfo", + "documentation":"An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.
" } }, "documentation":"Describes a domain where you are storing recordsets.
" @@ -6417,9 +6451,17 @@ "resourceRecord":{ "shape":"ResourceRecord", "documentation":"An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
" + }, + "dnsRecordCreationState":{ + "shape":"DnsRecordCreationState", + "documentation":"An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.
" + }, + "validationStatus":{ + "shape":"CertificateDomainValidationStatus", + "documentation":"The validation status of the record.
" } }, - "documentation":"Describes the domain validation records of an Amazon Lightsail SSL/TLS certificate.
" + "documentation":"Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.
" }, "DomainValidationRecordList":{ "type":"list", @@ -9235,7 +9277,7 @@ }, "location":{ "shape":"ResourceLocation", - "documentation":"The AWS Region and Availability Zone where you created your certificate.
" + "documentation":"The Amazon Web Services Region and Availability Zone where you created your certificate.
" }, "resourceType":{ "shape":"ResourceType", @@ -9320,6 +9362,28 @@ }, "documentation":"Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
" }, + "LoadBalancerTlsCertificateDnsRecordCreationState":{ + "type":"structure", + "members":{ + "code":{ + "shape":"LoadBalancerTlsCertificateDnsRecordCreationStateCode", + "documentation":"The status code for the automated DNS record creation.
Following are the possible values:
SUCCEEDED - The validation records were successfully added.
STARTED - The automatic DNS record creation has started.
FAILED - The validation record addition failed.
The message that describes the reason for the status code.
" + } + }, + "documentation":"An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.
" + }, + "LoadBalancerTlsCertificateDnsRecordCreationStateCode":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "STARTED", + "FAILED" + ] + }, "LoadBalancerTlsCertificateDomainStatus":{ "type":"string", "enum":[ @@ -9368,6 +9432,10 @@ "domainName":{ "shape":"DomainName", "documentation":"The domain name against which your SSL/TLS certificate was validated.
" + }, + "dnsRecordCreationState":{ + "shape":"LoadBalancerTlsCertificateDnsRecordCreationState", + "documentation":"An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership.
" } }, "documentation":"Describes the validation record of each domain name in the SSL/TLS certificate.
" @@ -9654,6 +9722,29 @@ }, "documentation":"Describes the monthly data transfer in and out of your virtual private server (or instance).
" }, + "NameServersUpdateState":{ + "type":"structure", + "members":{ + "code":{ + "shape":"NameServersUpdateStateCode", + "documentation":"The status code for the name servers update.
Following are the possible values:
SUCCEEDED - The name server records were successfully updated.
PENDING - The name server record update is in progress.
FAILED - The name server record update failed.
STARTED - The automatic name server record update started.
The message that describes the reason for the status code.
" + } + }, + "documentation":"Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.
For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + }, + "NameServersUpdateStateCode":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "PENDING", + "FAILED", + "STARTED" + ] + }, "NetworkProtocol":{ "type":"string", "enum":[ @@ -10171,6 +10262,29 @@ }, "documentation":"Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.
" }, + "R53HostedZoneDeletionState":{ + "type":"structure", + "members":{ + "code":{ + "shape":"R53HostedZoneDeletionStateCode", + "documentation":"The status code for the deletion state.
Following are the possible values:
SUCCEEDED - The hosted zone was successfully deleted.
PENDING - The hosted zone deletion is in progress.
FAILED - The hosted zone deletion failed.
STARTED - The hosted zone deletion started.
The message that describes the reason for the status code.
" + } + }, + "documentation":"Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.
" + }, + "R53HostedZoneDeletionStateCode":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "PENDING", + "FAILED", + "STARTED" + ] + }, "RebootInstanceRequest":{ "type":"structure", "required":["instanceName"], @@ -10226,7 +10340,7 @@ }, "description":{ "shape":"string", - "documentation":"The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).
The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).
The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
Describes the AWS Region.
" + "documentation":"Describes the Amazon Web Services Region.
" }, "RegionList":{ "type":"list", @@ -10302,6 +10416,17 @@ } } }, + "RegisteredDomainDelegationInfo":{ + "type":"structure", + "members":{ + "nameServersUpdateState":{ + "shape":"NameServersUpdateState", + "documentation":"An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.
" + }, + "r53HostedZoneDeletionState":{"shape":"R53HostedZoneDeletionState"} + }, + "documentation":"Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.
When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.
All of the following conditions must be true for automatic domain delegation to be successful:
The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.
The user or entity making the request must have permission to manage domains in Route 53.
The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.
If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + }, "RelationalDatabase":{ "type":"structure", "members":{ @@ -10787,7 +10912,7 @@ }, "regionName":{ "shape":"RegionName", - "documentation":"The AWS Region name.
" + "documentation":"The Amazon Web Services Region name.
" } }, "documentation":"Describes the resource location.
" @@ -11556,7 +11681,7 @@ }, "preferredMaintenanceWindow":{ "shape":"string", - "documentation":"The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30
The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
" + "documentation":"Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
" } diff --git a/services/location/pom.xml b/services/location/pom.xml index 97677b192f0e..ec9e116877a8 100644 --- a/services/location/pom.xml +++ b/services/location/pom.xml @@ -21,7 +21,7 @@Allows the remote domain owner to accept an inbound cross-cluster connection request.
" + "documentation":"Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "AddTags":{ "name":"AddTags", @@ -38,7 +38,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
" + "documentation":"Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
" }, "AssociatePackage":{ "name":"AssociatePackage", @@ -56,7 +56,25 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"} ], - "documentation":"Associates a package with an Amazon OpenSearch Service domain.
" + "documentation":"Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
" + }, + "AuthorizeVpcEndpointAccess":{ + "name":"AuthorizeVpcEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess" + }, + "input":{"shape":"AuthorizeVpcEndpointAccessRequest"}, + "output":{"shape":"AuthorizeVpcEndpointAccessResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"BaseException"} + ], + "documentation":"Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
" }, "CancelServiceSoftwareUpdate":{ "name":"CancelServiceSoftwareUpdate", @@ -72,7 +90,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
" + "documentation":"Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
" }, "CreateOutboundConnection":{ "name":"CreateOutboundConnection", @@ -107,7 +125,7 @@ {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
" + "documentation":"Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "CreatePackage":{ "name":"CreatePackage", @@ -126,7 +144,25 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Create a package for use with Amazon OpenSearch Service domains.
" + "documentation":"Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/vpcEndpoints" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"}, + {"shape":"BaseException"} + ], + "documentation":"Creates an Amazon OpenSearch Service-managed VPC endpoint.
" }, "DeleteDomain":{ "name":"DeleteDomain", @@ -142,7 +178,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
" + "documentation":"Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
" }, "DeleteInboundConnection":{ "name":"DeleteInboundConnection", @@ -156,7 +192,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Allows the remote domain owner to delete an existing inbound cross-cluster connection.
" + "documentation":"Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "DeleteOutboundConnection":{ "name":"DeleteOutboundConnection", @@ -170,7 +206,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Allows the local domain owner to delete an existing outbound cross-cluster connection.
" + "documentation":"Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "DeletePackage":{ "name":"DeletePackage", @@ -188,7 +224,23 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"} ], - "documentation":"Deletes the package.
" + "documentation":"Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
" + }, + "DeleteVpcEndpoint":{ + "name":"DeleteVpcEndpoint", + "http":{ + "method":"DELETE", + "requestUri":"/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}" + }, + "input":{"shape":"DeleteVpcEndpointRequest"}, + "output":{"shape":"DeleteVpcEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"}, + {"shape":"BaseException"} + ], + "documentation":"Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
" }, "DescribeDomain":{ "name":"DescribeDomain", @@ -204,7 +256,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
" + "documentation":"Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
" }, "DescribeDomainAutoTunes":{ "name":"DescribeDomainAutoTunes", @@ -220,7 +272,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
" + "documentation":"Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "DescribeDomainChangeProgress":{ "name":"DescribeDomainChangeProgress", @@ -236,7 +288,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
" + "documentation":"Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
" }, "DescribeDomainConfig":{ "name":"DescribeDomainConfig", @@ -252,7 +304,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
" + "documentation":"Returns the configuration of an Amazon OpenSearch Service domain.
" }, "DescribeDomains":{ "name":"DescribeDomains", @@ -267,7 +319,7 @@ {"shape":"InternalException"}, {"shape":"ValidationException"} ], - "documentation":"Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
" + "documentation":"Returns domain configuration information about the specified Amazon OpenSearch Service domains.
" }, "DescribeInboundConnections":{ "name":"DescribeInboundConnections", @@ -281,7 +333,7 @@ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Lists all the inbound cross-cluster connections for a remote domain.
" + "documentation":"Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "DescribeInstanceTypeLimits":{ "name":"DescribeInstanceTypeLimits", @@ -299,7 +351,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":" Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
" }, "DescribeOutboundConnections":{ "name":"DescribeOutboundConnections", @@ -313,7 +365,7 @@ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Lists all the outbound cross-cluster connections for a local domain.
" + "documentation":"Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "DescribePackages":{ "name":"DescribePackages", @@ -330,7 +382,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
" + "documentation":"Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "DescribeReservedInstanceOfferings":{ "name":"DescribeReservedInstanceOfferings", @@ -346,7 +398,7 @@ {"shape":"DisabledOperationException"}, {"shape":"InternalException"} ], - "documentation":"Lists available reserved OpenSearch instance offerings.
" + "documentation":"Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", @@ -362,7 +414,23 @@ {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Returns information about reserved OpenSearch instances for this account.
" + "documentation":"Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/vpcEndpoints/describe" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"}, + {"shape":"BaseException"} + ], + "documentation":"Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
" }, "DissociatePackage":{ "name":"DissociatePackage", @@ -380,7 +448,7 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"} ], - "documentation":"Dissociates a package from the Amazon OpenSearch Service domain.
" + "documentation":"Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "GetCompatibleVersions":{ "name":"GetCompatibleVersions", @@ -397,7 +465,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":" Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
" }, "GetPackageVersionHistory":{ "name":"GetPackageVersionHistory", @@ -414,7 +482,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Returns a list of package versions, along with their creation time and commit message.
" + "documentation":"Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "GetUpgradeHistory":{ "name":"GetUpgradeHistory", @@ -431,7 +499,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Retrieves the complete history of the last 10 upgrades performed on the domain.
" + "documentation":"Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
" }, "GetUpgradeStatus":{ "name":"GetUpgradeStatus", @@ -448,7 +516,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
" + "documentation":"Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
" }, "ListDomainNames":{ "name":"ListDomainNames", @@ -462,7 +530,7 @@ {"shape":"BaseException"}, {"shape":"ValidationException"} ], - "documentation":"Returns the names of all domains owned by the current user's account.
" + "documentation":"Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
" }, "ListDomainsForPackage":{ "name":"ListDomainsForPackage", @@ -479,7 +547,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Lists all Amazon OpenSearch Service domains associated with the package.
" + "documentation":"Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "ListInstanceTypeDetails":{ "name":"ListInstanceTypeDetails", @@ -494,7 +562,8 @@ {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} - ] + ], + "documentation":"Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
" }, "ListPackagesForDomain":{ "name":"ListPackagesForDomain", @@ -511,7 +580,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Lists all packages associated with the Amazon OpenSearch Service domain.
" + "documentation":"Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "ListTags":{ "name":"ListTags", @@ -527,7 +596,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Returns all tags for the given domain.
" + "documentation":"Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
" }, "ListVersions":{ "name":"ListVersions", @@ -543,7 +612,54 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"List all supported versions of OpenSearch and Elasticsearch.
" + "documentation":"Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
" + }, + "ListVpcEndpointAccess":{ + "name":"ListVpcEndpointAccess", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess" + }, + "input":{"shape":"ListVpcEndpointAccessRequest"}, + "output":{"shape":"ListVpcEndpointAccessResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"}, + {"shape":"BaseException"} + ], + "documentation":"Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
" + }, + "ListVpcEndpoints":{ + "name":"ListVpcEndpoints", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/vpcEndpoints" + }, + "input":{"shape":"ListVpcEndpointsRequest"}, + "output":{"shape":"ListVpcEndpointsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"}, + {"shape":"BaseException"} + ], + "documentation":"Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
" + }, + "ListVpcEndpointsForDomain":{ + "name":"ListVpcEndpointsForDomain", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints" + }, + "input":{"shape":"ListVpcEndpointsForDomainRequest"}, + "output":{"shape":"ListVpcEndpointsForDomainResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"BaseException"} + ], + "documentation":"Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
" }, "PurchaseReservedInstanceOffering":{ "name":"PurchaseReservedInstanceOffering", @@ -561,7 +677,7 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Allows you to purchase reserved OpenSearch instances.
" + "documentation":"Allows you to purchase Amazon OpenSearch Service Reserved Instances.
" }, "RejectInboundConnection":{ "name":"RejectInboundConnection", @@ -575,7 +691,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], - "documentation":"Allows the remote domain owner to reject an inbound cross-cluster connection request.
" + "documentation":"Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
" }, "RemoveTags":{ "name":"RemoveTags", @@ -589,7 +705,24 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Removes the specified set of tags from the given domain.
" + "documentation":"Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
" + }, + "RevokeVpcEndpointAccess":{ + "name":"RevokeVpcEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess" + }, + "input":{"shape":"RevokeVpcEndpointAccessRequest"}, + "output":{"shape":"RevokeVpcEndpointAccessResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"}, + {"shape":"BaseException"} + ], + "documentation":"Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
" }, "StartServiceSoftwareUpdate":{ "name":"StartServiceSoftwareUpdate", @@ -605,7 +738,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Schedules a service software update for an Amazon OpenSearch Service domain.
" + "documentation":"Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
" }, "UpdateDomainConfig":{ "name":"UpdateDomainConfig", @@ -623,7 +756,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
" + "documentation":"Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
" }, "UpdatePackage":{ "name":"UpdatePackage", @@ -641,7 +774,25 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Updates a package for use with Amazon OpenSearch Service domains.
" + "documentation":"Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
" + }, + "UpdateVpcEndpoint":{ + "name":"UpdateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/vpcEndpoints/update" + }, + "input":{"shape":"UpdateVpcEndpointRequest"}, + "output":{"shape":"UpdateVpcEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"BaseException"} + ], + "documentation":"Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
" }, "UpgradeDomain":{ "name":"UpgradeDomain", @@ -659,25 +810,39 @@ {"shape":"ValidationException"}, {"shape":"InternalException"} ], - "documentation":"Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
" + "documentation":"Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
" } }, "shapes":{ "ARN":{ "type":"string", - "documentation":"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
", + "documentation":"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
", "max":2048, "min":20, "pattern":".*" }, + "AWSAccount":{ + "type":"string", + "pattern":"^[0-9]+$" + }, "AWSDomainInformation":{ "type":"structure", "required":["DomainName"], "members":{ - "OwnerId":{"shape":"OwnerId"}, - "DomainName":{"shape":"DomainName"}, - "Region":{"shape":"Region"} - } + "OwnerId":{ + "shape":"OwnerId", + "documentation":"The Amazon Web Services account ID of the domain owner.
" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the domain.
" + }, + "Region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Region in which the domain is located.
" + } + }, + "documentation":"Information about an Amazon OpenSearch Service domain.
" }, "AcceptInboundConnectionRequest":{ "type":"structure", @@ -685,22 +850,22 @@ "members":{ "ConnectionId":{ "shape":"ConnectionId", - "documentation":"The ID of the inbound connection you want to accept.
", + "documentation":"The ID of the inbound connection to accept.
", "location":"uri", "locationName":"ConnectionId" } }, - "documentation":"Container for the parameters to the AcceptInboundConnection operation.
Container for the parameters to the AcceptInboundConnection operation.
The InboundConnection of the accepted inbound connection.
Information about the accepted inbound connection.
" } }, - "documentation":"The result of an AcceptInboundConnection operation. Contains details about the accepted inbound connection.
Contains details about the accepted inbound connection.
" }, "AccessDeniedException":{ "type":"structure", @@ -719,14 +884,14 @@ "members":{ "Options":{ "shape":"PolicyDocument", - "documentation":"The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.
" + "documentation":"The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"The status of the access policy for the domain. See OptionStatus for the status information that's included.
The status of the access policy for the domain.
" } }, - "documentation":"The configured access rules for the domain's document and search endpoints, and the current status of those rules.
" + "documentation":"The configured access rules for the domain's search endpoint, and the current status of those rules.
" }, "AddTagsRequest":{ "type":"structure", @@ -737,28 +902,28 @@ "members":{ "ARN":{ "shape":"ARN", - "documentation":"Specify the ARN of the domain you want to add tags to.
Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
" }, "TagList":{ "shape":"TagList", - "documentation":"List of Tag to add to the domain.
List of resource tags.
" } }, - "documentation":"Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
Additional limit is specific to a given InstanceType and for each of its InstanceRole etc.
Attributes and their details:
ESPartitionInstanceType can support as master node. ESPartitionInstanceType up to which you don't need any master nodes to govern them. MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
Value for a given AdditionalLimit$LimitName .
The values of the additional instance type limits.
" } }, - "documentation":" List of limits that are specific to a given InstanceType and for each of its InstanceRole .
List of limits that are specific to a given instance type.
" }, "AdditionalLimitList":{ "type":"list", @@ -768,7 +933,7 @@ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, - "documentation":"Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
" + "documentation":"Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:
Allows references to indexes in an HTTP request body. Must be false when configuring access to individual sub-resources. Default is true.
Specifies the percentage of heap space allocated to field data. Default is unbounded.
For more information, see Advanced cluster parameters.
" }, "AdvancedOptionsStatus":{ "type":"structure", @@ -783,17 +948,17 @@ }, "Status":{ "shape":"OptionStatus", - "documentation":"The OptionStatus for advanced options for the specified domain.
The status of advanced options for the specified domain.
" } }, - "documentation":"Status of the advanced options for the specified domain. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
" + "documentation":"Status of the advanced options for the specified domain. The following options are available:
\"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
\"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
\"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
\"override_main_response_version\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
" }, "AdvancedSecurityOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"True if advanced security is enabled.
" + "documentation":"True if fine-grained access control is enabled.
" }, "InternalUserDatabaseEnabled":{ "shape":"Boolean", @@ -801,44 +966,44 @@ }, "SAMLOptions":{ "shape":"SAMLOptionsOutput", - "documentation":"Describes the SAML application configured for a domain.
" + "documentation":"Container for information about the SAML configuration for OpenSearch Dashboards.
" }, "AnonymousAuthDisableDate":{ "shape":"DisableTimestamp", - "documentation":"Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
" + "documentation":"Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
" }, "AnonymousAuthEnabled":{ "shape":"Boolean", - "documentation":"True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + "documentation":"True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
" } }, - "documentation":"The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
" + "documentation":"Container for fine-grained access control settings.
" }, "AdvancedSecurityOptionsInput":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"True if advanced security is enabled.
" + "documentation":"True to enable fine-grained access control.
" }, "InternalUserDatabaseEnabled":{ "shape":"Boolean", - "documentation":"True if the internal user database is enabled.
" + "documentation":"True to enable the internal user database.
" }, "MasterUserOptions":{ "shape":"MasterUserOptions", - "documentation":"Credentials for the master user: username and password, ARN, or both.
" + "documentation":"Container for information about the master user.
" }, "SAMLOptions":{ "shape":"SAMLOptionsInput", - "documentation":"The SAML application configuration for the domain.
" + "documentation":"Container for information about the SAML configuration for OpenSearch Dashboards.
" }, "AnonymousAuthEnabled":{ "shape":"Boolean", - "documentation":"True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + "documentation":"True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
" } }, - "documentation":"The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
" + "documentation":"Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.
" }, "AdvancedSecurityOptionsStatus":{ "type":"structure", @@ -849,14 +1014,14 @@ "members":{ "Options":{ "shape":"AdvancedSecurityOptions", - "documentation":"Advanced security options for the specified domain.
" + "documentation":"Container for fine-grained access control settings.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"Status of the advanced security options for the specified domain.
" + "documentation":"Status of the fine-grained access control settings for a domain.
" } }, - "documentation":"The status of advanced security options for the specified domain.
" + "documentation":"The status of fine-grained access control settings for a domain.
" }, "AssociatePackageRequest":{ "type":"structure", @@ -873,36 +1038,83 @@ }, "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain to associate the package with.
", + "documentation":"Name of the domain to associate the package with.
", "location":"uri", "locationName":"DomainName" } }, - "documentation":" Container for the request parameters to the AssociatePackage operation.
Container for the request parameters to the AssociatePackage operation.
DomainPackageDetails
Information about a package that is associated with a domain.
" } }, - "documentation":" Container for the response returned by AssociatePackage operation.
Container for the response returned by the AssociatePackage operation.
The name of the OpenSearch Service domain to provide access to.
", + "location":"uri", + "locationName":"DomainName" + }, + "Account":{ + "shape":"AWSAccount", + "documentation":"The Amazon Web Services account ID to grant access to.
" + } + } + }, + "AuthorizeVpcEndpointAccessResponse":{ + "type":"structure", + "required":["AuthorizedPrincipal"], + "members":{ + "AuthorizedPrincipal":{ + "shape":"AuthorizedPrincipal", + "documentation":"Information about the Amazon Web Services account or service that was provided access to the domain.
" + } + } + }, + "AuthorizedPrincipal":{ + "type":"structure", + "members":{ + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"The type of principal.
" + }, + "Principal":{ + "shape":"String", + "documentation":"The IAM principal that is allowed access to the domain.
" + } + }, + "documentation":"Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
" + }, + "AuthorizedPrincipalList":{ + "type":"list", + "member":{"shape":"AuthorizedPrincipal"} }, "AutoTune":{ "type":"structure", "members":{ "AutoTuneType":{ "shape":"AutoTuneType", - "documentation":"Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
" + "documentation":"The type of Auto-Tune action.
" }, "AutoTuneDetails":{ "shape":"AutoTuneDetails", - "documentation":"Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"Details about an Auto-Tune action.
" } }, - "documentation":"Specifies the Auto-Tune type and Auto-Tune action details.
" + "documentation":"Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneDate":{ "type":"timestamp", @@ -919,9 +1131,12 @@ "AutoTuneDetails":{ "type":"structure", "members":{ - "ScheduledAutoTuneDetails":{"shape":"ScheduledAutoTuneDetails"} + "ScheduledAutoTuneDetails":{ + "shape":"ScheduledAutoTuneDetails", + "documentation":"Container for details about a scheduled Auto-Tune action.
" + } }, - "documentation":"Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneList":{ "type":"list", @@ -932,18 +1147,18 @@ "members":{ "StartAt":{ "shape":"StartAt", - "documentation":"The timestamp at which the Auto-Tune maintenance schedule starts.
" + "documentation":"The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
" }, "Duration":{ "shape":"Duration", - "documentation":"Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"The duration of the maintenance schedule. For example, \"Duration\": {\"Value\": 2, \"Unit\": \"HOURS\"}.
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
" } }, - "documentation":"Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneMaintenanceScheduleList":{ "type":"list", @@ -955,64 +1170,64 @@ "members":{ "DesiredState":{ "shape":"AutoTuneDesiredState", - "documentation":"The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
" + "documentation":"Whether Auto-Tune is enabled or disabled.
" }, "RollbackOnDisable":{ "shape":"RollbackOnDisable", - "documentation":"The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
" + "documentation":"When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"A list of maintenance schedules during which Auto-Tune can deploy changes.
" } }, - "documentation":"The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
" + "documentation":"Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneOptionsInput":{ "type":"structure", "members":{ "DesiredState":{ "shape":"AutoTuneDesiredState", - "documentation":"The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
" + "documentation":"Whether Auto-Tune is enabled or disabled.
" }, "MaintenanceSchedules":{ "shape":"AutoTuneMaintenanceScheduleList", - "documentation":"A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.
The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
" + "documentation":"Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneOptionsOutput":{ "type":"structure", "members":{ "State":{ "shape":"AutoTuneState", - "documentation":"The AutoTuneState for the domain.
The current state of Auto-Tune on the domain.
" }, "ErrorMessage":{ "shape":"String", - "documentation":"The error message while enabling or disabling Auto-Tune.
" + "documentation":"Any errors that occurred while enabling or disabling Auto-Tune.
" } }, - "documentation":"The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
" + "documentation":"The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
" }, "AutoTuneOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"AutoTuneOptions", - "documentation":"Specifies Auto-Tune options for the domain.
" + "documentation":"Auto-Tune settings for updating a domain.
" }, "Status":{ "shape":"AutoTuneStatus", - "documentation":"The status of the Auto-Tune options for the domain.
" + "documentation":"The current status of Auto-Tune for a domain.
" } }, "documentation":"The Auto-Tune status for the domain.
" }, "AutoTuneState":{ "type":"string", - "documentation":"The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
", + "documentation":"The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
", "enum":[ "ENABLED", "DISABLED", @@ -1035,11 +1250,11 @@ "members":{ "CreationDate":{ "shape":"UpdateTimestamp", - "documentation":"The timestamp of the Auto-Tune options creation date.
" + "documentation":"Date and time when Auto-Tune was enabled for the domain.
" }, "UpdateDate":{ "shape":"UpdateTimestamp", - "documentation":"The timestamp of when the Auto-Tune options were last updated.
" + "documentation":"Date and time when the Auto-Tune options were last updated for the domain.
" }, "UpdateVersion":{ "shape":"UIntValue", @@ -1047,18 +1262,18 @@ }, "State":{ "shape":"AutoTuneState", - "documentation":"The AutoTuneState for the domain.
The current state of Auto-Tune on the domain.
" }, "ErrorMessage":{ "shape":"String", - "documentation":"The error message while enabling or disabling Auto-Tune.
" + "documentation":"Any errors that occurred while enabling or disabling Auto-Tune.
" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"Indicates whether the domain is being deleted.
" } }, - "documentation":"Provides the current Auto-Tune status for the domain.
" + "documentation":"The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "AutoTuneType":{ "type":"string", @@ -1088,56 +1303,56 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain that you want to stop the latest service software update on.
" + "documentation":"Name of the OpenSearch Service domain that you want to cancel the service software update on.
" } }, - "documentation":"Container for the parameters to the CancelServiceSoftwareUpdate operation. Specifies the name of the domain that you wish to cancel a service software update on.
Container for the request parameters to cancel a service software update.
" }, "CancelServiceSoftwareUpdateResponse":{ "type":"structure", "members":{ "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", - "documentation":"The current status of the OpenSearch service software update.
" + "documentation":"Container for the state of your domain relative to the latest service software.
" } }, - "documentation":"The result of a CancelServiceSoftwareUpdate operation. Contains the status of the update.
Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.
The unique change identifier associated with a specific domain configuration change.
" + "documentation":"The ID of the configuration change.
" }, "Message":{ "shape":"Message", - "documentation":"Contains an optional message associated with the domain configuration change.
" + "documentation":"A message corresponding to the status of the configuration change.
" } }, - "documentation":"Specifies change details of the domain configuration change.
" + "documentation":"Container for information about a configuration change happening on a domain.
" }, "ChangeProgressStage":{ "type":"structure", "members":{ "Name":{ "shape":"ChangeProgressStageName", - "documentation":"The name of the specific progress stage.
" + "documentation":"The name of the stage.
" }, "Status":{ "shape":"ChangeProgressStageStatus", - "documentation":"The overall status of a specific progress stage.
" + "documentation":"The status of the stage.
" }, "Description":{ "shape":"Description", - "documentation":"The description of the progress stage.
" + "documentation":"The description of the stage.
" }, "LastUpdated":{ "shape":"LastUpdated", - "documentation":"The last updated timestamp of the progress stage.
" + "documentation":"The most recent updated timestamp of the stage.
" } }, - "documentation":"A progress stage details of a specific domain configuration change.
" + "documentation":"Progress details for each stage of a domain update.
" }, "ChangeProgressStageList":{ "type":"list", @@ -1167,15 +1382,15 @@ }, "Status":{ "shape":"OverallChangeStatus", - "documentation":"The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
The overall status of the domain configuration change.
" }, "PendingProperties":{ "shape":"StringList", - "documentation":"The list of properties involved in the domain configuration change that are still in pending.
" + "documentation":"The list of properties in the domain configuration change that are still pending.
" }, "CompletedProperties":{ "shape":"StringList", - "documentation":"The list of properties involved in the domain configuration change that are completed.
" + "documentation":"The list of properties in the domain configuration change that have completed.
" }, "TotalNumberOfStages":{ "shape":"TotalNumberOfStages", @@ -1188,6 +1403,11 @@ }, "documentation":"The progress details of a specific domain configuration change.
" }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1 + }, "CloudWatchLogsLogGroupArn":{ "type":"string", "documentation":"ARN of the Cloudwatch log group to publish logs to.
", @@ -1200,50 +1420,50 @@ "members":{ "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", - "documentation":"The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
" + "documentation":"Instance type of data nodes in the cluster.
" }, "InstanceCount":{ "shape":"IntegerClass", - "documentation":"The number of instances in the specified domain cluster.
" + "documentation":"Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
" }, "DedicatedMasterEnabled":{ "shape":"Boolean", - "documentation":"A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
" + "documentation":"Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
" + "documentation":"Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
" }, "ZoneAwarenessConfig":{ "shape":"ZoneAwarenessConfig", - "documentation":"The zone awareness configuration for a domain when zone awareness is enabled.
" + "documentation":"Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.
The instance type for a dedicated master node.
" + "documentation":"OpenSearch Service instance type of the dedicated master nodes in the cluster.
" }, "DedicatedMasterCount":{ "shape":"IntegerClass", - "documentation":"Total number of dedicated master nodes, active and on standby, for the cluster.
" + "documentation":"Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
" }, "WarmEnabled":{ "shape":"Boolean", - "documentation":"True to enable UltraWarm storage.
" + "documentation":"Whether to enable warm storage for the cluster.
" }, "WarmType":{ "shape":"OpenSearchWarmPartitionInstanceType", - "documentation":"The instance type for the OpenSearch cluster's warm nodes.
" + "documentation":"The instance type for the cluster's warm nodes.
" }, "WarmCount":{ "shape":"IntegerClass", - "documentation":"The number of UltraWarm nodes in the cluster.
" + "documentation":"The number of warm nodes in the cluster.
" }, "ColdStorageOptions":{ "shape":"ColdStorageOptions", - "documentation":"Specifies the ColdStorageOptions config for a Domain
Container for cold storage configuration options.
" } }, - "documentation":"The configuration for the domain cluster, such as the type and number of instances.
" + "documentation":"Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
" }, "ClusterConfigStatus":{ "type":"structure", @@ -1254,36 +1474,36 @@ "members":{ "Options":{ "shape":"ClusterConfig", - "documentation":"The cluster configuration for the specified domain.
" + "documentation":"Cluster configuration options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"The cluster configuration status for the specified domain.
" + "documentation":"The status of cluster configuration options for the specified domain.
" } }, - "documentation":"The configuration status for the specified domain.
" + "documentation":"The cluster configuration status for a domain.
" }, "CognitoOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The option to enable Cognito for OpenSearch Dashboards authentication.
" + "documentation":"Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
" }, "UserPoolId":{ "shape":"UserPoolId", - "documentation":"The Cognito user pool ID for OpenSearch Dashboards authentication.
" + "documentation":"The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
" }, "IdentityPoolId":{ "shape":"IdentityPoolId", - "documentation":"The Cognito identity pool ID for OpenSearch Dashboards authentication.
" + "documentation":"The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
" }, "RoleArn":{ "shape":"RoleArn", - "documentation":"The role ARN that provides OpenSearch permissions for accessing Cognito resources.
" + "documentation":"The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" + "documentation":"Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" }, "CognitoOptionsStatus":{ "type":"structure", @@ -1309,10 +1529,10 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"Enable cold storage option. Accepted values true or false
" + "documentation":"Whether to enable or disable cold storage on the domain.
" } }, - "documentation":"Specifies the configuration for cold storage options such as enabled
" + "documentation":"Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.
" }, "CommitMessage":{ "type":"string", @@ -1327,11 +1547,14 @@ "members":{ "SourceVersion":{ "shape":"VersionString", - "documentation":"The current version of OpenSearch a domain is on.
" + "documentation":"The current version that the OpenSearch Service domain is running.
" }, - "TargetVersions":{"shape":"VersionList"} + "TargetVersions":{ + "shape":"VersionList", + "documentation":"The possible versions that you can upgrade the domain to.
" + } }, - "documentation":" A map from an EngineVersion to a list of compatible EngineVersion s to which the domain can be upgraded.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
" }, "ConflictException":{ "type":"structure", @@ -1360,67 +1583,67 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
" + "documentation":"Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
" }, "EngineVersion":{ "shape":"VersionString", - "documentation":"String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, \"OpenSearch_1.0\" or \"Elasticsearch_7.9\". For more information, see Creating and managing Amazon OpenSearch Service domains .
" + "documentation":"String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
" + "documentation":"Container for the cluster configuration of a domain.
" }, "EBSOptions":{ "shape":"EBSOptions", - "documentation":"Options to enable, disable, and specify the type and size of EBS storage volumes.
" + "documentation":"Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
" }, "AccessPolicies":{ "shape":"PolicyDocument", - "documentation":"IAM access policy as a JSON-formatted string.
" + "documentation":"Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
" }, "SnapshotOptions":{ "shape":"SnapshotOptions", - "documentation":"Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
" + "documentation":"DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
" }, "VPCOptions":{ "shape":"VPCOptions", - "documentation":"Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
" + "documentation":"Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" }, "CognitoOptions":{ "shape":"CognitoOptions", - "documentation":"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" + "documentation":"Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", - "documentation":"Options for encryption of data at rest.
" + "documentation":"Key-value pairs to enable encryption at rest.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", - "documentation":"Node-to-node encryption options.
" + "documentation":"Enables node-to-node encryption.
" }, "AdvancedOptions":{ "shape":"AdvancedOptions", - "documentation":"Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
\"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
\"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
\"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
\"override_main_response_version\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", - "documentation":"Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
Key-value pairs to configure slow log publishing.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", - "documentation":"Options to specify configurations that will be applied to the domain endpoint.
" + "documentation":"Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", - "documentation":"Specifies advanced security options.
" + "documentation":"Options for fine-grained access control.
" }, "TagList":{ "shape":"TagList", - "documentation":"A list of Tag added during domain creation.
List of tags to add to the domain upon creation.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsInput", - "documentation":"Specifies Auto-Tune options.
" + "documentation":"Options for Auto-Tune.
" } } }, @@ -1432,7 +1655,7 @@ "documentation":"The status of the newly created domain.
" } }, - "documentation":"The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.
The result of a CreateDomain operation. Contains the status of the newly created domain.
The AWSDomainInformation for the local OpenSearch domain.
Name and Region of the source (local) domain.
" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", - "documentation":"The AWSDomainInformation for the remote OpenSearch domain.
Name and Region of the destination (remote) domain.
" }, "ConnectionAlias":{ "shape":"ConnectionAlias", - "documentation":"The connection alias used used by the customer for this cross-cluster connection.
" + "documentation":"Name of the connection.
" } }, - "documentation":"Container for the parameters to the CreateOutboundConnection operation.
Container for the parameters to the CreateOutboundConnection operation.
The AWSDomainInformation for the local OpenSearch domain.
Information about the source (local) domain.
" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", - "documentation":"The AWSDomainInformation for the remote OpenSearch domain.
Information about the destination (remote) domain.
" }, "ConnectionAlias":{ "shape":"ConnectionAlias", - "documentation":"The connection alias provided during the create connection request.
" + "documentation":"Name of the connection.
" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", - "documentation":"The OutboundConnectionStatus for the newly created connection.
The status of the connection.
" }, "ConnectionId":{ "shape":"ConnectionId", - "documentation":"The unique ID for the created outbound connection, which is used for subsequent operations on the connection.
" + "documentation":"The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
" } }, - "documentation":"The result of a CreateOutboundConnection request. Contains the details about the newly created cross-cluster connection.
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
Unique identifier for the package.
" + "documentation":"Unique name for the package.
" }, "PackageType":{ "shape":"PackageType", - "documentation":"Type of package. Currently supports only TXT-DICTIONARY.
" + "documentation":"Type of package.
" }, "PackageDescription":{ "shape":"PackageDescription", @@ -1505,20 +1728,51 @@ }, "PackageSource":{ "shape":"PackageSource", - "documentation":"The Amazon S3 location from which to import the package.
" + "documentation":"The Amazon S3 location from which to import the package.
" } }, - "documentation":" Container for request parameters to the CreatePackage operation.
Container for request parameters to the CreatePackage operation.
Information about the package.
" + "documentation":"Basic information about an OpenSearch Service package.
" } }, - "documentation":" Container for the response returned by the CreatePackage operation.
Container for the response returned by the CreatePackage operation.
The Amazon Resource Name (ARN) of the domain to grant access to.
" + }, + "VpcOptions":{ + "shape":"VPCOptions", + "documentation":"Options to specify the subnets and security groups for the endpoint.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
" + } + } + }, + "CreateVpcEndpointResponse":{ + "type":"structure", + "required":["VpcEndpoint"], + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"Information about the newly created VPC endpoint.
" + } + } }, "CreatedAt":{"type":"timestamp"}, "DeleteDomainRequest":{ @@ -1532,7 +1786,7 @@ "locationName":"DomainName" } }, - "documentation":"Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
Container for the parameters to the DeleteDomain operation.
The status of the domain being deleted.
" } }, - "documentation":"The result of a DeleteDomain request. Contains the status of the pending deletion, or a \"domain not found\" error if the domain and all of its resources have been deleted.
The results of a DeleteDomain request. Contains the status of the pending deletion, or a \"domain not found\" error if the domain and all of its resources have been deleted.
Container for the parameters to the DeleteInboundConnection operation.
Container for the parameters to the DeleteInboundConnection operation.
The InboundConnection of the deleted inbound connection.
The deleted inbound connection.
" } }, - "documentation":"The result of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection operation.
Container for the parameters to the DeleteOutboundConnection operation.
The OutboundConnection of the deleted outbound connection.
The deleted inbound connection.
" } }, - "documentation":"The result of a DeleteOutboundConnection operation. Contains details about the deleted outbound connection.
Details about the deleted outbound connection.
" }, "DeletePackageRequest":{ "type":"structure", @@ -1596,22 +1850,44 @@ "members":{ "PackageID":{ "shape":"PackageID", - "documentation":"The internal ID of the package you want to delete. Use DescribePackages to find this value.
The internal ID of the package you want to delete. Use DescribePackages to find this value.
Container for the request parameters to the DeletePackage operation.
Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
" }, "DeletePackageResponse":{ "type":"structure", "members":{ "PackageDetails":{ "shape":"PackageDetails", - "documentation":" PackageDetails
Information about the deleted package.
" } }, - "documentation":" Container for the response parameters to the DeletePackage operation.
Container for the response parameters to the DeletePackage operation.
The unique identifier of the endpoint.
", + "location":"uri", + "locationName":"VpcEndpointId" + } + } + }, + "DeleteVpcEndpointResponse":{ + "type":"structure", + "required":["VpcEndpointSummary"], + "members":{ + "VpcEndpointSummary":{ + "shape":"VpcEndpointSummary", + "documentation":"Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).
The domain name for which you want Auto-Tune action details.
", + "documentation":"Name of the domain that you want Auto-Tune details about.
", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
" + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.
" + "documentation":"If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
Container for the parameters to the DescribeDomainAutoTunes operation.
Container for the parameters to the DescribeDomainAutoTunes operation.
The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"The list of setting adjustments that Auto-Tune has made to the domain.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"An identifier to allow retrieval of paginated results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service for more information.
The result of a DescribeDomainAutoTunes request.
The domain you want to get the progress information about.
", + "documentation":"The name of the domain to get progress information for.
", "location":"uri", "locationName":"DomainName" }, "ChangeId":{ "shape":"GUID", - "documentation":"The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
", + "documentation":"The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
", "location":"querystring", "locationName":"changeid" } }, - "documentation":"Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.
Container for the parameters to the DescribeDomainChangeProgress operation.
Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
Container for information about the stages of a configuration change happening on a domain.
" } }, - "documentation":"The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.
The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.
The domain you want to get information about.
", + "documentation":"Name of the OpenSearch Service domain configuration that you want to describe.
", "location":"uri", "locationName":"DomainName" } }, - "documentation":"Container for the parameters to the DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.
Container for the parameters to the DescribeDomainConfig operation.
The configuration information of the domain requested in the DescribeDomainConfig request.
Container for the configuration of the OpenSearch Service domain.
" } }, - "documentation":"The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.
Contains the configuration information of the requested domain.
" }, "DescribeDomainRequest":{ "type":"structure", @@ -1723,12 +1999,12 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain for which you want information.
", + "documentation":"The name of the domain that you want information about.
", "location":"uri", "locationName":"DomainName" } }, - "documentation":"Container for the parameters to the DescribeDomain operation.
Container for the parameters to the DescribeDomain operation.
The current status of the domain.
" + "documentation":"List that contains the status of each specified OpenSearch Service domain.
" } }, - "documentation":"The result of a DescribeDomain request. Contains the status of the domain specified in the request.
Contains the status of the domain specified in the request.
" }, "DescribeDomainsRequest":{ "type":"structure", @@ -1747,10 +2023,10 @@ "members":{ "DomainNames":{ "shape":"DomainNameList", - "documentation":"The domains for which you want information.
" + "documentation":"Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.
" } }, - "documentation":"Container for the parameters to the DescribeDomains operation. By default, the API returns the status of all domains.
Container for the parameters to the DescribeDomains operation.
The status of the domains requested in the DescribeDomains request.
The status of the requested domains.
" } }, - "documentation":"The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.
Contains the status of the specified domains or all domains owned by the account.
" }, "DescribeInboundConnectionsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", - "documentation":" A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:
A list of filters used to match properties for inbound cross-cluster connections.
" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
" + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
" + "documentation":"If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
Container for the parameters to the DescribeInboundConnections operation.
Container for the parameters to the DescribeInboundConnections operation.
A list of InboundConnection matching the specified filter criteria.
List of inbound connections.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The result of a DescribeInboundConnections request. Contains a list of connections matching the filter criteria.
Contains a list of connections matching the filter criteria.
" }, "DescribeInstanceTypeLimitsRequest":{ "type":"structure", @@ -1804,82 +2080,85 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":" The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.
The name of the domain. Only specify if you need the limits for an existing domain.
", "location":"querystring", "locationName":"domainName" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", - "documentation":" The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.
The OpenSearch Service instance type for which you need limit information.
", "location":"uri", "locationName":"InstanceType" }, "EngineVersion":{ "shape":"VersionString", - "documentation":" Version of OpenSearch for which Limits are needed.
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
", "location":"uri", "locationName":"EngineVersion" } }, - "documentation":" Container for the parameters to the DescribeInstanceTypeLimits operation.
Container for the parameters to the DescribeInstanceTypeLimits operation.
Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:
List of filter names and values that you can use for requests.
" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
" + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.
" + "documentation":"If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
Container for the parameters to the DescribeOutboundConnections operation.
Container for the parameters to the DescribeOutboundConnections operation.
A list of OutboundConnection matching the specified filter criteria.
List of outbound connections that match the filter criteria.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The result of a DescribeOutboundConnections request. Contains the list of connections matching the filter criteria.
Contains a list of connections matching the filter criteria.
" }, "DescribePackagesFilter":{ "type":"structure", "members":{ "Name":{ "shape":"DescribePackagesFilterName", - "documentation":"Any field from PackageDetails.
Any field from PackageDetails.
A list of values for the specified field.
" + "documentation":"A list of values for the specified filter field.
" } }, - "documentation":"A filter to apply to the DescribePackage response.
A filter to apply to the DescribePackage response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
Only returns packages that match the DescribePackagesFilterList values.
Only returns packages that match the DescribePackagesFilterList values.
Limits results to a maximum number of packages.
" + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
" + "documentation":"If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
Container for the request parameters to the DescribePackage operation.
Container for the request parameters to the DescribePackage operation.
List of PackageDetails objects.
Basic information about a package.
" }, - "NextToken":{"shape":"String"} + "NextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for the response returned by the DescribePackages operation.
Container for the response returned by the DescribePackages operation.
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
", + "documentation":"The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
", "location":"querystring", "locationName":"offeringId" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Provides an identifier to allow retrieval of paginated results.
", + "documentation":"If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
Container for parameters to DescribeReservedInstanceOfferings
Container for the request parameters to a DescribeReservedInstanceOfferings operation.
Provides an identifier to allow retrieval of paginated results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
List of reserved OpenSearch instance offerings
" + "documentation":"List of Reserved Instance offerings.
" } }, - "documentation":"Container for results from DescribeReservedInstanceOfferings
Container for results of a DescribeReservedInstanceOfferings request.
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
", + "documentation":"The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
", "location":"querystring", "locationName":"reservationId" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Provides an identifier to allow retrieval of paginated results.
", + "documentation":"If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
Container for parameters to DescribeReservedInstances
Container for the request parameters to the DescribeReservedInstances operation.
Provides an identifier to allow retrieval of paginated results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
List of reserved OpenSearch instances.
" + "documentation":"List of Reserved Instances in the current Region.
" } }, "documentation":"Container for results from DescribeReservedInstances
The unique identifiers of the endpoints to get information about.
" + } + } + }, + "DescribeVpcEndpointsResponse":{ + "type":"structure", + "required":[ + "VpcEndpoints", + "VpcEndpointErrors" + ], + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpoints", + "documentation":"Information about each requested VPC endpoint.
" + }, + "VpcEndpointErrors":{ + "shape":"VpcEndpointErrorList", + "documentation":"Any errors associated with the request.
" + } + } + }, "Description":{"type":"string"}, "DisableTimestamp":{"type":"timestamp"}, "DisabledOperationException":{ @@ -2021,105 +2330,111 @@ "members":{ "PackageID":{ "shape":"PackageID", - "documentation":"The internal ID of the package to associate with a domain. Use DescribePackages to find this value.
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
The name of the domain to associate the package with.
", + "documentation":"Name of the domain to dissociate the package from.
", "location":"uri", "locationName":"DomainName" } }, - "documentation":" Container for the request parameters to the DissociatePackage operation.
Container for the request parameters to the DissociatePackage operation.
DomainPackageDetails
Information about a package that has been dissociated from the domain.
" } }, - "documentation":" Container for the response returned by DissociatePackage operation.
Container for the response returned by an DissociatePackage operation.
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
" + "documentation":"The OpenSearch or Elasticsearch version that the domain is running.
" }, "ClusterConfig":{ "shape":"ClusterConfigStatus", - "documentation":"The ClusterConfig for the domain.
Container for the cluster configuration of a the domain.
" }, "EBSOptions":{ "shape":"EBSOptionsStatus", - "documentation":"The EBSOptions for the domain.
Container for EBS options configured for an OpenSearch Service domain.
" }, "AccessPolicies":{ "shape":"AccessPoliciesStatus", - "documentation":"IAM access policy as a JSON-formatted string.
" + "documentation":"Specifies the access policies for the domain.
" }, "SnapshotOptions":{ "shape":"SnapshotOptionsStatus", - "documentation":"The SnapshotOptions for the domain.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
" }, "VPCOptions":{ "shape":"VPCDerivedInfoStatus", - "documentation":"The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
The current VPC options for the domain and the status of any updates to their configuration.
" }, "CognitoOptions":{ "shape":"CognitoOptionsStatus", - "documentation":"The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Container for Amazon Cognito options for the domain.
" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptionsStatus", - "documentation":"The EncryptionAtRestOptions for the domain.
Key-value pairs to enable encryption at rest.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptionsStatus", - "documentation":"The NodeToNodeEncryptionOptions for the domain.
Whether node-to-node encryption is enabled or disabled.
" }, "AdvancedOptions":{ "shape":"AdvancedOptionsStatus", - "documentation":"The AdvancedOptions for the domain. See Advanced options for more information.
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
" }, "LogPublishingOptions":{ "shape":"LogPublishingOptionsStatus", - "documentation":"Log publishing options for the given domain.
" + "documentation":"Key-value pairs to configure slow log publishing.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptionsStatus", - "documentation":"The DomainEndpointOptions for the domain.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsStatus", - "documentation":"Specifies AdvancedSecurityOptions for the domain.
Container for fine-grained access control settings for the domain.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsStatus", - "documentation":"Specifies AutoTuneOptions for the domain.
Container for Auto-Tune settings for the domain.
" }, "ChangeProgressDetails":{ "shape":"ChangeProgressDetails", - "documentation":"Specifies change details of the domain configuration change.
" + "documentation":"Container for information about the progress of an existing configuration change.
" } }, - "documentation":"The configuration of a domain.
" + "documentation":"Container for the configuration of an OpenSearch Service domain.
" }, "DomainEndpointOptions":{ "type":"structure", "members":{ "EnforceHTTPS":{ "shape":"Boolean", - "documentation":"Whether only HTTPS endpoint should be enabled for the domain.
" + "documentation":"True to require that all traffic to the domain arrive over HTTPS.
" }, "TLSSecurityPolicy":{ "shape":"TLSSecurityPolicy", - "documentation":"Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2
The fully qualified domain for your custom endpoint.
" + "documentation":"The fully qualified URL for the custom endpoint.
" }, "CustomEndpointCertificateArn":{ "shape":"ARN", - "documentation":"The ACM certificate ARN for your custom endpoint.
" + "documentation":"The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
" } }, - "documentation":"Options to configure the endpoint for the domain.
" + "documentation":"Options to configure a custom endpoint for an OpenSearch Service domain.
" }, "DomainEndpointOptionsStatus":{ "type":"structure", @@ -2145,18 +2460,18 @@ "members":{ "Options":{ "shape":"DomainEndpointOptions", - "documentation":"Options to configure the endpoint for the domain.
" + "documentation":"Options to configure the endpoint for a domain.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
The status of the endpoint options for a domain.
" } }, - "documentation":"The configured endpoint options for the domain and their current status.
" + "documentation":"The configured endpoint options for a domain and their current status.
" }, "DomainId":{ "type":"string", - "documentation":"Unique identifier for the domain.
", + "documentation":"Unique identifier for an OpenSearch Service domain.
", "max":64, "min":1 }, @@ -2165,28 +2480,33 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The DomainName.
Name of the domain.
" }, "EngineType":{ "shape":"EngineType", - "documentation":" Specifies the EngineType of the domain.
The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
Information about an OpenSearch Service domain.
" }, "DomainInfoList":{ "type":"list", "member":{"shape":"DomainInfo"}, - "documentation":"Contains the list of domain information.
" + "documentation":"Contains a list of information about a domain.
" }, "DomainInformationContainer":{ "type":"structure", "members":{ - "AWSDomainInformation":{"shape":"AWSDomainInformation"} - } + "AWSDomainInformation":{ + "shape":"AWSDomainInformation", + "documentation":"Information about an Amazon OpenSearch Service domain.
" + } + }, + "documentation":"Container for information about an OpenSearch Service domain.
" }, "DomainName":{ "type":"string", - "documentation":"The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
", + "documentation":"The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
", "max":28, "min":3, "pattern":"[a-z][a-z0-9\\-]+" @@ -2200,14 +2520,14 @@ "DomainNameList":{ "type":"list", "member":{"shape":"DomainName"}, - "documentation":"A list of domain names.
" + "documentation":"A list of OpenSearch Service domain names.
" }, "DomainPackageDetails":{ "type":"structure", "members":{ "PackageID":{ "shape":"PackageID", - "documentation":"The internal ID of the package.
" + "documentation":"Internal ID of the package.
" }, "PackageName":{ "shape":"PackageName", @@ -2215,31 +2535,34 @@ }, "PackageType":{ "shape":"PackageType", - "documentation":"Currently supports only TXT-DICTIONARY.
" + "documentation":"The type of package.
" }, "LastUpdated":{ "shape":"LastUpdated", - "documentation":"The timestamp of the most recent update to the package association status.
" + "documentation":"Timestamp of the most recent update to the package association status.
" }, "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain you've associated a package with.
" + "documentation":"Name of the domain that the package is associated with.
" }, "DomainPackageStatus":{ "shape":"DomainPackageStatus", - "documentation":"State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.
" + "documentation":"State of the association.
" + }, + "PackageVersion":{ + "shape":"PackageVersion", + "documentation":"The current version of the package.
" }, - "PackageVersion":{"shape":"PackageVersion"}, "ReferencePath":{ "shape":"ReferencePath", - "documentation":"The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.
" + "documentation":"Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
Additional information if the package is in an error state. Null otherwise.
" } }, - "documentation":"Information on a package associated with a domain.
" + "documentation":"Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
" }, "DomainPackageDetailsList":{ "type":"list", @@ -2266,80 +2589,83 @@ "members":{ "DomainId":{ "shape":"DomainId", - "documentation":"The unique identifier for the specified domain.
" + "documentation":"Unique identifier for the domain.
" }, "DomainName":{ "shape":"DomainName", - "documentation":"The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
" + "documentation":"Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
" }, "ARN":{ "shape":"ARN", - "documentation":"The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
" + "documentation":"The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
" }, "Created":{ "shape":"Boolean", - "documentation":"The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
" }, "Deleted":{ "shape":"Boolean", - "documentation":"The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
" }, "Endpoint":{ "shape":"ServiceUrl", - "documentation":"The domain endpoint that you use to submit index and search requests.
" + "documentation":"Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
" }, "Endpoints":{ "shape":"EndpointsMap", - "documentation":"Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
" }, "UpgradeProcessing":{ "shape":"Boolean", - "documentation":"The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
" + }, + "EngineVersion":{ + "shape":"VersionString", + "documentation":"Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
The type and number of instances in the domain.
" + "documentation":"Container for the cluster configuration of the domain.
" }, "EBSOptions":{ "shape":"EBSOptions", - "documentation":"The EBSOptions for the specified domain.
Container for EBS-based storage settings for the domain.
" }, "AccessPolicies":{ "shape":"PolicyDocument", - "documentation":"IAM access policy as a JSON-formatted string.
" + "documentation":"Identity and Access Management (IAM) policy document specifying the access policies for the domain.
" }, "SnapshotOptions":{ "shape":"SnapshotOptions", - "documentation":"The status of the SnapshotOptions.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
" }, "VPCOptions":{ "shape":"VPCDerivedInfo", - "documentation":"The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
The VPC configuration for the domain.
" }, "CognitoOptions":{ "shape":"CognitoOptions", - "documentation":"The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", - "documentation":"The status of the EncryptionAtRestOptions.
Encryption at rest settings for the domain.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", - "documentation":"The status of the NodeToNodeEncryptionOptions.
Whether node-to-node encryption is enabled or disabled.
" }, "AdvancedOptions":{ "shape":"AdvancedOptions", - "documentation":"The status of the AdvancedOptions.
Key-value pairs that specify advanced configuration options.
" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", - "documentation":"Log publishing options for the given domain.
" + "documentation":"Log publishing options for the domain.
" }, "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", @@ -2347,27 +2673,27 @@ }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", - "documentation":"The current status of the domain's endpoint options.
" + "documentation":"Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptions", - "documentation":"The current status of the domain's advanced security options.
" + "documentation":"Settings for fine-grained access control.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsOutput", - "documentation":"The current status of the domain's Auto-Tune options.
" + "documentation":"Auto-Tune settings for the domain.
" }, "ChangeProgressDetails":{ "shape":"ChangeProgressDetails", - "documentation":"Specifies change details of the domain configuration change.
" + "documentation":"Information about a configuration change happening on the domain.
" } }, - "documentation":"The current status of a domain.
" + "documentation":"The current status of an OpenSearch Service domain.
" }, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"}, - "documentation":"A list that contains the status of each requested domain.
" + "documentation":"List that contains the status of each specified OpenSearch Service domain.
" }, "Double":{"type":"double"}, "DryRun":{"type":"boolean"}, @@ -2376,31 +2702,32 @@ "members":{ "DeploymentType":{ "shape":"DeploymentType", - "documentation":" Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).
Specifies the way in which OpenSearch Service will apply an update. Possible values are:
Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
None - The request doesn't include any configuration changes.
Contains an optional message associated with the DryRunResults.
" + "documentation":"A message corresponding to the deployment type.
" } - } + }, + "documentation":"Results of a dry run performed in an update domain request.
" }, "Duration":{ "type":"structure", "members":{ "Value":{ "shape":"DurationValue", - "documentation":"Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"Integer to specify the value of a maintenance schedule duration.
" }, "Unit":{ "shape":"TimeUnit", - "documentation":"The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"The unit of measurement for the duration of a maintenance schedule.
" } }, - "documentation":"The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "DurationValue":{ "type":"long", - "documentation":"Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
", + "documentation":"Integer that specifies the value of a maintenance schedule duration.
", "max":24, "min":1 }, @@ -2409,26 +2736,26 @@ "members":{ "EBSEnabled":{ "shape":"Boolean", - "documentation":"Whether EBS-based storage is enabled.
" + "documentation":"Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
" }, "VolumeType":{ "shape":"VolumeType", - "documentation":"The volume type for EBS-based storage.
" + "documentation":"Specifies the type of EBS volumes attached to data nodes.
" }, "VolumeSize":{ "shape":"IntegerClass", - "documentation":"Integer to specify the size of an EBS volume.
" + "documentation":"Specifies the size (in GiB) of EBS volumes attached to data nodes.
" }, "Iops":{ "shape":"IntegerClass", - "documentation":"The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
" + "documentation":"Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
The Throughput for GP3 EBS volume (SSD).
" + "documentation":"Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
Options to enable, disable, and specify the properties of EBS storage volumes.
" + "documentation":"Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
" }, "EBSOptionsStatus":{ "type":"structure", @@ -2439,28 +2766,28 @@ "members":{ "Options":{ "shape":"EBSOptions", - "documentation":"The EBS options for the specified domain.
" + "documentation":"The configured EBS options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the EBS options for the specified domain.
" } }, - "documentation":"Status of the EBS options for the specified domain.
" + "documentation":"The status of the EBS options for the specified OpenSearch Service domain.
" }, "EncryptionAtRestOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"The option to enable encryption at rest.
" + "documentation":"True to enable encryption at rest.
" }, "KmsKeyId":{ "shape":"KmsKeyId", - "documentation":"The KMS key ID for encryption at rest options.
" + "documentation":"The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
Specifies encryption at rest options.
" + "documentation":"Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.
" }, "EncryptionAtRestOptionsStatus":{ "type":"structure", @@ -2471,14 +2798,18 @@ "members":{ "Options":{ "shape":"EncryptionAtRestOptions", - "documentation":"The Encryption At Rest options for the specified domain.
" + "documentation":"Encryption at rest options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"The status of the Encryption At Rest options for the specified domain.
" + "documentation":"The status of the encryption at rest options for the specified domain.
" } }, - "documentation":"Status of the encryption At Rest options for the specified domain.
" + "documentation":"Status of the encryption at rest options for the specified OpenSearch Service domain.
" + }, + "Endpoint":{ + "type":"string", + "pattern":"^[A-Za-z0-9\\-\\.]+$" }, "EndpointsMap":{ "type":"map", @@ -2495,9 +2826,16 @@ "ErrorDetails":{ "type":"structure", "members":{ - "ErrorType":{"shape":"ErrorType"}, - "ErrorMessage":{"shape":"ErrorMessage"} - } + "ErrorType":{ + "shape":"ErrorType", + "documentation":"The type of error that occurred.
" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"A message describing the error.
" + } + }, + "documentation":"Additional information if the package is in an error state. Null otherwise.
" }, "ErrorMessage":{"type":"string"}, "ErrorType":{"type":"string"}, @@ -2506,14 +2844,14 @@ "members":{ "Name":{ "shape":"NonEmptyString", - "documentation":"The name of the filter.
" + "documentation":"The name of the filter.
" }, "Values":{ "shape":"ValueStringList", - "documentation":"Contains one or more values for the filter.
" + "documentation":"One or more values for the filter.
" } }, - "documentation":"A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
" + "documentation":"A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
" }, "FilterList":{ "type":"list", @@ -2530,21 +2868,22 @@ "members":{ "DomainName":{ "shape":"DomainName", + "documentation":"The name of an existing domain. Provide this parameter to limit the results to a single domain.
", "location":"querystring", "locationName":"domainName" } }, - "documentation":" Container for the request parameters to GetCompatibleVersions operation.
Container for the request parameters to GetCompatibleVersions operation.
A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
" } }, - "documentation":" Container for the response returned by the GetCompatibleVersions operation.
Container for the response returned by the GetCompatibleVersions operation.
Returns an audit history of package versions.
", + "documentation":"The unique identifier of the package.
", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Limits results to a maximum number of package versions.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "documentation":"If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
Container for the request parameters to the GetPackageVersionHistory operation.
Container for the request parameters to the GetPackageVersionHistory operation.
The unique identifier of the package.
" + }, "PackageVersionHistoryList":{ "shape":"PackageVersionHistoryList", - "documentation":"List of PackageVersionHistory objects.
A list of package versions, along with their creation time and commit message.
" }, - "NextToken":{"shape":"String"} + "NextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for response returned by GetPackageVersionHistory operation.
Container for response returned by GetPackageVersionHistory operation.
The name of an existing domain.
", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.
Container for the request parameters to the GetUpgradeHistory operation.
Container for the request parameters to the GetUpgradeHistory operation.
A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.
A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
" }, "NextToken":{ "shape":"String", - "documentation":"Pagination token that needs to be supplied to the next call to get the next page of results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for the response returned by the GetUpgradeHistory operation.
Container for the response returned by the GetUpgradeHistory operation.
The domain of the domain to get upgrade status information for.
", "location":"uri", "locationName":"DomainName" } }, - "documentation":" Container for the request parameters to the GetUpgradeStatus operation.
Container for the request parameters to the GetUpgradeStatus operation.
One of three steps an upgrade or upgrade eligibility check goes through:
One of three steps that an upgrade or upgrade eligibility check goes through.
" }, "StepStatus":{ "shape":"UpgradeStatus", - "documentation":" One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:
The status of the current step that an upgrade is on.
" }, "UpgradeName":{ "shape":"UpgradeName", - "documentation":"A string that briefly describes the update.
" + "documentation":"A string that describes the update.
" } }, - "documentation":" Container for the response returned by the GetUpgradeStatus operation.
Container for the response returned by the GetUpgradeStatus operation.
The AWSDomainInformation for the local OpenSearch domain.
Information about the source (local) domain.
" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", - "documentation":"The AWSDomainInformation for the remote OpenSearch domain.
Information about the destination (remote) domain.
" }, "ConnectionId":{ "shape":"ConnectionId", - "documentation":"The connection ID for the inbound cross-cluster connection.
" + "documentation":"The unique identifier of the connection.
" }, "ConnectionStatus":{ "shape":"InboundConnectionStatus", - "documentation":"The InboundConnectionStatus for the outbound connection.
The current status of the connection.
" } }, - "documentation":"Details of an inbound connection.
" + "documentation":"Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
" }, "InboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"InboundConnectionStatusCode", - "documentation":"The state code for the inbound connection. Can be one of the following:
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
Verbose information for the inbound connection status.
" + "documentation":"Information about the connection.
" } }, - "documentation":"The connection status of an inbound cross-cluster connection.
" + "documentation":"The status of an inbound cross-cluster connection for OpenSearch Service.
" }, "InboundConnectionStatusCode":{ "type":"string", @@ -2710,23 +3059,32 @@ }, "InstanceCount":{ "type":"integer", - "documentation":"The number of EC2 instances in the domain.
", + "documentation":"Number of instances in an OpenSearch Service cluster.
", "min":1 }, "InstanceCountLimits":{ "type":"structure", "members":{ - "MinimumInstanceCount":{"shape":"MinimumInstanceCount"}, - "MaximumInstanceCount":{"shape":"MaximumInstanceCount"} + "MinimumInstanceCount":{ + "shape":"MinimumInstanceCount", + "documentation":"The maximum allowed number of instances.
" + }, + "MaximumInstanceCount":{ + "shape":"MaximumInstanceCount", + "documentation":"The minimum allowed number of instances.
" + } }, - "documentation":"InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.
" + "documentation":"Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
" }, "InstanceLimits":{ "type":"structure", "members":{ - "InstanceCountLimits":{"shape":"InstanceCountLimits"} + "InstanceCountLimits":{ + "shape":"InstanceCountLimits", + "documentation":"Limits on the number of instances that can be created for a given instance type.
" + } }, - "documentation":"InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.
" + "documentation":"Instance-related attributes that are available for a given instance type.
" }, "InstanceRole":{"type":"string"}, "InstanceRoleList":{ @@ -2736,14 +3094,36 @@ "InstanceTypeDetails":{ "type":"structure", "members":{ - "InstanceType":{"shape":"OpenSearchPartitionInstanceType"}, - "EncryptionEnabled":{"shape":"Boolean"}, - "CognitoEnabled":{"shape":"Boolean"}, - "AppLogsEnabled":{"shape":"Boolean"}, - "AdvancedSecurityEnabled":{"shape":"Boolean"}, - "WarmEnabled":{"shape":"Boolean"}, - "InstanceRole":{"shape":"InstanceRoleList"} - } + "InstanceType":{ + "shape":"OpenSearchPartitionInstanceType", + "documentation":"The instance type.
" + }, + "EncryptionEnabled":{ + "shape":"Boolean", + "documentation":"Whether encryption at rest and node-to-node encryption are supported for the instance type.
" + }, + "CognitoEnabled":{ + "shape":"Boolean", + "documentation":"Whether Amazon Cognito access is supported for the instance type.
" + }, + "AppLogsEnabled":{ + "shape":"Boolean", + "documentation":"Whether logging is supported for the instance type.
" + }, + "AdvancedSecurityEnabled":{ + "shape":"Boolean", + "documentation":"Whether fine-grained access control is supported for the instance type.
" + }, + "WarmEnabled":{ + "shape":"Boolean", + "documentation":"Whether UltraWarm is supported for the instance type.
" + }, + "InstanceRole":{ + "shape":"InstanceRoleList", + "documentation":"Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
" + } + }, + "documentation":"Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
" }, "InstanceTypeDetailsList":{ "type":"list", @@ -2806,43 +3186,46 @@ "members":{ "StorageTypes":{ "shape":"StorageTypeList", - "documentation":"Storage-related types and attributes that are available for a given InstanceType.
" + "documentation":"Storage-related attributes that are available for a given instance type.
" + }, + "InstanceLimits":{ + "shape":"InstanceLimits", + "documentation":"The limits for a given instance type.
" }, - "InstanceLimits":{"shape":"InstanceLimits"}, "AdditionalLimits":{ "shape":"AdditionalLimitList", - "documentation":" List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .
List of additional limits that are specific to a given instance type for each of its instance roles.
" } }, - "documentation":" Limits for a given InstanceType and for each of its roles.
Limits contains the following: StorageTypes , InstanceLimits , and AdditionalLimits
Limits for a given instance type and for each of its roles.
" }, "LimitsByRole":{ "type":"map", "key":{"shape":"InstanceRole"}, "value":{"shape":"Limits"}, - "documentation":"The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:
The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:
data - A data node.
master - A dedicated master node.
ultra_warm - An UltraWarm node.
Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
", + "documentation":"Filters the output by domain engine type.
", "location":"querystring", "locationName":"engineType" } }, - "documentation":" Container for the parameters to the ListDomainNames operation.
Container for the parameters to the ListDomainNames operation.
List of domain names and respective engine types.
" + "documentation":"The names of all OpenSearch Service domains owned by the current user and their respective engine types.
" } }, - "documentation":"The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
The package for which to list associated domains.
", + "documentation":"The unique identifier of the package for which to list associated domains.
", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"Limits the results to a maximum number of domains.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "documentation":"If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
Container for the request parameters to the ListDomainsForPackage operation.
Container for the request parameters to the ListDomainsForPackage operation.
List of DomainPackageDetails objects.
Information about all domains associated with a package.
" }, - "NextToken":{"shape":"String"} + "NextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for the response parameters to the ListDomainsForPackage operation.
Container for the response parameters to the ListDomainsForPackage operation.
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
", "location":"uri", "locationName":"EngineVersion" }, "DomainName":{ "shape":"DomainName", + "documentation":"Name of the domain to list instance type details for.
", "location":"querystring", "locationName":"domainName" }, "MaxResults":{ "shape":"MaxResults", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Limits results to a maximum number of packages.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "documentation":"If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
Container for the request parameters to the ListPackagesForDomain operation.
Container for the request parameters to the ListPackagesForDomain operation.
List of DomainPackageDetails objects.
List of all packages associated with a domain.
" }, "NextToken":{ "shape":"String", - "documentation":"Pagination token to supply to the next call to get the next page of results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for the response parameters to the ListPackagesForDomain operation.
Container for the response parameters to the ListPackagesForDomain operation.
Specify the ARN of the domain that the tags you want to view are attached to.
Amazon Resource Name (ARN) for the domain to view tags for.
", "location":"querystring", "locationName":"arn" } }, - "documentation":"Container for the parameters to the ListTags operation. Specify the ARN of the domain that the tags you want to view are attached to.
Container for the parameters to the ListTags operation.
List of Tag for the requested domain.
List of resource tags associated with the specified domain.
" } }, - "documentation":"The result of a ListTags operation. Contains tags for all requested domains.
The results of a ListTags operation.
Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.
", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.
Container for the parameters to the ListVersions operation.
Use MaxResults to control the maximum number of results to retrieve in a single call.
Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, there are no more results to retrieve.
Container for the request parameters to the ListVersions operation.
A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Container for the parameters for response received from the ListVersions operation.
Container for the parameters for response received from the ListVersions operation.
The name of the OpenSearch Service domain to retrieve access information for.
", + "location":"uri", + "locationName":"DomainName" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.
A list of IAM principals that can currently access the domain.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The name of the domain to list associated VPC endpoints for.
", + "location":"uri", + "locationName":"DomainName" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.
Information about each endpoint associated with the domain.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
Information about each endpoint.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
" + }, "Enabled":{ "shape":"Boolean", - "documentation":"Whether the given log publishing option is enabled or not.
" + "documentation":"Whether the log should be published.
" } }, - "documentation":"Log Publishing option that is set for a given domain.
Attributes and their details:
Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.
After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.
The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
The status of the log publishing options for the domain.
" } }, "documentation":"The configured log publishing options for the domain and their current status.
" }, "LogType":{ "type":"string", - "documentation":"Type of log file. Can be one of the following:
The type of log file. Can be one of the following:
INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.
ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.
ARN for the master user (if IAM is enabled).
" + "documentation":"Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.
The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
" + "documentation":"User name for the master user. Only specify if InternalUserDatabaseEnabled is true.
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
" + "documentation":"Password for the master user. Only specify if InternalUserDatabaseEnabled is true.
Credentials for the master user: username and password, ARN, or both.
" + "documentation":"Credentials for the master user for a domain.
" }, "MaxResults":{ "type":"integer", - "documentation":"Set this value to limit the number of results returned.
", + "documentation":"An optional parameter that specifies the maximum number of results to return for a given request.
", "max":100 }, "MaximumInstanceCount":{ "type":"integer", - "documentation":"Maximum number of instances that can be instantiated for a given InstanceType.
" + "documentation":"Maximum number of instances that can be instantiated for a given instance type.
" }, "Message":{ "type":"string", @@ -3075,11 +3579,11 @@ }, "MinimumInstanceCount":{ "type":"integer", - "documentation":"Minimum number of instances that can be instantiated for a given InstanceType.
" + "documentation":"Minimum number of instances that can be instantiated for a given instance type.
" }, "NextToken":{ "type":"string", - "documentation":"Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
" + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
True to enable node-to-node encryption.
" } }, - "documentation":"The node-to-node encryption options.
" + "documentation":"Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.
" }, "NodeToNodeEncryptionOptionsStatus":{ "type":"structure", @@ -3225,7 +3729,7 @@ }, "OptionState":{ "type":"string", - "documentation":"The state of a requested change. One of the following:
The state of a requested domain configuration change. Can be one of the following:
Processing - The requested change is still in progress.
Active - The requested change is processed and deployed to the domain.
The timestamp of when the entity was created.
" + "documentation":"The timestamp when the entity was created.
" }, "UpdateDate":{ "shape":"UpdateTimestamp", @@ -3254,54 +3758,54 @@ }, "State":{ "shape":"OptionState", - "documentation":"Provides the OptionState for the domain.
The state of the entity.
" }, "PendingDeletion":{ "shape":"Boolean", - "documentation":"Indicates whether the domain is being deleted.
" + "documentation":"Indicates whether the entity is being deleted.
" } }, - "documentation":"Provides the current status of the entity.
" + "documentation":"Provides the current status of an entity.
" }, "OutboundConnection":{ "type":"structure", "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", - "documentation":"The DomainInformation for the local OpenSearch domain.
Information about the source (local) domain.
" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", - "documentation":"The DomainInformation for the remote OpenSearch domain.
Information about the destination (remote) domain.
" }, "ConnectionId":{ "shape":"ConnectionId", - "documentation":"The connection ID for the outbound cross-cluster connection.
" + "documentation":"Unique identifier of the connection.
" }, "ConnectionAlias":{ "shape":"ConnectionAlias", - "documentation":"The connection alias for the outbound cross-cluster connection.
" + "documentation":"Name of the connection.
" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", - "documentation":"The OutboundConnectionStatus for the outbound connection.
Status of the connection.
" } }, - "documentation":"Specifies details about an outbound connection.
" + "documentation":"Specifies details about an outbound cross-cluster connection.
" }, "OutboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"OutboundConnectionStatusCode", - "documentation":"The state code for the outbound connection. Can be one of the following:
The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
Verbose information for the outbound connection status.
" + "documentation":"Verbose information for the outbound connection.
" } }, - "documentation":"The connection status of an outbound cross-cluster connection.
" + "documentation":"The status of an outbound cross-cluster connection.
" }, "OutboundConnectionStatusCode":{ "type":"string", @@ -3347,7 +3851,7 @@ "members":{ "PackageID":{ "shape":"PackageID", - "documentation":"Internal ID of the package.
" + "documentation":"The unique identifier of the package.
" }, "PackageName":{ "shape":"PackageName", @@ -3355,7 +3859,7 @@ }, "PackageType":{ "shape":"PackageType", - "documentation":"Currently supports only TXT-DICTIONARY.
" + "documentation":"The type of package.
" }, "PackageDescription":{ "shape":"PackageDescription", @@ -3363,14 +3867,20 @@ }, "PackageStatus":{ "shape":"PackageStatus", - "documentation":"Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
" + "documentation":"Current status of the package.
" }, "CreatedAt":{ "shape":"CreatedAt", - "documentation":"The timestamp of when the package was created.
" + "documentation":"The timestamp when the package was created.
" + }, + "LastUpdatedAt":{ + "shape":"LastUpdated", + "documentation":"Date and time when the package was last updated.
" + }, + "AvailablePackageVersion":{ + "shape":"PackageVersion", + "documentation":"The package version.
" }, - "LastUpdatedAt":{"shape":"LastUpdated"}, - "AvailablePackageVersion":{"shape":"PackageVersion"}, "ErrorDetails":{ "shape":"ErrorDetails", "documentation":"Additional information if the package is in an error state. Null otherwise.
" @@ -3401,7 +3911,7 @@ "documentation":"Key (file name) of the package.
" } }, - "documentation":"The Amazon S3 location for importing the package specified as S3BucketName and S3Key
The Amazon S3 location to import the package from.
" }, "PackageStatus":{ "type":"string", @@ -3430,14 +3940,14 @@ }, "CommitMessage":{ "shape":"CommitMessage", - "documentation":"A message associated with the package version.
" + "documentation":"A message associated with the package version when it was uploaded.
" }, "CreatedAt":{ "shape":"CreatedAt", - "documentation":"The timestamp of when the package was created.
" + "documentation":"The date and time when the package was created.
" } }, - "documentation":"Details of a package version.
" + "documentation":"Details about a package version.
" }, "PackageVersionHistoryList":{ "type":"list", @@ -3452,11 +3962,18 @@ }, "PolicyDocument":{ "type":"string", - "documentation":"Access policy rules for a domain service endpoints. For more information, see Configuring access policies . The maximum size of a policy document is 100 KB.
", + "documentation":"Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.
", "max":102400, "min":0, "pattern":".*" }, + "PrincipalType":{ + "type":"string", + "enum":[ + "AWS_ACCOUNT", + "AWS_SERVICE" + ] + }, "PurchaseReservedInstanceOfferingRequest":{ "type":"structure", "required":[ @@ -3466,7 +3983,7 @@ "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", - "documentation":"The ID of the reserved OpenSearch instance offering to purchase.
" + "documentation":"The ID of the Reserved Instance offering to purchase.
" }, "ReservationName":{ "shape":"ReservationToken", @@ -3477,21 +3994,21 @@ "documentation":"The number of OpenSearch instances to reserve.
" } }, - "documentation":"Container for parameters to PurchaseReservedInstanceOffering
Container for request parameters to the PurchaseReservedInstanceOffering operation.
Details of the reserved OpenSearch instance which was purchased.
" + "documentation":"The ID of the Reserved Instance offering that was purchased.
" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"The customer-specified identifier used to track this reservation.
" } }, - "documentation":"Represents the output of a PurchaseReservedInstanceOffering operation.
Represents the output of a PurchaseReservedInstanceOffering operation.
The frequency of the recurring charge.
" } }, - "documentation":"Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.
" + "documentation":"Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
" }, "RecurringChargeList":{ "type":"list", @@ -3524,22 +4041,22 @@ "members":{ "ConnectionId":{ "shape":"ConnectionId", - "documentation":"The ID of the inbound connection to reject.
", + "documentation":"The unique identifier of the inbound connection to reject.
", "location":"uri", "locationName":"ConnectionId" } }, - "documentation":"Container for the parameters to the RejectInboundConnection operation.
Container for the request parameters to the RejectInboundConnection operation.
The InboundConnection of the rejected inbound connection.
Contains details about the rejected inbound connection.
" } }, - "documentation":"The result of a RejectInboundConnection operation. Contains details about the rejected inbound connection.
Represents the output of a RejectInboundConnection operation.
The ARN of the domain from which you want to delete the specified tags.
The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
" }, "TagKeys":{ "shape":"StringList", - "documentation":"The TagKey list you want to remove from the domain.
The list of tag keys to remove from the domain.
" } }, - "documentation":"Container for the parameters to the RemoveTags operation. Specify the ARN for the domain from which you want to remove the specified TagKey.
Container for the request parameters to the RemoveTags operation.
The unique identifier for the reservation.
" }, - "BillingSubscriptionId":{"shape":"Long"}, + "BillingSubscriptionId":{ + "shape":"Long", + "documentation":"The unique identifier of the billing subscription.
" + }, "ReservedInstanceOfferingId":{ "shape":"String", - "documentation":"The offering identifier.
" + "documentation":"The unique identifier of the Reserved Instance offering.
" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", - "documentation":"The OpenSearch instance type offered by the reserved instance offering.
" + "documentation":"The OpenSearch instance type offered by theReserved Instance offering.
" }, "StartTime":{ "shape":"UpdateTimestamp", - "documentation":"The time the reservation started.
" + "documentation":"The date and time when the reservation was purchased.
" }, "Duration":{ "shape":"Integer", @@ -3595,15 +4115,15 @@ }, "FixedPrice":{ "shape":"Double", - "documentation":"The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
" + "documentation":"The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
" }, "UsagePrice":{ "shape":"Double", - "documentation":"The rate you are charged for each hour for the domain that is using this reserved instance.
" + "documentation":"The hourly rate at which you're charged for the domain using this Reserved Instance.
" }, "CurrencyCode":{ "shape":"String", - "documentation":"The currency code for the reserved OpenSearch instance offering.
" + "documentation":"The currency code for the offering.
" }, "InstanceCount":{ "shape":"Integer", @@ -3611,18 +4131,18 @@ }, "State":{ "shape":"String", - "documentation":"The state of the reserved OpenSearch instance.
" + "documentation":"The state of the Reserved Instance.
" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", - "documentation":"The payment option as defined in the reserved OpenSearch instance offering.
" + "documentation":"The payment option as defined in the Reserved Instance offering.
" }, "RecurringCharges":{ "shape":"RecurringChargeList", - "documentation":"The charge to your account regardless of whether you are creating any domains using the instance offering.
" + "documentation":"The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
" } }, - "documentation":"Details of a reserved OpenSearch instance.
" + "documentation":"Details of an OpenSearch Reserved Instance.
" }, "ReservedInstanceList":{ "type":"list", @@ -3633,11 +4153,11 @@ "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", - "documentation":"The OpenSearch reserved instance offering identifier.
" + "documentation":"The unique identifier of the Reserved Instance offering.
" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", - "documentation":"The OpenSearch instance type offered by the reserved instance offering.
" + "documentation":"The OpenSearch instance type offered by the Reserved Instance offering.
" }, "Duration":{ "shape":"Integer", @@ -3645,26 +4165,26 @@ }, "FixedPrice":{ "shape":"Double", - "documentation":"The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.
" + "documentation":"The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
" }, "UsagePrice":{ "shape":"Double", - "documentation":"The rate you are charged for each hour the domain that is using the offering is running.
" + "documentation":"The hourly rate at which you're charged for the domain using this Reserved Instance.
" }, "CurrencyCode":{ "shape":"String", - "documentation":"The currency code for the reserved OpenSearch instance offering.
" + "documentation":"The currency code for the Reserved Instance offering.
" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", - "documentation":"Payment option for the reserved OpenSearch instance offering
" + "documentation":"Payment option for the Reserved Instance offering
" }, "RecurringCharges":{ "shape":"RecurringChargeList", - "documentation":"The charge to your account regardless of whether you are creating any domains using the instance offering.
" + "documentation":"The recurring charge to your account, regardless of whether you creates any domains using the offering.
" } }, - "documentation":"Details of a reserved OpenSearch instance offering.
" + "documentation":"Details of an OpenSearch Reserved Instance offering.
" }, "ReservedInstanceOfferingList":{ "type":"list", @@ -3694,6 +4214,30 @@ "error":{"httpStatusCode":409}, "exception":true }, + "RevokeVpcEndpointAccessRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Account" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the OpenSearch Service domain.
", + "location":"uri", + "locationName":"DomainName" + }, + "Account":{ + "shape":"AWSAccount", + "documentation":"The account ID to revoke access from.
" + } + } + }, + "RevokeVpcEndpointAccessResponse":{ + "type":"structure", + "members":{ + } + }, "RoleArn":{ "type":"string", "max":2048, @@ -3702,7 +4246,7 @@ }, "RollbackOnDisable":{ "type":"string", - "documentation":"The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
", + "documentation":"The rollback state while disabling Auto-Tune for the domain.
", "enum":[ "NO_ROLLBACK", "DEFAULT_ROLLBACK" @@ -3732,14 +4276,14 @@ "members":{ "MetadataContent":{ "shape":"SAMLMetadata", - "documentation":"The metadata of the SAML application in XML format.
" + "documentation":"The metadata of the SAML application, in XML format.
" }, "EntityId":{ "shape":"SAMLEntityId", - "documentation":"The unique entity ID of the application in SAML identity provider.
" + "documentation":"The unique entity ID of the application in the SAML identity provider.
" } }, - "documentation":"The SAML identity povider's information.
" + "documentation":"The SAML identity povider information.
" }, "SAMLMetadata":{ "type":"string", @@ -3751,7 +4295,7 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"True if SAML is enabled.
" + "documentation":"True to enable SAML authentication for a domain.
" }, "Idp":{ "shape":"SAMLIdp", @@ -3759,7 +4303,7 @@ }, "MasterUserName":{ "shape":"Username", - "documentation":"The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
" + "documentation":"The SAML master user name, which is stored in the domain's internal user database.
" }, "MasterBackendRole":{ "shape":"BackendRole", @@ -3767,18 +4311,18 @@ }, "SubjectKey":{ "shape":"String", - "documentation":"Element of the SAML assertion to use for username. Default is NameID.
" + "documentation":"Element of the SAML assertion to use for the user name. Default is NameID.
Element of the SAML assertion to use for backend roles. Default is roles.
" + "documentation":"Element of the SAML assertion to use for backend roles. Default is roles.
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
" + "documentation":"The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
" } }, - "documentation":"The SAML application configuration for the domain.
" + "documentation":"The SAML authentication configuration for an Amazon OpenSearch Service domain.
" }, "SAMLOptionsOutput":{ "type":"structure", @@ -3808,7 +4352,7 @@ }, "ScheduledAutoTuneActionType":{ "type":"string", - "documentation":"The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING, and JVM_YOUNG_GEN_TUNING.
", + "documentation":"The Auto-Tune action type.
", "enum":[ "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING" @@ -3816,33 +4360,33 @@ }, "ScheduledAutoTuneDescription":{ "type":"string", - "documentation":"The Auto-Tune action description.
" + "documentation":"The description of an Auto-Tune maintenance action that occurs on a domain.
" }, "ScheduledAutoTuneDetails":{ "type":"structure", "members":{ "Date":{ "shape":"AutoTuneDate", - "documentation":"The timestamp of the Auto-Tune action scheduled for the domain.
" + "documentation":"The date and time when the Auto-Tune action is scheduled for the domain.
" }, "ActionType":{ "shape":"ScheduledAutoTuneActionType", - "documentation":"The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
" + "documentation":"The type of Auto-Tune action.
" }, "Action":{ "shape":"ScheduledAutoTuneDescription", - "documentation":"The Auto-Tune action description.
" + "documentation":"A description of the Auto-Tune action.
" }, "Severity":{ "shape":"ScheduledAutoTuneSeverityType", - "documentation":"The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
" + "documentation":"The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.
Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" + "documentation":"Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
" }, "ScheduledAutoTuneSeverityType":{ "type":"string", - "documentation":"The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
", + "documentation":"The Auto-Tune action severity.
", "enum":[ "LOW", "MEDIUM", @@ -3858,48 +4402,48 @@ }, "NewVersion":{ "shape":"String", - "documentation":"The new service software version if one is available.
" + "documentation":"The new service software version, if one is available.
" }, "UpdateAvailable":{ "shape":"Boolean", - "documentation":" True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to update your service software version. False if you can't update your service software version.
" }, "Cancellable":{ "shape":"Boolean", - "documentation":" True if you're able to cancel your service software version update. False if you can't cancel your service software update.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
" }, "UpdateStatus":{ "shape":"DeploymentStatus", - "documentation":"The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
The status of your service software update.
" }, "Description":{ "shape":"String", - "documentation":"The description of the UpdateStatus.
A description of the service software update status.
" }, "AutomatedUpdateDate":{ "shape":"DeploymentCloseDateTimeStamp", - "documentation":"The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
" + "documentation":"The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
" }, "OptionalDeployment":{ "shape":"Boolean", - "documentation":" True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
" } }, - "documentation":"The current options of an domain service software options.
" + "documentation":"The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
" }, "ServiceUrl":{ "type":"string", - "documentation":"The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.
The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The status of a daily automated snapshot.
" } }, - "documentation":"Status of a daily automated snapshot.
" + "documentation":"Container for information about a daily automated snapshot for an OpenSearch Service domain.
" }, "StartAt":{"type":"timestamp"}, "StartServiceSoftwareUpdateRequest":{ @@ -3929,48 +4473,54 @@ "documentation":"The name of the domain that you want to update to the latest service software.
" } }, - "documentation":"Container for the parameters to the StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.
Container for the request parameters to the StartServiceSoftwareUpdate operation.
The current status of the OpenSearch service software update.
" + "documentation":"The current status of the OpenSearch Service software update.
" } }, - "documentation":"The result of a StartServiceSoftwareUpdate operation. Contains the status of the update.
Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.
Sub-type of the given storage type. List of available sub-storage options: \"instance\" storageType has no storageSubType. \"ebs\" storageType has the following valid storageSubTypes:
VolumeType for more information regarding each EBS storage option. "
+ "documentation":" Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:
standard
gp2
gp3
io1
The name of the storage type.
" + }, + "StorageSubTypeName":{ + "shape":"StorageSubTypeName", + "documentation":"The storage sub-type, such as gp3 or io1.
Limits that are applicable for the given storage type.
" + "documentation":"Limits that are applicable for the given storage type.
" } }, - "documentation":"StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.
" + "documentation":"A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
" }, "StorageTypeLimit":{ "type":"structure", "members":{ "LimitName":{ "shape":"LimitName", - "documentation":" Name of storage limits that are applicable for the given storage type. If StorageType is \"ebs\", the following storage options are applicable:
Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
Values for the StorageTypeLimit$LimitName .
The limit values.
" } }, - "documentation":"Limits that are applicable for the given storage type.
" + "documentation":"Limits that are applicable for the given Amazon OpenSearch Service storage type.
" }, "StorageTypeLimitList":{ "type":"list", @@ -3982,7 +4532,7 @@ }, "StorageTypeName":{ "type":"string", - "documentation":"Type of storage. List of available storage options:
The type of storage that the domain uses. Can be one of the following:
Built-in storage available for the instance.
Elastic Block Storage (EBS) attached to the instance.
The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.
The tag key. Tag keys must be unique for the domain to which they are attached.
" }, "Value":{ "shape":"TagValue", - "documentation":"The TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
A key value pair for a resource tag.
" + "documentation":"A tag (key-value pair) for an Amazon OpenSearch Service resource.
" }, "TagKey":{ "type":"string", - "documentation":"A string of length from 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached.
", + "documentation":"A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached.
", "max":128, "min":1, "pattern":".*" @@ -4024,18 +4574,18 @@ "TagList":{ "type":"list", "member":{"shape":"Tag"}, - "documentation":"A list of Tag.
A list of tags attached to a domain.
" }, "TagValue":{ "type":"string", - "documentation":"A string of length from 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
", + "documentation":"A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
", "max":256, "min":0, "pattern":".*" }, "TimeUnit":{ "type":"string", - "documentation":"The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service for more information.
", + "documentation":"The unit of a maintenance schedule duration. Valid value is HOUR.
The name of the domain you're updating.
", + "documentation":"The name of the domain that you're updating.
", "location":"uri", "locationName":"DomainName" }, "ClusterConfig":{ "shape":"ClusterConfig", - "documentation":"The type and number of instances to instantiate for the domain cluster.
" + "documentation":"Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
" }, "EBSOptions":{ "shape":"EBSOptions", - "documentation":"Specify the type and size of the EBS volume to use.
" + "documentation":"The type and size of the EBS volume to attach to instances in the domain.
" }, "SnapshotOptions":{ "shape":"SnapshotOptions", @@ -4067,50 +4617,50 @@ }, "VPCOptions":{ "shape":"VPCOptions", - "documentation":"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
" + "documentation":"Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" }, "CognitoOptions":{ "shape":"CognitoOptions", - "documentation":"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" + "documentation":"Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
" }, "AdvancedOptions":{ "shape":"AdvancedOptions", - "documentation":"Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
\"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
\"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
\"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
\"override_main_response_version\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
" }, "AccessPolicies":{ "shape":"PolicyDocument", - "documentation":"IAM access policy as a JSON-formatted string.
" + "documentation":"Identity and Access Management (IAM) access policy as a JSON-formatted string.
" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", - "documentation":"Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
Options to publish OpenSearch lots to Amazon CloudWatch Logs.
" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", - "documentation":"Specifies encryption of data at rest options.
" + "documentation":"Encryption at rest options for the domain.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", - "documentation":"Options to specify configuration that will be applied to the domain endpoint.
" + "documentation":"Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", - "documentation":"Specifies node-to-node encryption options.
" + "documentation":"Node-To-Node Encryption options for the domain.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", - "documentation":"Specifies advanced security options.
" + "documentation":"Options for fine-grained access control.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptions", - "documentation":"Specifies Auto-Tune options.
" + "documentation":"Options for Auto-Tune.
" }, "DryRun":{ "shape":"DryRun", - "documentation":"This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.
Container for the parameters to the UpdateDomain operation. Specifies the type and number of instances in the domain cluster.
Container for the request parameters to the UpdateDomain operation.
Contains result of DryRun.
" + "documentation":"Results of a dry run performed in an update domain request.
" } }, - "documentation":"The result of an UpdateDomain request. Contains the status of the domain being updated.
The results of an UpdateDomain request. Contains the status of the domain being updated.
The unique identifier for the package.
" }, - "PackageSource":{"shape":"PackageSource"}, + "PackageSource":{ + "shape":"PackageSource", + "documentation":"Amazon S3 bucket and key for the package.
" + }, "PackageDescription":{ "shape":"PackageDescription", "documentation":"A new description of the package.
" }, "CommitMessage":{ "shape":"CommitMessage", - "documentation":"A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.
Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.
Container for request parameters to the UpdatePackage operation.
Container for request parameters to the UpdatePackage operation.
Information about the package.
" + "documentation":"Information about a package.
" } }, - "documentation":" Container for the response returned by the UpdatePackage operation.
Container for the response returned by the UpdatePackage operation.
The unique identifier of the endpoint.
" + }, + "VpcOptions":{ + "shape":"VPCOptions", + "documentation":"The security groups and/or subnets to add, remove, or modify.
" + } + } + }, + "UpdateVpcEndpointResponse":{ + "type":"structure", + "required":["VpcEndpoint"], + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"The endpoint to be updated.
" + } + } + }, "UpgradeDomainRequest":{ "type":"structure", "required":[ @@ -4168,58 +4748,76 @@ "TargetVersion" ], "members":{ - "DomainName":{"shape":"DomainName"}, + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the OpenSearch Service domain that you want to upgrade.
" + }, "TargetVersion":{ "shape":"VersionString", - "documentation":"The version of OpenSearch you intend to upgrade the domain to.
" + "documentation":"OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
" }, "PerformCheckOnly":{ "shape":"Boolean", - "documentation":"When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" + "documentation":"When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" }, - "AdvancedOptions":{"shape":"AdvancedOptions"} + "AdvancedOptions":{ + "shape":"AdvancedOptions", + "documentation":"Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
Container for the request parameters to UpgradeDomain operation.
Container for the request parameters to the UpgradeDomain operation.
The unique identifier of the domain upgrade.
" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain that was upgraded.
" + }, "TargetVersion":{ "shape":"VersionString", - "documentation":"The version of OpenSearch that you intend to upgrade the domain to.
" + "documentation":"OpenSearch or Elasticsearch version that the domain was upgraded to.
" }, "PerformCheckOnly":{ "shape":"Boolean", - "documentation":"When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" + "documentation":"When true, indicates that an upgrade eligibility check was performed.
" }, - "AdvancedOptions":{"shape":"AdvancedOptions"}, - "ChangeProgressDetails":{"shape":"ChangeProgressDetails"} + "AdvancedOptions":{ + "shape":"AdvancedOptions", + "documentation":"The advanced options configuration for the domain.
" + }, + "ChangeProgressDetails":{ + "shape":"ChangeProgressDetails", + "documentation":"Container for information about a configuration change happening on a domain.
" + } }, - "documentation":" Container for response returned by UpgradeDomain operation.
Container for the response returned by UpgradeDomain operation.
A string that briefly describes the upgrade.
" + "documentation":"A string that describes the upgrade.
" }, "StartTimestamp":{ "shape":"StartTimestamp", - "documentation":"UTC timestamp at which the upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.
" + "documentation":"UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.
The current status of the upgrade. The status can take one of the following values:
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.
A list of each step performed as part of a specific upgrade or upgrade eligibility check.
" } }, - "documentation":"History of the last 10 upgrades and upgrade eligibility checks.
" + "documentation":"History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
" }, "UpgradeHistoryList":{ "type":"list", @@ -4248,11 +4846,11 @@ "members":{ "UpgradeStep":{ "shape":"UpgradeStep", - "documentation":"One of three steps an upgrade or upgrade eligibility check goes through:
One of three steps that an upgrade or upgrade eligibility check goes through:
PreUpgradeCheck
Snapshot
Upgrade
The current status of the upgrade. The status can take one of the following values:
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
The floating point value representing the progress percentage of a particular step.
" } }, - "documentation":"Represents a single step of the upgrade or upgrade eligibility check workflow.
" + "documentation":"Represents a single step of an upgrade or upgrade eligibility check workflow.
" }, "UpgradeStepsList":{ "type":"list", @@ -4287,22 +4885,22 @@ "members":{ "VPCId":{ "shape":"String", - "documentation":"The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
" }, "SubnetIds":{ "shape":"StringList", - "documentation":"The subnets for the VPC endpoint.
" + "documentation":"A list of subnet IDs associated with the VPC endpoints for the domain.
" }, "AvailabilityZones":{ "shape":"StringList", - "documentation":"The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
The list of Availability Zones associated with the VPC subnets.
" }, "SecurityGroupIds":{ "shape":"StringList", - "documentation":"The security groups for the VPC endpoint.
" + "documentation":"The list of security group IDs associated with the VPC endpoints for the domain.
" } }, - "documentation":"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" + "documentation":"Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.
The status of the VPC options for the specified domain.
" } }, - "documentation":"Status of the VPC options for the specified domain.
" + "documentation":"Status of the VPC options for a specified domain.
" }, "VPCOptions":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"StringList", - "documentation":"The subnets for the VPC endpoint.
" + "documentation":"A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
" }, "SecurityGroupIds":{ "shape":"StringList", - "documentation":"The security groups for the VPC endpoint.
" + "documentation":"The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
" } }, - "documentation":"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" + "documentation":"Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" }, "ValidationException":{ "type":"structure", @@ -4352,7 +4950,7 @@ "VersionList":{ "type":"list", "member":{"shape":"VersionString"}, - "documentation":"List of supported OpenSearch versions.
" + "documentation":"List of supported OpenSearch versions.
" }, "VersionStatus":{ "type":"structure", @@ -4363,14 +4961,14 @@ "members":{ "Options":{ "shape":"VersionString", - "documentation":"The OpenSearch version for the specified OpenSearch domain.
" + "documentation":"The OpenSearch or Elasticsearch version for the specified domain.
" }, "Status":{ "shape":"OptionStatus", - "documentation":"The status of the OpenSearch version options for the specified OpenSearch domain.
" + "documentation":"The status of the version options for the specified domain.
" } }, - "documentation":"The status of the OpenSearch version options for the specified OpenSearch domain.
" + "documentation":"The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
" }, "VersionString":{ "type":"string", @@ -4380,7 +4978,7 @@ }, "VolumeType":{ "type":"string", - "documentation":"The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storage for more information.
", + "documentation":"The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.
", "enum":[ "standard", "gp2", @@ -4388,16 +4986,127 @@ "gp3" ] }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "VpcEndpointOwner":{ + "shape":"AWSAccount", + "documentation":"The creator of the endpoint.
" + }, + "DomainArn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) of the domain associated with the endpoint.
" + }, + "VpcOptions":{ + "shape":"VPCDerivedInfo", + "documentation":"Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
" + }, + "Status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint.
" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"The connection endpoint ID for connecting to the domain.
" + } + }, + "documentation":"The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
" + }, + "VpcEndpointError":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "ErrorCode":{ + "shape":"VpcEndpointErrorCode", + "documentation":"The code associated with the error.
" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"A message describing the error.
" + } + }, + "documentation":"Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
" + }, + "VpcEndpointErrorCode":{ + "type":"string", + "enum":[ + "ENDPOINT_NOT_FOUND", + "SERVER_ERROR" + ] + }, + "VpcEndpointErrorList":{ + "type":"list", + "member":{"shape":"VpcEndpointError"} + }, + "VpcEndpointId":{ + "type":"string", + "max":256, + "min":5, + "pattern":"^aos-[a-zA-Z0-9]*$" + }, + "VpcEndpointIdList":{ + "type":"list", + "member":{"shape":"VpcEndpointId"} + }, + "VpcEndpointStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "UPDATING", + "UPDATE_FAILED", + "DELETING", + "DELETE_FAILED" + ] + }, + "VpcEndpointSummary":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "VpcEndpointOwner":{ + "shape":"String", + "documentation":"The creator of the endpoint.
" + }, + "DomainArn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) of the domain associated with the endpoint.
" + }, + "Status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint.
" + } + }, + "documentation":"Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
" + }, + "VpcEndpointSummaryList":{ + "type":"list", + "member":{"shape":"VpcEndpointSummary"} + }, + "VpcEndpoints":{ + "type":"list", + "member":{"shape":"VpcEndpoint"} + }, "ZoneAwarenessConfig":{ "type":"structure", "members":{ "AvailabilityZoneCount":{ "shape":"IntegerClass", - "documentation":"An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
" + "documentation":"If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.
The zone awareness configuration for the domain cluster, such as the number of availability zones.
" + "documentation":"The zone awareness configuration for an Amazon OpenSearch Service domain.
" } }, - "documentation":"Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
" + "documentation":"Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.
" } diff --git a/services/opsworks/pom.xml b/services/opsworks/pom.xml index 292c3f452654..ba581e45be35 100644 --- a/services/opsworks/pom.xml +++ b/services/opsworks/pom.xml @@ -21,7 +21,7 @@Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves details about a list of views.
" + }, + "CreateIndex":{ + "name":"CreateIndex", + "http":{ + "method":"POST", + "requestUri":"/CreateIndex", + "responseCode":200 + }, + "input":{"shape":"CreateIndexInput"}, + "output":{"shape":"CreateIndexOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
<ul> <li> <p> <b>Action</b>: <code>resource-explorer-2:CreateIndex</code> </p> <p> <b>Resource</b>: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (<code>*</code>) at the end of the string to match the eventual UUID. For example, the following <code>Resource</code> element restricts the role or user to creating an index in only the <code>us-east-2</code> Region of the specified account.</p> <p> <code>"Resource": "arn:aws:resource-explorer-2:us-east-2:<i><account-id></i>:index/*"</code> </p> <p>Alternatively, you can use <code>"Resource": "*"</code> to allow the role or user to create an index in any Region.</p> </li> <li> <p> <b>Action</b>: <code>iam:CreateServiceLinkedRole</code> </p> <p> <b>Resource</b>: No specific resource (*). </p> <p>This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html">service-linked role needed to index the resources in your account</a>. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.</p> </li> </ul> Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.
Deletes the specified view.
If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.
", + "idempotent":true + }, + "DisassociateDefaultView":{ + "name":"DisassociateDefaultView", + "http":{ + "method":"POST", + "requestUri":"/DisassociateDefaultView", + "responseCode":200 + }, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.
" + }, + "GetIndex":{ + "name":"GetIndex", + "http":{ + "method":"POST", + "requestUri":"/GetIndex", + "responseCode":200 + }, + "output":{"shape":"GetIndexOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
" + }, + "GetView":{ + "name":"GetView", + "http":{ + "method":"POST", + "requestUri":"/GetView", + "responseCode":200 + }, + "input":{"shape":"GetViewInput"}, + "output":{"shape":"GetViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves details of the specified view.
" + }, + "ListIndexes":{ + "name":"ListIndexes", + "http":{ + "method":"POST", + "requestUri":"/ListIndexes", + "responseCode":200 + }, + "input":{"shape":"ListIndexesInput"}, + "output":{"shape":"ListIndexesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
" + }, + "ListSupportedResourceTypes":{ + "name":"ListSupportedResourceTypes", + "http":{ + "method":"POST", + "requestUri":"/ListSupportedResourceTypes", + "responseCode":200 + }, + "input":{"shape":"ListSupportedResourceTypesInput"}, + "output":{"shape":"ListSupportedResourceTypesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the tags that are attached to the specified resource.
" + }, + "ListViews":{ + "name":"ListViews", + "http":{ + "method":"POST", + "requestUri":"/ListViews", + "responseCode":200 + }, + "input":{"shape":"ListViewsInput"}, + "output":{"shape":"ListViewsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
" + }, + "UpdateIndexType":{ + "name":"UpdateIndexType", + "http":{ + "method":"POST", + "requestUri":"/UpdateIndexType", + "responseCode":200 + }, + "input":{"shape":"UpdateIndexTypeInput"}, + "output":{"shape":"UpdateIndexTypeOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The credentials that you used to call this operation don't have the minimum required permissions.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AssociateDefaultViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"AssociateDefaultViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.
" + } + } + }, + "AssociateDefaultViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "AssociateDefaultViewOutput":{ + "type":"structure", + "members":{ + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.
" + } + } + }, + "BatchGetViewError":{ + "type":"structure", + "required":[ + "ErrorMessage", + "ViewArn" + ], + "members":{ + "ErrorMessage":{ + "shape":"String", + "documentation":"The description of the error for the specified view.
" + }, + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
" + } + }, + "documentation":"A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
" + }, + "BatchGetViewErrors":{ + "type":"list", + "member":{"shape":"BatchGetViewError"} + }, + "BatchGetViewInput":{ + "type":"structure", + "members":{ + "ViewArns":{ + "shape":"BatchGetViewInputViewArnsList", + "documentation":"A list of Amazon resource names (ARNs) that identify the views you want details for.
" + } + } + }, + "BatchGetViewInputViewArnsList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20, + "min":1 + }, + "BatchGetViewOutput":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"BatchGetViewErrors", + "documentation":"If any of the specified ARNs result in an error, then this structure describes the error.
" + }, + "Views":{ + "shape":"ViewList", + "documentation":"A structure with a list of objects with details for each of the specified views.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateIndexInput":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The specified tags are attached only to the index created in this Amazon Web Services Region. The tags aren't attached to any of the resources listed in the index.
" + } + } + }, + "CreateIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: DeleteIndex | GetIndex | UpdateIndexType | CreateView
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and timestamp when the index was created.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the GetIndex operation.
The state can remain in the CREATING or UPDATING state for several hours as Resource Explorer discovers the information about your resources and populates the index.
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.
", + "idempotencyToken":true + }, + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the view.
" + }, + "ViewName":{ + "shape":"ViewName", + "documentation":"The name of the new view. This name appears in the list of views in Resource Explorer.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
" + } + } + }, + "CreateViewInputClientTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "CreateViewOutput":{ + "type":"structure", + "members":{ + "View":{ + "shape":"View", + "documentation":"A structure that contains the details about the new view.
" + } + } + }, + "DeleteIndexInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you want to delete.
" + } + } + }, + "DeleteIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
The date and time when you last updated this index.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the current state of the index.
" + } + } + }, + "DeleteViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"DeleteViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want to delete.
" + } + } + }, + "DeleteViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "DeleteViewOutput":{ + "type":"structure", + "members":{ + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view that you successfully deleted.
" + } + } + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "GetDefaultViewOutput":{ + "type":"structure", + "members":{ + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view that is the current default for the Amazon Web Services Region in which you called this operation.
" + } + } + }, + "GetIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index.
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the index was originally created.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the index was last updated.
" + }, + "ReplicatingFrom":{ + "shape":"RegionList", + "documentation":"If this index is Type=AGGREGATOR, then this response value contains a list of the Amazon Web Services Regions that replicate their content to the index in this Region. Not present for a local index.
Identifies the Amazon Web Services Region that has an index set to Type=AGGREGATOR, if one exists. If it does, then the Region you called this operation in replicates its index information to the Region specified in this response value. Not present if there isn't an aggregator index in the account.
Indicates the current state of the index in this Amazon Web Services Region.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the index.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
" + } + } + }, + "GetViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"GetViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want information about.
" + } + } + }, + "GetViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "GetViewOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the view.
" + }, + "View":{ + "shape":"View", + "documentation":"A structure that contains the details for the requested view.
" + } + } + }, + "IncludedProperty":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"IncludedPropertyNameString", + "documentation":"The name of the property that is included in this view.
You can specify the following property names for this field:
Tags
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
" + }, + "IncludedPropertyList":{ + "type":"list", + "member":{"shape":"IncludedProperty"} + }, + "IncludedPropertyNameString":{ + "type":"string", + "max":1011, + "min":1 + }, + "Index":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index.
" + }, + "Region":{ + "shape":"String", + "documentation":"The Amazon Web Services Region in which the index exists.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of index. It can be one of the following values:
LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
" + }, + "IndexList":{ + "type":"list", + "member":{"shape":"Index"} + }, + "IndexState":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "UPDATING" + ] + }, + "IndexType":{ + "type":"string", + "enum":[ + "LOCAL", + "AGGREGATOR" + ] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request failed because of internal service error. Try your request again later.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListIndexesInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListIndexesInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.
Use this option to discover the aggregator index for your account.
" + } + } + }, + "ListIndexesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListIndexesInputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListIndexesInputRegionsList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20, + "min":0 + }, + "ListIndexesOutput":{ + "type":"structure", + "members":{ + "Indexes":{ + "shape":"IndexList", + "documentation":"A structure that contains the details and status of each index.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The list of resource types supported by Resource Explorer.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view or index that you want to attach tags to.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tag key and value pairs that you want to attach to the specified view or index.
" + } + } + }, + "ListViewsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListViewsInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The list of views available in the Amazon Web Services Region in which you called this operation.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "QueryString":{ + "type":"string", + "max":1011, + "min":0, + "sensitive":true + }, + "RegionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Resource":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the resource.
" + }, + "LastReportedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
" + }, + "OwningAccountId":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns the resource.
" + }, + "Properties":{ + "shape":"ResourcePropertyList", + "documentation":"A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
" + }, + "Region":{ + "shape":"String", + "documentation":"The Amazon Web Services Region in which the resource was created and exists.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"The type of the resource.
" + }, + "Service":{ + "shape":"String", + "documentation":"The Amazon Web Service that owns the resource and is responsible for creating and updating it.
" + } + }, + "documentation":"A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.
" + }, + "ResourceCount":{ + "type":"structure", + "members":{ + "Complete":{ + "shape":"Boolean", + "documentation":"Indicates whether the TotalResources value represents an exhaustive count of search results.
If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.
If False, then the search reached the limit of 1,000 matching results, and stopped counting.
The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.
This field is included in every page when you paginate the results.
" + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceProperty":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"Document", + "documentation":"Details about this property. The content of this field is a JSON object that varies based on the resource type.
" + }, + "LastReportedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time that the information about this resource property was last updated.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of this property of the resource.
" + } + }, + "documentation":"A structure that describes a property of a resource.
" + }, + "ResourcePropertyList":{ + "type":"list", + "member":{"shape":"ResourceProperty"} + }, + "ResourceTypeList":{ + "type":"list", + "member":{"shape":"SupportedResourceType"} + }, + "SearchFilter":{ + "type":"structure", + "required":["FilterString"], + "members":{ + "FilterString":{ + "shape":"SearchFilterFilterStringString", + "documentation":"The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
" + } + }, + "documentation":"A search filter defines which resources can be part of a search query result set.
", + "sensitive":true + }, + "SearchFilterFilterStringString":{ + "type":"string", + "max":2048, + "min":0 + }, + "SearchInput":{ + "type":"structure", + "required":["QueryString"], + "members":{ + "MaxResults":{ + "shape":"SearchInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
A string that includes keywords and filters that specify the resources that you want to include in the results.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
The number of resources that match the query.
" + }, + "NextToken":{ + "shape":"SearchOutputNextTokenString", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The list of structures that describe the resources that match the query.
" + }, + "ViewArn":{ + "shape":"SearchOutputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that this operation used to perform the search.
" + } + } + }, + "SearchOutputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "SearchOutputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "Name", + "Value" + ], + "members":{ + "Message":{"shape":"String"}, + "Name":{ + "shape":"String", + "documentation":"The name of the service quota that was exceeded by the request.
" + }, + "Value":{ + "shape":"String", + "documentation":"The current value for the quota that the request tried to exceed.
" + } + }, + "documentation":"The request failed because it exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SupportedResourceType":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"String", + "documentation":"The unique identifier of the resource type.
" + }, + "Service":{ + "shape":"String", + "documentation":"The Amazon Web Service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.
" + } + }, + "documentation":"A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
" + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TagResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"A list of tag key and value pairs that you want to attach to the specified view or index.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The principal making the request isn't permitted to perform the operation.
", + "error":{ + "httpStatusCode":401, + "senderFault":true + }, + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"StringList", + "documentation":"A list of the keys for the tags that you want to remove from the specified view or index.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateIndexTypeInput":{ + "type":"structure", + "required":[ + "Arn", + "Type" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you want to update.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of the index. To understand the difference between LOCAL and AGGREGATOR, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.
The Amazon resource name (ARN) of the index that you updated.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and timestamp when the index was last updated.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"Specifies the type of the specified index after the operation completes.
" + } + } + }, + "UpdateViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
" + }, + "ViewArn":{ + "shape":"UpdateViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want to modify.
" + } + } + }, + "UpdateViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "UpdateViewOutput":{ + "type":"structure", + "members":{ + "View":{ + "shape":"View", + "documentation":"Details about the view that you changed with this operation.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"An array of the request fields that had validation errors.
" + }, + "Message":{"shape":"String"} + }, + "documentation":"You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "ValidationIssue" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the request field that had a validation error.
" + }, + "ValidationIssue":{ + "shape":"String", + "documentation":"The validation error caused by the request field.
" + } + }, + "documentation":"A structure that describes a request field with a validation error.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "View":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
" + }, + "IncludedProperties":{ + "shape":"IncludedPropertyList", + "documentation":"A structure that contains additional information about the view.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when this view was last modified.
" + }, + "Owner":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns this view.
" + }, + "Scope":{ + "shape":"String", + "documentation":"An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
" + }, + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view.
" + } + }, + "documentation":"A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key \"ENV\" and the value \"DEVELOPMENT\" in the results returned by this view. You could also create a second view that includes only resources that are tagged with \"ENV\" and \"PRODUCTION\".
" + }, + "ViewArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ViewList":{ + "type":"list", + "member":{"shape":"View"} + }, + "ViewName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-]{1,64}$" + } + }, + "documentation":"Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
<p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/">Amazon Web Services Resource Explorer User Guide</a>.</p> <note> <p>The example HTTP query requests and responses in this guide are displayed with the <a href="https://json.org">JSON</a> formatted across multiple lines for readability. The actual query responses from the Resource Explorer service do not include this extra whitespace.</p> </note> <p> <b>We want your feedback about this documentation</b> </p> <p>Our goal is to help you get everything you can from Resource Explorer. If this guide helps you to do that, then let us know. If the guide isn't helping you, then we want to hear from you so we can address the issue. Use the <b>Feedback</b> link that's in the upper-right corner of every page. That sends your comments directly to the writers of this guide. We review every submission, looking for opportunities to improve the documentation. Thank you in advance for your help!</p> Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:
There is no resource policy that specifies the log group ARN in the value for Resource.
The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.
Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:
There is no resource policy that specifies the log group ARN in the value for Resource.
The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.
The Key management service (KMS) key you specified is marked as disabled for the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
" + "documentation":"Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
You can use Route 53 to:
Register domain names.
For more information, see How domain registration works.
Route internet traffic to the resources for your domain
For more information, see How internet traffic is routed to your website or web application.
Check the health of your resources.
For more information, see How Route 53 checks the health of your resources.
+ * This logic is identical to that in {@link EnhancedS3ServiceMetadata}, there's no good way to share it aside from creating a
+ * protected API that both the s3 and regions module consume.
*/
@SdkInternalApi
public class UseGlobalEndpointResolver {
diff --git a/services/s3control/pom.xml b/services/s3control/pom.xml
index 5251fcf8c09e..1f24ed1936e3 100644
--- a/services/s3control/pom.xml
+++ b/services/s3control/pom.xml
@@ -21,7 +21,7 @@