diff --git a/clients/client-accessanalyzer/src/models/models_0.ts b/clients/client-accessanalyzer/src/models/models_0.ts index 795d22d4733c..925840f45102 100644 --- a/clients/client-accessanalyzer/src/models/models_0.ts +++ b/clients/client-accessanalyzer/src/models/models_0.ts @@ -104,7 +104,7 @@ export interface CreateArchiveRuleRequest { /** *
The criteria for the rule.
*/ - filter: { [key: string]: Criterion } | undefined; + filter: RecordA client token.
@@ -364,7 +364,7 @@ export interface ArchiveRuleSummary { /** *A filter used to define the archive rule.
*/ - filter: { [key: string]: Criterion } | undefined; + filter: RecordThe time at which the archive rule was created.
@@ -476,7 +476,7 @@ export interface UpdateArchiveRuleRequest { *A filter to match for the rules to update. Only rules that match the filter are * updated.
*/ - filter: { [key: string]: Criterion } | undefined; + filter: RecordA client token.
@@ -506,7 +506,7 @@ export interface InlineArchiveRule { /** *The condition and values for a criterion.
*/ - filter: { [key: string]: Criterion } | undefined; + filter: RecordThe tags to apply to the analyzer.
*/ - tags?: { [key: string]: string }; + tags?: RecordA client token.
@@ -692,7 +692,7 @@ export interface AnalyzerSummary { /** *The tags added to the analyzer.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe status of the analyzer. An Active
analyzer successfully monitors
@@ -895,7 +895,7 @@ export interface KmsGrantConstraints {
* context in the request is the same as the encryption context specified in this
* constraint.
A list of key-value pairs that must be included in the encryption context of the cryptographic @@ -903,7 +903,7 @@ export interface KmsGrantConstraints { * encryption context in the request includes the key-value pairs specified in this * constraint, although it can include additional key-value pairs.
*/ - encryptionContextSubset?: { [key: string]: string }; + encryptionContextSubset?: Recorddefault
. For more information, see Default key
* policy.
*/
- keyPolicies?: { [key: string]: string };
+ keyPolicies?: RecordA list of proposed grant configurations for the KMS key. If the proposed grant @@ -1314,7 +1314,7 @@ export interface S3BucketConfiguration { *
The configuration of Amazon S3 access points or multi-region access points for the bucket. * You can propose up to 10 new access points per bucket.
*/ - accessPoints?: { [key: string]: S3AccessPointConfiguration }; + accessPoints?: RecordA client token.
@@ -1643,7 +1643,7 @@ export interface AccessPreview { /** *A map of resource ARNs for the proposed resource configuration.
*/ - configurations: { [key: string]: Configuration } | undefined; + configurations: RecordThe time at which the access preview was created.
@@ -1928,7 +1928,7 @@ export interface Finding { /** *The external principal that access to a resource within the zone of trust.
*/ - principal?: { [key: string]: string }; + principal?: RecordThe action in the analyzed policy statement that an external principal has permission to @@ -1955,7 +1955,7 @@ export interface Finding { /** *
The condition in the analyzed policy statement that resulted in a finding.
*/ - condition: { [key: string]: string } | undefined; + condition: RecordThe time at which the finding was generated.
@@ -2319,7 +2319,7 @@ export interface ListAccessPreviewFindingsRequest { /** *Criteria to filter the returned findings.
*/ - filter?: { [key: string]: Criterion }; + filter?: RecordA token used for pagination of results returned.
@@ -2372,7 +2372,7 @@ export interface AccessPreviewFinding { /** *The external principal that has access to a resource within the zone of trust.
*/ - principal?: { [key: string]: string }; + principal?: RecordThe action in the analyzed policy statement that an external principal has permission to @@ -2383,7 +2383,7 @@ export interface AccessPreviewFinding { /** *
The condition in the analyzed policy statement that resulted in a finding.
*/ - condition?: { [key: string]: string }; + condition?: RecordThe resource that an external principal has access to. This is the resource associated @@ -2721,7 +2721,7 @@ export interface ListFindingsRequest { /** *
A filter to match for the findings to return.
*/ - filter?: { [key: string]: Criterion }; + filter?: RecordThe sort order for the findings returned.
@@ -2760,7 +2760,7 @@ export interface FindingSummary { /** *The external principal that has access to a resource within the zone of trust.
*/ - principal?: { [key: string]: string }; + principal?: RecordThe action in the analyzed policy statement that an external principal has permission to @@ -2787,7 +2787,7 @@ export interface FindingSummary { /** *
The condition in the analyzed policy statement that resulted in a finding.
*/ - condition: { [key: string]: string } | undefined; + condition: RecordThe time at which the finding was created.
@@ -2979,7 +2979,7 @@ export interface ListTagsForResourceResponse { /** *The tags that are applied to the specified resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe tags to add to the resource.
*/ - tags: { [key: string]: string } | undefined; + tags: RecordThe list of reviews for the skill, including Key and Value pair.
*/ - Reviews?: { [key: string]: string }; + Reviews?: RecordThe details about the developer that published the skill.
@@ -4430,7 +4430,7 @@ export interface PutSkillAuthorizationRequest { *The authorization result specific to OAUTH code grant output. "Code” must be * populated in the AuthorizationResult map to establish the authorization.
*/ - AuthorizationResult: { [key: string]: string } | undefined; + AuthorizationResult: RecordThe unique identifier of a skill.
diff --git a/clients/client-alexa-for-business/src/protocols/Aws_json1_1.ts b/clients/client-alexa-for-business/src/protocols/Aws_json1_1.ts index 1f713619a5e5..64dc8a996789 100644 --- a/clients/client-alexa-for-business/src/protocols/Aws_json1_1.ts +++ b/clients/client-alexa-for-business/src/protocols/Aws_json1_1.ts @@ -6139,7 +6139,7 @@ const serializeAws_json1_1AudioList = (input: Audio[], context: __SerdeContext): }); }; -const serializeAws_json1_1AuthorizationResult = (input: { [key: string]: string }, context: __SerdeContext): any => { +const serializeAws_json1_1AuthorizationResult = (input: RecordThe environment variables for the autocreated branch.
*/ - environmentVariables?: { [key: string]: string }; + environmentVariables?: RecordThe basic authorization credentials for the autocreated branch. You must @@ -227,7 +227,7 @@ export interface CreateAppRequest { /** *
The environment variables map for an Amplify app.
*/ - environmentVariables?: { [key: string]: string }; + environmentVariables?: RecordEnables the auto building of branches for an Amplify app.
@@ -261,7 +261,7 @@ export interface CreateAppRequest { /** *The tag for an Amplify app.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe build specification (build spec) for an Amplify app.
@@ -368,7 +368,7 @@ export interface App { /** *The tag for the Amplify app.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe description for the Amplify app.
@@ -404,7 +404,7 @@ export interface App { /** *The environment variables for the Amplify app.
*/ - environmentVariables: { [key: string]: string } | undefined; + environmentVariables: RecordThe default domain for the Amplify app.
@@ -751,7 +751,7 @@ export interface CreateBranchRequest { /** *The environment variables for the branch.
*/ - environmentVariables?: { [key: string]: string }; + environmentVariables?: RecordThe basic authorization credentials for the branch. You must base64-encode the @@ -776,7 +776,7 @@ export interface CreateBranchRequest { /** *
The tag for the branch.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe build specification (build spec) for the branch.
@@ -843,7 +843,7 @@ export interface Branch { /** *The tag for the branch of an Amplify app.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe current stage for the branch that is part of an Amplify app.
@@ -873,7 +873,7 @@ export interface Branch { /** *The environment variables specific to a branch of an Amplify app.
*/ - environmentVariables: { [key: string]: string } | undefined; + environmentVariables: RecordEnables auto-building on push for a branch of an Amplify app.
@@ -1020,7 +1020,7 @@ export interface CreateDeploymentRequest { * upload URL per file. Otherwise, the service will only generate a single upload URL for * the zipped files. */ - fileMap?: { [key: string]: string }; + fileMap?: Record When the fileMap
argument is provided in the request,
* fileUploadUrls
will contain a map of file names to upload URLs.
When the fileMap
argument is not provided in the request, this
@@ -2023,7 +2023,7 @@ export interface Step {
/**
*
The list of screenshot URLs for the execution step, if relevant.
*/ - screenshots?: { [key: string]: string }; + screenshots?: RecordThe reason for the current step status.
@@ -2527,7 +2527,7 @@ export interface ListTagsForResourceResponse { /** *A list of tags for the specified The Amazon Resource Name (ARN).
*/ - tags?: { [key: string]: string }; + tags?: RecordThe tags used to tag the resource.
*/ - tags: { [key: string]: string } | undefined; + tags: RecordThe environment variables for an Amplify app.
*/ - environmentVariables?: { [key: string]: string }; + environmentVariables?: RecordEnables branch auto-building for an Amplify app.
@@ -3076,7 +3076,7 @@ export interface UpdateBranchRequest { /** *The environment variables for the branch.
*/ - environmentVariables?: { [key: string]: string }; + environmentVariables?: Record The basic authorization credentials for the branch. You must base64-encode the
diff --git a/clients/client-amplify/src/protocols/Aws_restJson1.ts b/clients/client-amplify/src/protocols/Aws_restJson1.ts
index e89528969cde..490b38302efb 100644
--- a/clients/client-amplify/src/protocols/Aws_restJson1.ts
+++ b/clients/client-amplify/src/protocols/Aws_restJson1.ts
@@ -3845,7 +3845,7 @@ const serializeAws_restJson1CustomRules = (input: CustomRule[], context: __Serde
});
};
-const serializeAws_restJson1EnvironmentVariables = (input: { [key: string]: string }, context: __SerdeContext): any => {
+const serializeAws_restJson1EnvironmentVariables = (input: Record The combination of variants that comprise this variant. You can't specify
* The properties of the component variant that can be overriden when customizing an instance
* of the component. You can't specify The information to bind the component property to form data. An event that occurs in your app. Use this for workflow data binding. One or more key-value pairs to use when tagging the theme data. One or more key-value pairs to use when tagging the theme.tags
as a valid property for variantValues
.tags
as a valid property for
* overrides
.
A key-value pair that specifies the state property name and its initial value.
@@ -1458,7 +1458,7 @@ export interface ComponentChild { *Describes the properties of the child component. You can't specify tags
as a
* valid property for properties
.
The list of ComponentChild
instances for this component.
The unique ID of the child component in its original source system, such as Figma.
@@ -1530,7 +1530,7 @@ export interface Component { *Describes the component's properties. You can't specify tags
as a valid
* property for properties
.
A list of the component's ComponentChild
instances.
tags
as a valid property for
* overrides
.
*/
- overrides: { [key: string]: { [key: string]: string } } | undefined;
+ overrides: RecordThe information to connect a component's properties to data at runtime. You can't specify
* tags
as a valid property for bindingProperties
.
The data binding configuration for the component's properties. Use this for a collection
* component. You can't specify tags
as a valid property for
* collectionProperties
.
The time that the component was created.
@@ -1577,14 +1577,14 @@ export interface Component { /** *One or more key-value pairs to use when tagging the component.
*/ - tags?: { [key: string]: string }; + tags?: RecordDescribes the events that can be raised on the component. Use for the workflow feature in * Amplify Studio that allows you to bind events and actions to * components.
*/ - events?: { [key: string]: ComponentEvent }; + events?: RecordThe schema version of the component when it was imported.
@@ -1624,7 +1624,7 @@ export interface CreateComponentData { /** *Describes the component's properties.
*/ - properties: { [key: string]: ComponentProperty } | undefined; + properties: RecordA list of child components that are instances of the main component.
@@ -1640,28 +1640,28 @@ export interface CreateComponentData { *Describes the component properties that can be overriden to customize an instance of the * component.
*/ - overrides: { [key: string]: { [key: string]: string } } | undefined; + overrides: RecordThe data binding information for the component's properties.
*/ - bindingProperties: { [key: string]: ComponentBindingPropertiesValue } | undefined; + bindingProperties: RecordThe data binding configuration for customizing a component's properties. Use this for a * collection component.
*/ - collectionProperties?: { [key: string]: ComponentDataConfiguration }; + collectionProperties?: RecordOne or more key-value pairs to use when tagging the component data.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
*/ - events?: { [key: string]: ComponentEvent }; + events?: RecordThe schema version of the component when it was imported.
@@ -1706,7 +1706,7 @@ export interface UpdateComponentData { /** *Describes the component's properties.
*/ - properties?: { [key: string]: ComponentProperty }; + properties?: RecordThe components that are instances of the main component.
@@ -1721,23 +1721,23 @@ export interface UpdateComponentData { /** *Describes the properties that can be overriden to customize the component.
*/ - overrides?: { [key: string]: { [key: string]: string } }; + overrides?: RecordThe data binding information for the component's properties.
*/ - bindingProperties?: { [key: string]: ComponentBindingPropertiesValue }; + bindingProperties?: RecordThe configuration for binding a component's properties to a data model. Use this for a * collection component.
*/ - collectionProperties?: { [key: string]: ComponentDataConfiguration }; + collectionProperties?: RecordThe event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
*/ - events?: { [key: string]: ComponentEvent }; + events?: RecordThe schema version of the component when it was imported.
diff --git a/clients/client-amplifyuibuilder/src/protocols/Aws_restJson1.ts b/clients/client-amplifyuibuilder/src/protocols/Aws_restJson1.ts index 8279fc6a76ed..7477c5c276fa 100644 --- a/clients/client-amplifyuibuilder/src/protocols/Aws_restJson1.ts +++ b/clients/client-amplifyuibuilder/src/protocols/Aws_restJson1.ts @@ -747,7 +747,7 @@ export const deserializeAws_restJson1CreateComponentCommand = async ( $metadata: deserializeMetadata(output), entity: undefined, }; - const data: { [key: string]: any } | undefined = __expectObject(await parseBody(output.body, context)); + const data: RecordThe collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordMap containing method level throttling information for API stage in a usage plan.
*/ - throttle?: { [key: string]: ThrottleSettings }; + throttle?: RecordThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
*/ - stageVariableOverrides?: { [key: string]: string }; + stageVariableOverrides?: RecordA Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
@@ -766,7 +766,7 @@ export interface CreateDeploymentRequest { * with the new deployment. Variable names can have alphanumeric and underscore characters, and the values * must match[A-Za-z0-9-._~:/?#&=,]+
.
*/
- variables?: { [key: string]: string };
+ variables?: RecordThe input configuration for the canary deployment when the deployment is a canary release deployment.
@@ -834,7 +834,7 @@ export interface Deployment { /** *A summary of the RestApi at the date and time that the deployment resource was created.
*/ - apiSummary?: { [key: string]: { [key: string]: MethodSnapshot } }; + apiSummary?: RecordThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe mutual TLS authentication configuration for a custom domain name. If specified, API Gateway @@ -1535,12 +1535,12 @@ export interface IntegrationResponse { *
A key-value map specifying response parameters that are passed to the method response from the back end.
* The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}
, where name
is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}
or integration.response.body.{JSON-expression}
, where name
is a valid and unique response header name and JSON-expression
is a valid JSON expression without the $
prefix.
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*/ - responseTemplates?: { [key: string]: string }; + responseTemplates?: RecordSpecifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
must be a valid and unique method request parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
*/ - requestTemplates?: { [key: string]: string }; + requestTemplates?: RecordSpecifies how the method request body of an unmapped content type will be passed through @@ -1698,7 +1698,7 @@ export interface Integration { /** *
Specifies the integration's responses.
*/ - integrationResponses?: { [key: string]: IntegrationResponse }; + integrationResponses?: RecordSpecifies the TLS configuration for an integration.
@@ -1727,12 +1727,12 @@ export interface MethodResponse { /** *A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}
, where name
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid JSON expression without the $
prefix.)
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
*/ - responseModels?: { [key: string]: string }; + responseModels?: RecordA key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
*/ - requestModels?: { [key: string]: string }; + requestModels?: RecordGets a method response associated with a given HTTP status code.
*/ - methodResponses?: { [key: string]: MethodResponse }; + methodResponses?: RecordGets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
@@ -1847,7 +1847,7 @@ export interface Resource { /** *Gets an API resource's method of a given HTTP verb.
*/ - resourceMethods?: { [key: string]: Method }; + resourceMethods?: RecordThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
Specifies whether clients can invoke your API by using the default execute-api
endpoint.
@@ -1999,7 +1999,7 @@ export interface RestApi {
/**
*
The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordSpecifies whether clients can invoke your API by using the default execute-api
endpoint.
@@ -2036,7 +2036,7 @@ export interface CanarySettings {
/**
*
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
*/ - stageVariableOverrides?: { [key: string]: string }; + stageVariableOverrides?: RecordA Boolean flag to indicate whether the canary deployment uses the stage cache or not.
@@ -2092,7 +2092,7 @@ export interface CreateStageRequest { * can have alphanumeric and underscore characters, and the values must match *[A-Za-z0-9-._~:/?#&=,]+
.
*/
- variables?: { [key: string]: string };
+ variables?: RecordThe version of the associated API documentation.
@@ -2112,7 +2112,7 @@ export interface CreateStageRequest { /** *The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key
below) are method paths defined as {resource_path}/{http_method}
for an individual method override, or /\*\/\*
for overriding all methods in the stage.
A map that defines the stage variables for a Stage resource. Variable names can
* have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.
The version of the associated API documentation.
@@ -2280,7 +2280,7 @@ export interface Stage { /** *The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe timestamp when the stage was created.
@@ -2369,7 +2369,7 @@ export interface CreateUsagePlanRequest { /** *The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
A key-value map of query string parameters that specify properties of the export, depending on the requested exportType
. For exportType
* oas30
and swagger
, any combination of the following parameters are supported: extensions='integrations'
or extensions='apigateway'
will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers'
will export the API with x-amazon-apigateway-authorizer extensions. postman
will export the API with Postman extensions, allowing for import to the Postman tool
The content-type of the export, for example application/json
. Currently application/json
and application/yaml
are supported for exportType
ofoas30
and swagger
. This should be specified in the Accept
header for direct API requests.
Response parameters (paths, query strings and headers) of the GatewayResponse as a * string-to-string map of key-value pairs.
*/ - responseParameters?: { [key: string]: string }; + responseParameters?: RecordResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
*/ - responseTemplates?: { [key: string]: string }; + responseTemplates?: RecordA Boolean flag to indicate whether this GatewayResponse is the default gateway response (true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
A string-to-string key-value map of query parameters sdkType
-dependent properties of the SDK. For sdkType
of objectivec
or swift
, a parameter named classPrefix
is required. For sdkType
of android
, parameters named groupId
, artifactId
, artifactVersion
, and invokerPackage
are required. For sdkType
of java
, parameters named serviceName
and javaPackageName
are required.
The collection of tags. Each tag element is associated with a given resource.
*/ - tags?: { [key: string]: string }; + tags?: RecordThe usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}
, where {api_key}
stands for an API key value and the daily log entry is of the format [used quota, remaining quota]
.
The current pagination position in the paged result set.
@@ -5233,7 +5233,7 @@ export interface ImportRestApiRequest { *For example, the AWS CLI command to exclude documentation from the imported API is:
*The AWS CLI command to set the regional endpoint on the imported API is:
*/ - parameters?: { [key: string]: string }; + parameters?: RecordThe POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
@@ -5272,12 +5272,12 @@ export interface PutGatewayResponseRequest { /** *Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
*/ - responseParameters?: { [key: string]: string }; + responseParameters?: RecordResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
*/ - responseTemplates?: { [key: string]: string }; + responseTemplates?: RecordA key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
must be a valid and unique method request parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
*/ - requestTemplates?: { [key: string]: string }; + requestTemplates?: RecordSpecifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates
property on the Integration resource. There are three valid values: WHEN_NO_MATCH
, WHEN_NO_TEMPLATES
, and NEVER
.
@@ -5439,12 +5439,12 @@ export interface PutIntegrationResponseRequest {
*
A key-value map specifying response parameters that are passed to the method response from the back end.
* The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}
, where name
is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}
or integration.response.body.{JSON-expression}
, where name
must be a valid and unique response header name and JSON-expression
a valid JSON expression without the $
prefix.
Specifies a put integration response's templates.
*/ - responseTemplates?: { [key: string]: string }; + responseTemplates?: RecordSpecifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
*/ - requestModels?: { [key: string]: string }; + requestModels?: RecordThe identifier of a RequestValidator for validating the method request.
@@ -5559,12 +5559,12 @@ export interface PutMethodResponseRequest { /** *A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}
, where name
is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid JSON expression without the $
prefix.)
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
*/ - responseModels?: { [key: string]: string }; + responseModels?: RecordCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
@@ -5629,7 +5629,7 @@ export interface TagResourceRequest { /** *The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
*/ - headers?: { [key: string]: string }; + headers?: RecordThe headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
*/ - multiValueHeaders?: { [key: string]: string[] }; + multiValueHeaders?: RecordThe URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
@@ -5678,12 +5678,12 @@ export interface TestInvokeAuthorizerRequest { /** *A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/ - stageVariables?: { [key: string]: string }; + stageVariables?: RecordA key-value map of additional context variables.
*/ - additionalContext?: { [key: string]: string }; + additionalContext?: RecordThe authorization response.
*/ - authorization?: { [key: string]: string[] }; + authorization?: RecordThe open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
*/ - claims?: { [key: string]: string }; + claims?: RecordA key-value map of headers to simulate an incoming invocation request.
*/ - headers?: { [key: string]: string }; + headers?: RecordThe headers as a map from string to list of values to simulate an incoming invocation request.
*/ - multiValueHeaders?: { [key: string]: string[] }; + multiValueHeaders?: RecordA ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
@@ -5791,7 +5791,7 @@ export interface TestInvokeMethodRequest { /** *A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/ - stageVariables?: { [key: string]: string }; + stageVariables?: RecordThe headers of the HTTP response.
*/ - headers?: { [key: string]: string }; + headers?: RecordThe headers of the HTTP response as a map from string to list of values.
*/ - multiValueHeaders?: { [key: string]: string[] }; + multiValueHeaders?: RecordThe API Gateway execution log for the test invoke request.
diff --git a/clients/client-api-gateway/src/protocols/Aws_restJson1.ts b/clients/client-api-gateway/src/protocols/Aws_restJson1.ts index 9bd5c0a1a337..bb8386260888 100644 --- a/clients/client-api-gateway/src/protocols/Aws_restJson1.ts +++ b/clients/client-api-gateway/src/protocols/Aws_restJson1.ts @@ -13985,7 +13985,7 @@ const serializeAws_restJson1ListOfString = (input: string[], context: __SerdeCon }; const serializeAws_restJson1MapOfApiStageThrottleSettings = ( - input: { [key: string]: ThrottleSettings }, + input: RecordA collection of tags associated with the API.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordA version identifier for the API.
@@ -464,7 +464,7 @@ export interface DomainName { /** *The collection of tags associated with a domain name.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordFor HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - RequestParameters?: { [key: string]: string }; + RequestParameters?: RecordRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
*/ - RequestTemplates?: { [key: string]: string }; + RequestTemplates?: RecordSupported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - ResponseParameters?: { [key: string]: { [key: string]: string } }; + ResponseParameters?: RecordThe template selection expression for the integration. Supported only for WebSocket APIs.
@@ -660,12 +660,12 @@ export interface IntegrationResponse { /** *A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
*/ - ResponseParameters?: { [key: string]: string }; + ResponseParameters?: RecordThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*/ - ResponseTemplates?: { [key: string]: string }; + ResponseTemplates?: RecordThe template selection expressions for the integration response.
@@ -789,12 +789,12 @@ export interface Route { /** *The request models for the route. Supported only for WebSocket APIs.
*/ - RequestModels?: { [key: string]: string }; + RequestModels?: RecordThe request parameters for the route. Supported only for WebSocket APIs.
*/ - RequestParameters?: { [key: string]: ParameterConstraints }; + RequestParameters?: RecordThe route ID.
@@ -838,12 +838,12 @@ export interface RouteResponse { /** *Represents the response models of a route response.
*/ - ResponseModels?: { [key: string]: string }; + ResponseModels?: RecordRepresents the response parameters of a route response.
*/ - ResponseParameters?: { [key: string]: ParameterConstraints }; + ResponseParameters?: RecordRepresents the identifier of a route response.
@@ -991,7 +991,7 @@ export interface Stage { /** *Route settings for the stage, by routeKey.
*/ - RouteSettings?: { [key: string]: RouteSettings }; + RouteSettings?: RecordThe name of the stage.
@@ -1001,12 +1001,12 @@ export interface Stage { /** *A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
*/ - StageVariables?: { [key: string]: string }; + StageVariables?: RecordThe collection of tags. Each tag element is associated with a given resource.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordTags for the VPC link.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordThe ID of the VPC link.
@@ -1212,7 +1212,7 @@ export interface CreateApiRequest { /** *The collection of tags. Each tag element is associated with a given resource.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
@@ -1303,7 +1303,7 @@ export interface CreateApiResponse { /** *A collection of tags associated with the API.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordA version identifier for the API.
@@ -1700,7 +1700,7 @@ export interface CreateDomainNameRequest { /** *The collection of tags associated with a domain name.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordThe collection of tags associated with a domain name.
*/ - Tags?: { [key: string]: string }; + Tags?: RecordFor HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - RequestParameters?: { [key: string]: string }; + RequestParameters?: RecordRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
*/ - RequestTemplates?: { [key: string]: string }; + RequestTemplates?: RecordSupported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - ResponseParameters?: { [key: string]: { [key: string]: string } }; + ResponseParameters?: RecordThe template selection expression for the integration.
@@ -1955,17 +1955,17 @@ export interface CreateIntegrationResult { *For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - RequestParameters?: { [key: string]: string }; + RequestParameters?: RecordRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
*/ - RequestTemplates?: { [key: string]: string }; + RequestTemplates?: RecordSupported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
*/ - ResponseParameters?: { [key: string]: { [key: string]: string } }; + ResponseParameters?: RecordThe template selection expression for the integration. Supported only for WebSocket APIs.
@@ -2019,12 +2019,12 @@ export interface CreateIntegrationResponseRequest { /** *A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
*/ - ResponseParameters?: { [key: string]: string }; + ResponseParameters?: RecordThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*/ - ResponseTemplates?: { [key: string]: string }; + ResponseTemplates?: RecordThe template selection expression for the integration response. Supported only for WebSocket APIs.
@@ -2060,12 +2060,12 @@ export interface CreateIntegrationResponseResponse { /** *A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
*/ - ResponseParameters?: { [key: string]: string }; + ResponseParameters?: RecordThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*/ - ResponseTemplates?: { [key: string]: string }; + ResponseTemplates?: RecordThe template selection expressions for the integration response.
@@ -2199,12 +2199,12 @@ export interface CreateRouteRequest { /** *The request models for the route. Supported only for WebSocket APIs.
*/ - RequestModels?: { [key: string]: string }; + RequestModels?: RecordThe request parameters for the route. Supported only for WebSocket APIs.
*/ - RequestParameters?: { [key: string]: ParameterConstraints }; + RequestParameters?: RecordThe route key for the route.
@@ -2270,12 +2270,12 @@ export interface CreateRouteResult { /** *The request models for the route. Supported only for WebSocket APIs.
*/ - RequestModels?: { [key: string]: string }; + RequestModels?: RecordThe request parameters for the route. Supported only for WebSocket APIs.
*/ - RequestParameters?: { [key: string]: ParameterConstraints }; + RequestParameters?: RecordThe route ID.
@@ -2324,12 +2324,12 @@ export interface CreateRouteResponseRequest { /** *The response models for the route response.
*/ - ResponseModels?: { [key: string]: string }; + ResponseModels?: Record