diff --git a/codegen/sdk/aws-models/amplifyuibuilder.json b/codegen/sdk/aws-models/amplifyuibuilder.json index eea20c3afae..0599a717815 100644 --- a/codegen/sdk/aws-models/amplifyuibuilder.json +++ b/codegen/sdk/aws-models/amplifyuibuilder.json @@ -7,7 +7,7 @@ "type": { "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", "traits": { - "smithy.api#documentation": "
The type of navigation action. Valid values are url
and anchor
. This value is required for a navigation action.
The type of navigation action. Valid values are url
and anchor
.\n This value is required for a navigation action.
The HTML anchor link to the location to open. Specify this value for a navigation action.
" + "smithy.api#documentation": "The HTML anchor link to the location to open. Specify this value for a navigation\n action.
" } }, "target": { @@ -31,13 +31,13 @@ "global": { "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", "traits": { - "smithy.api#documentation": "Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
" + "smithy.api#documentation": "Specifies whether the user should be signed out globally. Specify this value for an auth\n sign out action.
" } }, "model": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the data model. Use when the action performs an operation on an Amplify DataStore\n model.
" + "smithy.api#documentation": "The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
" } }, "id": { @@ -49,7 +49,7 @@ "fields": { "target": "com.amazonaws.amplifyuibuilder#ComponentProperties", "traits": { - "smithy.api#documentation": "A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action\n performs an operation on an Amplify DataStore model.
" + "smithy.api#documentation": "A dictionary of key-value pairs mapping Amplify Studio properties to fields\n in a data model. Use when the action performs an operation on an Amplify\n DataStore model.
" } }, "state": { @@ -60,7 +60,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the event action configuration for an element of a Component
\n or ComponentChild
. Use for the workflow feature in Amplify Studio\n that allows you to bind events and actions to components. ActionParameters
\n defines the action that is performed when an event occurs on the component.
Represents the event action configuration for an element of a Component
or\n ComponentChild
. Use for the workflow feature in Amplify Studio\n that allows you to bind events and actions to components. ActionParameters
\n defines the action that is performed when an event occurs on the component.
The Amplify UI Builder API provides a programmatic interface for creating\n and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's\n backend Amazon Web Services resources.
\nYou can also use the Amplify Studio visual designer to create UI components\n and model data for an app. For more information, see Introduction in the\n Amplify Docs.
\nThe Amplify Framework is a comprehensive set of SDKs, libraries, tools, and\n documentation for client app development. For more information, see the Amplify Framework. For more information about\n deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.
", @@ -209,7 +232,7 @@ "events": { "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", "traits": { - "smithy.api#documentation": "Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.
" + "smithy.api#documentation": "Describes the events that can be raised on the component. Use for the workflow feature in\n Amplify Studio that allows you to bind events and actions to\n components.
" } }, "schemaVersion": { @@ -346,7 +369,13 @@ "events": { "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", "traits": { - "smithy.api#documentation": "Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.
" + "smithy.api#documentation": "Describes the events that can be raised on the child component. Use for the workflow\n feature in Amplify Studio that allows you to bind events and actions to\n components.
" + } + }, + "sourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique ID of the child component in its original source system, such as Figma.
" } } }, @@ -466,10 +495,16 @@ "traits": { "smithy.api#documentation": "Describes information about the action.
" } + }, + "bindingEvent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Binds an event to an action on a component. When you specify a bindingEvent
, the event is called when the action is performed.
Describes the configuration of an event. You can bind an event and a corresponding\n action to a Component
or a ComponentChild
. A button click\n is an example of an event.
Describes the configuration of an event. You can bind an event and a corresponding action\n to a Component
or a ComponentChild
. A button click is an example of\n an event.
The access code to send in the request.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "redirectUri": { @@ -1265,11 +1310,10 @@ "type": "structure", "members": { "accessToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.amplifyuibuilder#SensitiveString", "traits": { "smithy.api#documentation": "The access token.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "expiresIn": { @@ -1280,11 +1324,10 @@ } }, "refreshToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.amplifyuibuilder#SensitiveString", "traits": { "smithy.api#documentation": "The token to use to refresh a previously issued access token that might have\n expired.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } } } @@ -1868,7 +1911,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the state configuration when an action modifies a property of another\n element within the same component.
" + "smithy.api#documentation": "Represents the state configuration when an action modifies a property of another element\n within the same component.
" } }, "com.amazonaws.amplifyuibuilder#Predicate": { @@ -1961,11 +2004,10 @@ "type": "structure", "members": { "token": { - "target": "smithy.api#String", + "target": "com.amazonaws.amplifyuibuilder#SensitiveString", "traits": { "smithy.api#documentation": "The token to use to refresh a previously issued access token that might have\n expired.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } } }, @@ -1977,11 +2019,10 @@ "type": "structure", "members": { "accessToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.amplifyuibuilder#SensitiveString", "traits": { "smithy.api#documentation": "The access token.
", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "expiresIn": { @@ -2019,6 +2060,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.amplifyuibuilder#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -2236,7 +2283,10 @@ "additionalSchemas": [ "com.amazonaws.amplifyuibuilder#Theme" ] - } + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ] } }, "com.amazonaws.amplifyuibuilder#ThemeSummary": { diff --git a/codegen/sdk/aws-models/api-gateway.json b/codegen/sdk/aws-models/api-gateway.json index 795fcef5a4a..e592cf9407e 100644 --- a/codegen/sdk/aws-models/api-gateway.json +++ b/codegen/sdk/aws-models/api-gateway.json @@ -8318,8 +8318,8 @@ "traits": { "smithy.api#documentation": "[Required] Specifies a put integration request's HTTP method.
", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#jsonName": "requestHttpMethod" + "smithy.api#jsonName": "requestHttpMethod", + "smithy.api#required": {} } }, "type": { diff --git a/codegen/sdk/aws-models/apprunner.json b/codegen/sdk/aws-models/apprunner.json index fb15ef1fe53..ad29ce60899 100644 --- a/codegen/sdk/aws-models/apprunner.json +++ b/codegen/sdk/aws-models/apprunner.json @@ -90,6 +90,9 @@ { "target": "com.amazonaws.apprunner#CreateConnection" }, + { + "target": "com.amazonaws.apprunner#CreateObservabilityConfiguration" + }, { "target": "com.amazonaws.apprunner#CreateService" }, @@ -102,6 +105,9 @@ { "target": "com.amazonaws.apprunner#DeleteConnection" }, + { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfiguration" + }, { "target": "com.amazonaws.apprunner#DeleteService" }, @@ -114,6 +120,9 @@ { "target": "com.amazonaws.apprunner#DescribeCustomDomains" }, + { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfiguration" + }, { "target": "com.amazonaws.apprunner#DescribeService" }, @@ -129,6 +138,9 @@ { "target": "com.amazonaws.apprunner#ListConnections" }, + { + "target": "com.amazonaws.apprunner#ListObservabilityConfigurations" + }, { "target": "com.amazonaws.apprunner#ListOperations" }, @@ -289,7 +301,7 @@ "Latest": { "target": "com.amazonaws.apprunner#Boolean", "traits": { - "smithy.api#documentation": "It's set to true
for the configuration with the highest Revision
among all configurations that share the same\n Name
. It's set to false
otherwise.
It's set to true
for the configuration with the highest Revision
among all configurations that share the same\n AutoScalingConfigurationName
. It's set to false
otherwise.
Create an App Runner automatic scaling configuration resource. App Runner requires this resource\n when you create App Runner services that require non-default auto scaling settings. You can share an\n auto scaling configuration across multiple services.
\nCreate multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName
. The call\n returns incremental AutoScalingConfigurationRevision
values. When you create a service, you can set it to use the latest active revision of\n an auto scaling configuration or a specific revision.
Configure a higher MinSize
to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is\n a higher minimal cost.
Configure a lower MaxSize
to control your cost. The tradeoff is lower responsiveness during peak demand.
Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require\n non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
\nCreate multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName
. The call\n returns incremental AutoScalingConfigurationRevision
values. When you create a service and configure an auto scaling configuration resource,\n the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific\n revision.
Configure a higher MinSize
to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is\n a higher minimal cost.
Configure a lower MaxSize
to control your cost. The tradeoff is lower responsiveness during peak demand.
Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable\n non-default observability features. You can share an observability configuration across multiple services.
\nCreate multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName
. The\n call returns incremental ObservabilityConfigurationRevision
values. When you create a service and configure an observability configuration\n resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a\n specific revision.
The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional\n parameters that describe the configuration of these features (currently one parameter, TraceConfiguration
). If you don't specify a feature\n parameter, App Runner doesn't enable the feature.
A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number\n 1
of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
The name DefaultConfiguration
is reserved. You can't use it to create a new observability configuration, and you can't create a\n revision of it.
When you want to use your own observability configuration for your App Runner service, create a configuration with a different name,\n and then provide it when you create or update your service.
\nThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
" + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
" + } + } + } + }, + "com.amazonaws.apprunner#CreateObservabilityConfigurationResponse": { + "type": "structure", + "members": { + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "A description of the App Runner observability configuration that's created by this request.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.apprunner#CreateService": { "type": "operation", "input": { @@ -859,7 +930,7 @@ "InstanceConfiguration": { "target": "com.amazonaws.apprunner#InstanceConfiguration", "traits": { - "smithy.api#documentation": "The runtime configuration of instances (scaling units) of the App Runner service.
" + "smithy.api#documentation": "The runtime configuration of instances (scaling units) of your service.
" } }, "Tags": { @@ -883,7 +954,7 @@ "AutoScalingConfigurationArn": { "target": "com.amazonaws.apprunner#AppRunnerResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service. If not provided,\n App Runner associates the latest revision of a default auto scaling configuration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner\n associates the latest revision of a default auto scaling configuration.
\nSpecify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
\n
Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
\n
Configuration settings related to network traffic of the web application that the App Runner service runs.
" } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "The observability configuration of your service.
" + } } } }, @@ -1148,6 +1225,53 @@ } } }, + "com.amazonaws.apprunner#DeleteObservabilityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.
" + } + }, + "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.
\nThe ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n
or\n .../name/revision\n
. If a revision isn't specified, the latest active revision is deleted.
A description of the App Runner observability configuration that this request just deleted.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.apprunner#DeleteService": { "type": "operation", "input": { @@ -1393,6 +1517,53 @@ } } }, + "com.amazonaws.apprunner#DescribeObservabilityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Return a full description of an App Runner observability configuration resource.
" + } + }, + "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.
\nThe ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n
or\n .../name/revision\n
. If a revision isn't specified, the latest active revision is\n described.
A full description of the App Runner observability configuration that you specified in this request.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.apprunner#DescribeService": { "type": "operation", "input": { @@ -1920,7 +2091,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or\n the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.
", + "smithy.api#documentation": "Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.
\nTo retrieve a full description of a particular configuration revision, call and provide one of\n the ARNs returned by ListAutoScalingConfigurations
.
The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner\n returns revisions of all configurations.
" + "smithy.api#documentation": "The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner\n returns revisions of all active configurations.
" } }, "LatestOnly": { "target": "com.amazonaws.apprunner#Boolean", "traits": { - "smithy.api#documentation": "Set to true
to list only the latest revision for each requested configuration name.
Keep as false
to list all revisions for each requested configuration name.
Default: false
\n
Set to true
to list only the latest revision for each requested configuration name.
Set to false
to list all revisions for each requested configuration name.
Default: true
\n
Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.
\nTo retrieve a full description of a particular configuration revision, call and provide one\n of the ARNs returned by ListObservabilityConfigurations
.
The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified,\n App Runner returns revisions of all active configurations.
" + } + }, + "LatestOnly": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#documentation": "Set to true
to list only the latest revision for each requested configuration name.
Set to false
to list all revisions for each requested configuration name.
Default: true
\n
The maximum number of results to include in each response (result page). It's used for a paginated request.
\nIf you don't specify MaxResults
, the request retrieves all available results in a single response.
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.
\nIf you don't specify NextToken
, the request retrieves the first result page.
A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults
\n records for each call.
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
" + } + } + } + }, "com.amazonaws.apprunner#ListOperations": { "type": "operation", "input": { @@ -2339,6 +2582,119 @@ "smithy.api#box": {} } }, + "com.amazonaws.apprunner#ObservabilityConfiguration": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of this observability configuration.
" + } + }, + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
" + } + }, + "TraceConfiguration": { + "target": "com.amazonaws.apprunner#TraceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.
" + } + }, + "ObservabilityConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#documentation": "The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\"
) that share the\n same ObservabilityConfigurationName
.
It's set to true
for the configuration with the highest Revision
among all configurations that share the same\n ObservabilityConfigurationName
. It's set to false
otherwise.
The current state of the observability configuration. If the status of a configuration revision is INACTIVE
, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.
The time when the observability configuration was created. It's in Unix time stamp format.
" + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the observability configuration was deleted. It's in Unix time stamp format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same\n ObservabilityConfigurationName
and different ObservabilityConfigurationRevision
values.
The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the\n configuration of these features (currently one member, TraceConfiguration
). If a feature member isn't specified, the feature isn't\n enabled.
The Amazon Resource Name (ARN) of this observability configuration.
" + } + }, + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
" + } + }, + "ObservabilityConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#documentation": "The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\"
) that share the\n same ObservabilityConfigurationName
.
Provides summary information about an App Runner observability configuration resource.
\nThis type contains limited information about an observability configuration. It includes only identification information, without configuration\n details. It's returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration\n actions using the ObservabilityConfiguration type.
" + } + }, + "com.amazonaws.apprunner#ObservabilityConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationSummary" + } + }, "com.amazonaws.apprunner#OperationStatus": { "type": "string", "traits": { @@ -2762,6 +3118,12 @@ "smithy.api#documentation": "Configuration settings related to network traffic of the web application that this service runs.
", "smithy.api#required": {} } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "The observability configuration of this service.
" + } } }, "traits": { @@ -2798,6 +3160,27 @@ "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-_]{3,39}$" } }, + "com.amazonaws.apprunner#ServiceObservabilityConfiguration": { + "type": "structure", + "members": { + "ObservabilityEnabled": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#documentation": "When true
, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn
is\n specified.
The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n ObservabilityEnabled
is true
.
Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
\n
Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
\n
Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to\n enable. They're configured in a separate resource that you associate with your service.
" + } + }, "com.amazonaws.apprunner#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3141,6 +3524,32 @@ "com.amazonaws.apprunner#Timestamp": { "type": "timestamp" }, + "com.amazonaws.apprunner#TraceConfiguration": { + "type": "structure", + "members": { + "Vendor": { + "target": "com.amazonaws.apprunner#TracingVendor", + "traits": { + "smithy.api#documentation": "The implementation provider chosen for tracing App Runner services.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration of the tracing feature within an App Runner observability configuration.
" + } + }, + "com.amazonaws.apprunner#TracingVendor": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWSXRAY", + "name": "AWSXRAY" + } + ] + } + }, "com.amazonaws.apprunner#UUID": { "type": "string", "traits": { @@ -3245,7 +3654,7 @@ "InstanceConfiguration": { "target": "com.amazonaws.apprunner#InstanceConfiguration", "traits": { - "smithy.api#documentation": "The runtime configuration to apply to instances (scaling units) of the App Runner service.
" + "smithy.api#documentation": "The runtime configuration to apply to instances (scaling units) of your service.
" } }, "AutoScalingConfigurationArn": { @@ -3265,6 +3674,12 @@ "traits": { "smithy.api#documentation": "Configuration settings related to network traffic of the web application that the App Runner service runs.
" } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "The observability configuration of your service.
" + } } } }, diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index 230a6a986e3..746a63d4042 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -1412,7 +1412,7 @@ "Name": { "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { - "smithy.api#documentation": "The name of the dimension. Dimension names must contain only ASCII characters and must include \n\t\t\tat least one non-whitespace character.
", + "smithy.api#documentation": "The name of the dimension. Dimension names must contain only ASCII characters, must include \n\t\t\tat least one non-whitespace character, and cannot start with a colon (:
).
A dimension is a name/value pair that is part of the identity of a metric. You \n\t\t\tcan assign up to 10 dimensions to a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric.
" + "smithy.api#documentation": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId
as a dimension name, and the actual instance ID as the value for that dimension.
You \n\t\tcan assign up to 10 dimensions to a metric.
" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1869,7 +1869,7 @@ } ], "traits": { - "smithy.api#documentation": "You can use the GetMetricData
API to retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Calls to the GetMetricData
API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics
. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
\n\t\tData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.
\n\t\t\n\t\tIf you omit Unit
in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one\n\t\t\tquery. But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics
. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
\n\t\tData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.
\n\t\t\n\t\tIf you omit Unit
in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
\n Using Metrics Insights queries with metric math\n
\n\t\tYou can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1883,7 +1883,7 @@ "MetricDataQueries": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "The metric queries to be returned. A single GetMetricData
call can include as many as 500 MetricDataQuery
\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.
The metric queries to be returned. A single GetMetricData
call can include as many as 500 MetricDataQuery
\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.
The output format for the stream. Valid values are json
\n\t\t\tand opentelemetry0.7
. For more information about metric stream\n\t\t\toutput formats, see \n\t\t\t\n\t\t\t\tMetric streams output formats.
Each entry in this array displays information about one or more metrics that include extended statistics\n\t\t\tin the metric stream. For more information about extended statistics, see \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.
" } } } @@ -3293,7 +3299,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing
is used.
Sets how this alarm is to handle missing data points. The valid values\n \tare breaching
, notBreaching
, ignore
, and \n \tmissing
. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default \n \tbehavior of missing
is used.
The math expression to be performed on the returned data, if this object is performing a math expression. This expression\n\t\t\tcan use the Id
of the other metrics to refer to those metrics, and can also use the Id
of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either \n\t\t\tExpression
or MetricStat
but not both.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.
\n\t\tA math expression\n\t\t\tcan use the Id
of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id
of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either \n\t\t\tExpression
or MetricStat
but not both.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported\n\t\t\tuse of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a math expression on metric data. A\n\t\t\tsingle GetMetricData
call can include up to 500 MetricDataQuery
\n\t\t\tstructures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery
in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm
call can include up to 20\n\t\t\t\tMetricDataQuery
structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat
parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression
parameter\n\t\t\tto perform a math expression. Of those Expression
structures, one must have True
\n\t\tas the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
\n\t\t\toperation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported\n\t\t\tuse of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData
call can include up to 500 MetricDataQuery
\n\t\t\tstructures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery
in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm
call can include up to 20\n\t\t\t\tMetricDataQuery
structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat
parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression
parameter\n\t\t\tto perform a math expression. Of those Expression
structures, one must have True
\n\t\tas the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
\n\t\t\toperation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
An array of metric name and namespace pairs that stream the extended statistics listed\n\t\tin the value of the AdditionalStatistics
parameter. There can be as many as \n\t\t100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the extended statistics, no matter their dimensions.
", + "smithy.api#required": {} + } + }, + "AdditionalStatistics": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", + "traits": { + "smithy.api#documentation": "The list of extended statistics that are to be streamed for the metrics listed\n\t\tin the IncludeMetrics
array in this structure. This list can include as many as 20 statistics.
If the OutputFormat
for the stream is opentelemetry0.7
, the only \n\t\t\tvalid values are p??\n
percentile statistics such as p90
, p99
and so on.
If the OutputFormat
for the stream is json
, \n\t\t\tthe valid values are include the abbreviations for all of the extended statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\ttm98,
\n wm90
, PR(:300)
, and so on.
By default, a metric stream always sends the MAX
, MIN
, SUM
, \n\t\t\tand SAMPLECOUNT
statistics for each metric that is streamed. This structure contains information for\n\t\t\tone metric that includes extended statistics in the stream. For more information about extended statistics, \n\t\t\tsee CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.
The metric namespace for the metric.
", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This object contains the information for one metric that is to streamed with \n\t\textended statistics.
" + } + }, "com.amazonaws.cloudwatch#MetricWidget": { "type": "string" }, @@ -3891,7 +3962,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.
\n\t\tThe alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.
\n\t\tUsing composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.
\n\t\tCurrently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.
\n\t\tIt is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\n\t\t\tTo get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA
. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA
state.
When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.
\n\t\t\n\t\tTo use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm
permission that is scoped to *
. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole
to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.
Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.
\n\t\tThe alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.
\n\t\tUsing composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.
\n\t\tCurrently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.
\n\t\tIt is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\n\t\t\tTo get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA
. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA
state.
When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.
\n\t\t\n\t\tTo use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm
permission that is scoped to *
. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole
to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.
\n\t\tFor more information, see \n\t\tUsing Metric Streams.
\n\t\tTo create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole
permission\n\t\t\tand either the CloudWatchFullAccess
\n\t\tpolicy or the cloudwatch:PutMetricStream
\n\t\tpermission.
When you create or update a metric stream, you choose one of the following:
\n\t\tStream metrics from all metric namespaces in the account.
\nStream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in ExcludeFilters
.
Stream metrics from only the metric namespaces that you list in \n\t\t\t\tIncludeFilters
.
When you use PutMetricStream
to create a new metric stream, the stream \n\t\tis created in the running
state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.
\n\t\tFor more information, see \n\t\tUsing Metric Streams.
\n\t\tTo create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole
permission\n\t\t\tand either the CloudWatchFullAccess
\n\t\tpolicy or the cloudwatch:PutMetricStream
\n\t\tpermission.
When you create or update a metric stream, you choose one of the following:
\n\t\tStream metrics from all metric namespaces in the account.
\nStream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in ExcludeFilters
.
Stream metrics from only the metric namespaces that you list in \n\t\t\t\tIncludeFilters
.
By default, a metric stream always sends the MAX
, MIN
, SUM
, \n\t\t\tand SAMPLECOUNT
statistics for each metric that is streamed. You can use the\n\t\t\tStatisticsConfigurations
parameter to have \n\t\t\tthe metric stream also send extended statistics in the stream. Streaming extended statistics incurs\n\t\t\tadditional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream
to create a new metric stream, the stream \n\t\tis created in the running
state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.
A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.
\n\t\tTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\n\t\tYou can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.
" } + }, + "StatisticsConfigurations": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", + "traits": { + "smithy.api#documentation": "By default, a metric stream always sends the MAX
, MIN
, SUM
, \n\t\t\tand SAMPLECOUNT
statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send extended statistics in the stream. This \n\t\t\tarray can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of extended statistics to stream\n\t\t\tfor those metrics. The extended statistics that you can stream depend on the stream's OutputFormat
.\n\t\t\tIf the OutputFormat
is json
, you can stream any extended statistic that is supported \n\t\t\tby CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat
is \n\t\t\topentelemetry0.7
, you can stream percentile statistics (p??).
Adds a notification channel to DevOps Guru. A notification channel is used to notify you\n\t\t\tabout important DevOps Guru events, such as when an insight is generated.
\n\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
", + "smithy.api#documentation": "Adds a notification channel to DevOps Guru. A notification channel is used to notify you\n\t\t\tabout important DevOps Guru events, such as when an insight is generated.
\n\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
", "smithy.api#http": { "method": "PUT", "uri": "/channels", @@ -173,12 +173,12 @@ "Status": { "target": "com.amazonaws.devopsguru#EventSourceOptInStatus", "traits": { - "smithy.api#documentation": "The status of the CodeGuru Profiler integration.
" + "smithy.api#documentation": "The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to\n\t\t\tconsume recommendations that are generated from Amazon CodeGuru Profiler.
" } } }, "traits": { - "smithy.api#documentation": "Information about your account's integration with Amazon CodeGuru Profiler.
" + "smithy.api#documentation": "Information about your account's integration with Amazon CodeGuru Profiler. This\n\t\t\treturns whether DevOps Guru is configured to consume recommendations generated from Amazon\n\t\t\tCodeGuru Profiler.
" } }, "com.amazonaws.devopsguru#AnomalyDescription": { @@ -315,7 +315,7 @@ } }, "traits": { - "smithy.api#documentation": "Metadata about an anomaly. The anomaly is detected using analysis of the metric data\u2028 over a period of time
" + "smithy.api#documentation": "Metadata about the detection source that generates proactive anomalies. The anomaly is\n\t\t\tdetected using analysis of the metric data\u2028 over a period of time
" } }, "com.amazonaws.devopsguru#AnomalyStatus": { @@ -417,6 +417,9 @@ { "target": "com.amazonaws.devopsguru#AddNotificationChannel" }, + { + "target": "com.amazonaws.devopsguru#DeleteInsight" + }, { "target": "com.amazonaws.devopsguru#DescribeAccountHealth" }, @@ -892,6 +895,60 @@ "smithy.api#documentation": "The time range of a cost estimation.
" } }, + "com.amazonaws.devopsguru#DeleteInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#DeleteInsightRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#DeleteInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#ConflictException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the insight along with the associated anomalies, events and recommendations.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/insights/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.devopsguru#DeleteInsightRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "The ID of the insight.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.devopsguru#DeleteInsightResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.devopsguru#DescribeAccountHealth": { "type": "operation", "input": { @@ -1129,7 +1186,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation lists details about a DevOps Guru event source that is shared with your\u2028 account.
", + "smithy.api#documentation": "Returns the integration status of services that are integrated with DevOps Guru as Consumer\n\t\t\tvia EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru\n\t\t\tProfiler, which can produce proactive recommendations which can be stored and viewed in\n\t\t\tDevOps Guru.
", "smithy.api#http": { "method": "POST", "uri": "/event-sources", @@ -1147,7 +1204,7 @@ "EventSources": { "target": "com.amazonaws.devopsguru#EventSourcesConfig", "traits": { - "smithy.api#documentation": "The name of the event source.
" + "smithy.api#documentation": "Lists the event sources in the configuration.
" } } } @@ -1902,12 +1959,12 @@ "AmazonCodeGuruProfiler": { "target": "com.amazonaws.devopsguru#AmazonCodeGuruProfilerIntegration", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Information about whether DevOps Guru is configured to consume recommendations which\n\t\t\tare generated from AWS CodeGuru Profiler.
" } } }, "traits": { - "smithy.api#documentation": "Describes the event sources.
" + "smithy.api#documentation": "Information about the integration of DevOps Guru as consumer with another AWS service, such\n\t\t\tas AWS CodeGuru Profiler via EventBridge.
" } }, "com.amazonaws.devopsguru#EventTimeRange": { @@ -3091,7 +3148,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a notification channel. A notification channel is used to notify\n\t\t\tyou when DevOps Guru creates an insight. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).
\n\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
" + "smithy.api#documentation": "Information about a notification channel. A notification channel is used to notify\n\t\t\tyou when DevOps Guru creates an insight. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).
\n\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
" } }, "com.amazonaws.devopsguru#NotificationChannelConfig": { @@ -3100,7 +3157,7 @@ "Sns": { "target": "com.amazonaws.devopsguru#SnsChannelConfig", "traits": { - "smithy.api#documentation": "Information about a notification channel configured in DevOps Guru to send notifications\n\t\t\twhen insights are created.
\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
", + "smithy.api#documentation": "Information about a notification channel configured in DevOps Guru to send notifications\n\t\t\twhen insights are created.
\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
", "smithy.api#required": {} } } @@ -3660,7 +3717,7 @@ "SourceMetadata": { "target": "com.amazonaws.devopsguru#AnomalySourceMetadata", "traits": { - "smithy.api#documentation": "Returns the metadata of the source.
" + "smithy.api#documentation": "The metadata of the source which detects proactive anomalies.
" } }, "AnomalyResources": { @@ -5205,7 +5262,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
" + "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
\n\t\t\t\tIf you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.
" } }, "com.amazonaws.devopsguru#SsmOpsItemId": { @@ -5557,7 +5614,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the event source configuration.
", + "smithy.api#documentation": "Enables or disables integration with a service that can be integrated with DevOps Guru. The\n\t\t\tone service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which\n\t\t\tcan produce proactive recommendations which can be stored and viewed in DevOps Guru.
", "smithy.api#http": { "method": "PUT", "uri": "/event-sources", @@ -5571,7 +5628,7 @@ "EventSources": { "target": "com.amazonaws.devopsguru#EventSourcesConfig", "traits": { - "smithy.api#documentation": "The name of the event source.
" + "smithy.api#documentation": "Configuration information about the integration of DevOps Guru as the Consumer via\n\t\t\tEventBridge with another AWS Service.
" } } } diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 786ea9fd582..3b76f2454b2 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -47194,6 +47194,94 @@ { "value": "z1d.metal", "name": "z1d_metal" + }, + { + "value": "x2idn.16xlarge", + "name": "x2idn_16xlarge" + }, + { + "value": "x2idn.24xlarge", + "name": "x2idn_24xlarge" + }, + { + "value": "x2idn.32xlarge", + "name": "x2idn_32xlarge" + }, + { + "value": "x2iedn.xlarge", + "name": "x2iedn_xlarge" + }, + { + "value": "x2iedn.2xlarge", + "name": "x2iedn_2xlarge" + }, + { + "value": "x2iedn.4xlarge", + "name": "x2iedn_4xlarge" + }, + { + "value": "x2iedn.8xlarge", + "name": "x2iedn_8xlarge" + }, + { + "value": "x2iedn.16xlarge", + "name": "x2iedn_16xlarge" + }, + { + "value": "x2iedn.24xlarge", + "name": "x2iedn_24xlarge" + }, + { + "value": "x2iedn.32xlarge", + "name": "x2iedn_32xlarge" + }, + { + "value": "c6a.large", + "name": "c6a_large" + }, + { + "value": "c6a.xlarge", + "name": "c6a_xlarge" + }, + { + "value": "c6a.2xlarge", + "name": "c6a_2xlarge" + }, + { + "value": "c6a.4xlarge", + "name": "c6a_4xlarge" + }, + { + "value": "c6a.8xlarge", + "name": "c6a_8xlarge" + }, + { + "value": "c6a.12xlarge", + "name": "c6a_12xlarge" + }, + { + "value": "c6a.16xlarge", + "name": "c6a_16xlarge" + }, + { + "value": "c6a.24xlarge", + "name": "c6a_24xlarge" + }, + { + "value": "c6a.32xlarge", + "name": "c6a_32xlarge" + }, + { + "value": "c6a.48xlarge", + "name": "c6a_48xlarge" + }, + { + "value": "c6a.metal", + "name": "c6a_metal" + }, + { + "value": "m6a.metal", + "name": "m6a_metal" } ] } diff --git a/codegen/sdk/aws-models/efs.json b/codegen/sdk/aws-models/efs.json index d83dfbeff4a..231f1d50619 100644 --- a/codegen/sdk/aws-models/efs.json +++ b/codegen/sdk/aws-models/efs.json @@ -49,7 +49,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if the access point you are trying to create already exists, with the\n creation token you provided in the request.
", + "smithy.api#documentation": "Returned if the access point that you are trying to create already exists, with the\n creation token you provided in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -162,7 +162,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if the Amazon Web Services account has already created the maximum number of access points\n allowed per file system.
", + "smithy.api#documentation": "Returned if the Amazon Web Services account has already created the maximum number of access points\n allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -210,7 +210,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage classes.\n For more information, see Regional and One Zone storage redundancy.
", + "smithy.api#documentation": "Returned if the Availability Zone that was specified for a mount target is \n different from the Availability Zone that was specified for One Zone storage.\n For more information, see Regional and One Zone storage redundancy.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -237,7 +237,7 @@ "Status": { "target": "com.amazonaws.efs#Status", "traits": { - "smithy.api#documentation": "Describes the status of the file system's backup policy.
\n\n \n ENABLED
\n - EFS is automatically backing up the file system.
\n \n ENABLING
\n - EFS is turning on automatic backups for the file system.
\n \n DISABLED
\n - automatic back ups are turned off for the file system.
\n \n DISABLING
\n - EFS is turning off automatic backups for the file system.
Describes the status of the file system's backup policy.
\n\n \n ENABLED
\n - EFS is automatically backing up the file system.
\n \n ENABLING
\n - EFS is turning on automatic backups for the file system.
\n \n DISABLED
\n - Automatic back ups are turned off for\n the file system.
\n \n DISABLING
\n - EFS is turning off automatic backups for the file system.
Describes the file system's backup policy, indicating whether automatic backups are turned on or off..
" + "smithy.api#documentation": "Describes the file system's backup policy, indicating whether automatic backups are\n turned on or off.
" } } } @@ -315,10 +315,13 @@ }, { "target": "com.amazonaws.efs#InternalServerError" + }, + { + "target": "com.amazonaws.efs#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data\n in its own directory and below. To learn more, see Mounting a file system using EFS access\n points.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Specifies the directory on the Amazon EFS file system that the access point exposes as\n the root directory of your file system to NFS clients using the access point. \n The clients using the access point can only access the root directory and below. \n If the RootDirectory
> Path
specified does not exist, \n EFS creates it and applies the CreationInfo
settings when a client connects to an access point. \n When specifying a RootDirectory
, you need to provide the Path
, and the CreationInfo
.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount \n using the access point will fail.
" + "smithy.api#documentation": "Specifies the directory on the Amazon EFS file system that the access point\n exposes as the root directory of your file system to NFS clients using the access point. The\n clients using the access point can only access the root directory and below. If the\n RootDirectory
> Path
specified does not exist, EFS creates it\n and applies the CreationInfo
settings when a client connects to an access point.\n When specifying a RootDirectory
, you must provide the Path
, and the\n CreationInfo
.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount \n using the access point will fail.
" } } } @@ -430,7 +433,7 @@ "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the KMS key that you want to use to protect the encrypted file system. This\n parameter is only required if you want to use a non-default KMS key. If this parameter is not\n specified, the default KMS key for Amazon EFS is used. You can specify a KMS key \n ID using the following formats:
\nKey ID - A unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If you use KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted \n parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric \n KMS keys with Amazon EFS file systems.
\nThe ID of the KMS key that you want to use to protect the encrypted file\n system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following\n formats:
\nKey ID - A unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If you use KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted \n parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric \n KMS keys with Amazon EFS file systems.
\nCreates a replication configuration that replicates an existing EFS file \n system to a new, read-only file system. For more information, see \n Amazon EFS replication. \n The replication configuration specifies the following:
\n\n Source file system - an existing\n EFS file system that you want replicated. The source file system cannot be a destination file system \n in an existing replication configuration.
\n\n Destination file system configuration\n - the configuration of the destination file system to which the source file system \n will be replicated. There can only be one destination file system in a replication\n configuration.
\n\n Amazon Web Services Region - The Amazon Web Services Region in which the destination \n file system is created. EFS Replication is available in all Amazon Web Services Region that Amazon EFS is available in, except the following regions: \n Asia Pacific (Hong Kong) Europe (Milan), Middle East (Bahrain), Africa (Cape Town), and Asia Pacific (Jakarta).
\n\n Availability zone - If you want the destination file system to use \n One Zone availability and durability, you must specify the Availability Zone to create the file system in. \n For more information about EFS storage classes, see \n Amazon EFS storage classes in the Amazon EFS User Guide.
\n\n Encryption - All destination file systems are\n created with encryption at rest enabled. You can specify the \n KMS key that is used to encrypt the destination file system. \n Your service-managed KMS key for Amazon EFS is used if you don't specify a KMS key. \n You cannot change this after the file system is created.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's \n performance mode will match that of the source file system, unless the destination file \n system uses One Zone storage. In that case, the General Purpose \n performance mode is used. The Performance mode cannot be changed.
\n\n Throughput mode - The destination file system \n use the Bursting throughput mode by default. You can modify the throughput mode once the file system \n is created.
\nThe following properties are turned off by default:
\n\n Lifecycle management - EFS lifecycle \n management and intelligent tiering are not enabled on the destination file system. You can enable \n EFS lifecycle management and intelligent tiering after the destination file system is created.
\n\n Automatic backups - Automatic daily backups \n not enabled on the destination file system. You can change this setting after the file system is created.
\nFor more information, see Amazon EFS replication.
", + "smithy.api#documentation": "Creates a replication configuration that replicates an existing EFS file system to a new,\n read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:
\n\n Source file system - An existing EFS file system that you\n want replicated. The source file system cannot be a destination file system in an existing\n replication configuration.
\n\n Destination file system configuration - The configuration of\n the destination file system to which the source file system will be replicated. There can\n only be one destination file system in a replication configuration. The destination file\n system configuration consists of the following properties:
\n\n Amazon Web Services Region - The Amazon Web Services Region in\n which the destination file system is created. Amazon EFS replication is\n available in all Amazon Web Services Regions that Amazon EFS is available in,\n except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe\n (Milan), and Middle East (Bahrain).
\n\n Availability Zone - If you want the destination file system\n to use EFS One Zone availability and durability, you must specify the Availability\n Zone to create the file system in. For more information about EFS storage classes, see\n \n Amazon EFS storage classes in the Amazon EFS User\n Guide.
\n\n Encryption - All destination file systems are created with\n encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't\n specify a KMS key, your service-managed KMS key for\n Amazon EFS is used.
\nAfter the file system is created, you cannot change the KMS key.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's performance\n mode matches that of the source file system, unless the destination file system uses EFS\n One Zone storage. In that case, the General Purpose performance mode is used. The\n performance mode cannot be changed.
\n\n Throughput mode - The destination file system uses the\n Bursting Throughput mode by default. After the file system is created, you can modify the\n throughput mode.
\nThe following properties are turned off by default:
\n\n Lifecycle management - EFS lifecycle management and EFS\n Intelligent-Tiering are not enabled on the destination file system. After the destination\n file system is created, you can enable EFS lifecycle management and EFS\n Intelligent-Tiering.
\n\n Automatic backups - Automatic daily backups not enabled on\n the destination file system. After the file system is created, you can change this\n setting.
\nFor more information, see Amazon EFS replication in the\n Amazon EFS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -646,7 +649,7 @@ "smithy.api#deprecated": { "message": "Use TagResource." }, - "smithy.api#documentation": "DEPRECATED - CreateTags is deprecated and not maintained. Please use the \n API action to create tags for EFS resources.
\nCreates or overwrites tags associated with a file system. Each tag is a key-value pair. If\n a tag key specified in the request already exists on the file system, this operation\n overwrites its value with the value provided in the request. If you add the Name
\n tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
This operation requires permission for the elasticfilesystem:CreateTags
\n action.
DEPRECATED - CreateTags
is deprecated and not maintained. To create tags for EFS\n resources, use the API action.
Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If\n a tag key specified in the request already exists on the file system, this operation\n overwrites its value with the value provided in the request. If you add the Name
\n tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
This operation requires permission for the elasticfilesystem:CreateTags
\n action.
Deletes a file system, permanently severing access to its contents. Upon return, the\n file system no longer exists and you can't access any contents of the deleted file\n system.
\nYou can't delete a file system that is in use. That is, if the file system has\n any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
\n\nThe DeleteFileSystem
call returns while the file system state is still\n deleting
. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound
\n error.
This operation requires permissions for the\n elasticfilesystem:DeleteFileSystem
action.
Deletes a file system, permanently severing access to its contents. Upon return, the\n file system no longer exists and you can't access any contents of the deleted file\n system.
\nYou need to manually delete mount targets attached to a file system before you can delete\n an EFS file system. This step is performed for you when you use the Amazon Web Services console \n to delete a file system.
\nYou cannot delete a file system that is part of an EFS Replication configuration. \n You need to delete the replication configuration first.
\nYou can't delete a file system that is in use. That is, if the file system has\n any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
\n\nThe DeleteFileSystem
call returns while the file system state is still\n deleting
. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound
\n error.
This operation requires permissions for the\n elasticfilesystem:DeleteFileSystem
action.
Deletes an existing replication configuration. To delete a replication \n configuration, you must make the request from the Amazon Web Services Region \n in which the destination file system is located. Deleting a replication \n configuration ends the replication process. You can write to the destination file \n system once it's status becomes Writeable
.
Deletes an existing replication configuration. To delete a replication configuration, you\n must make the request from the Amazon Web Services Region in which the destination file system\n is located. Deleting a replication configuration ends the replication process. After a\n replication configuration is deleted, the destination file system is no longer read-only. You\n can write to the destination file system after its status becomes\n Writeable
.
DEPRECATED - DeleteTags is deprecated and not maintained. Please use the \n API action to remove tags from EFS resources.
\nDeletes the specified tags from a file system. If the DeleteTags
request\n includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an\n error. For more information about tags and related restrictions, see Tag restrictions in the\n Billing and Cost Management User Guide.
This operation requires permissions for the elasticfilesystem:DeleteTags
\n action.
DEPRECATED - DeleteTags
is deprecated and not maintained. To remove tags from EFS\n resources, use the API action.
Deletes the specified tags from a file system. If the DeleteTags
request\n includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an\n error. For more information about tags and related restrictions, see Tag restrictions in the\n Billing and Cost Management User Guide.
This operation requires permissions for the elasticfilesystem:DeleteTags
\n action.
Returns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. EFS lifecycle management uses the LifecycleConfiguration
object\n to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system\n without a LifecycleConfiguration
object, the call returns an empty array in the\n response.
When EFS Intelligent Tiering is enabled, TransitionToPrimaryStorageClass
has a value of AFTER_1_ACCESS
.
This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration
operation.
Returns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. EFS lifecycle management uses the LifecycleConfiguration
object\n to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system\n without a LifecycleConfiguration
object, the call returns an empty array in the\n response.
When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass
has\n a value of AFTER_1_ACCESS
.
This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration
operation.
Retrieves the replication configurations for either a specific file system, or all configurations for the \n Amazon Web Services account in an Amazon Web Services Region if a file system is not specified.
", + "smithy.api#documentation": "Retrieves the replication configuration for a specific file system. If a file system is\n not specified, all of the replication configurations for the Amazon Web Services account in an\n Amazon Web Services Region are retrieved.
", "smithy.api#http": { "method": "GET", "uri": "/2015-02-01/file-systems/replication-configurations", @@ -1562,21 +1565,21 @@ "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "You can retrieve replication configurations for a specific file system by providing a file system ID.
", + "smithy.api#documentation": "You can retrieve the replication configuration for a specific file system by providing its\n file system ID.
", "smithy.api#httpQuery": "FileSystemId" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { - "smithy.api#documentation": "\n NextToken
is present if the response is paginated. You can use \n NextMarker
in a subsequent request to fetch the next page of output.
\n NextToken
is present if the response is paginated. You can use\n NextToken
in a subsequent request to fetch the next page of\n output.
(Optional) You can optionally specify the MaxItems
parameter \n to limit the number of objects returned in a response. The default value is 100.
(Optional) To limit the number of objects returned in a response, you can specify the\n MaxItems
parameter. The default value is 100.
The collection of replication configurations returned.
" + "smithy.api#documentation": "The collection of replication configurations that is returned.
" } }, "NextToken": { @@ -1622,7 +1625,7 @@ "smithy.api#deprecated": { "message": "Use ListTagsForResource." }, - "smithy.api#documentation": "DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the \n API action to remove tags from EFS resources.
\nReturns the tags associated with a file system. The order of tags returned in the\n response of one DescribeTags
call and the order of tags returned across the\n responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the\n elasticfilesystem:DescribeTags
action.
DEPRECATED - The DescribeTags
action is deprecated and not maintained. To view\n tags associated with EFS resources, use the ListTagsForResource
API\n action.
Returns the tags associated with a file system. The order of tags returned in the\n response of one DescribeTags
call and the order of tags returned across the\n responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the\n elasticfilesystem:DescribeTags
action.
Describes the status of the destination Amazon EFS file system.
", + "smithy.api#documentation": "Describes the status of the destination Amazon EFS file system. If the status is\n ERROR
, the destination file system in the replication configuration is in a\n failed state and is unrecoverable. To access the file system data, restore a backup of the\n failed file system to a new file system.
The time when the most recent sync successfully completed on the destination file system. \n Any changes to data on the source file system that occurred prior to this time were successfully \n replicated to the destination file system. Any changes that occurred after this time might not be \n fully replicated.
" + "smithy.api#documentation": "The time when the most recent sync was successfully completed on the destination file\n system. Any changes to data on the source file system that occurred before this time have been\n successfully replicated to the destination file system. Any changes that occurred after this\n time might not be fully replicated.
" } } }, @@ -1733,19 +1736,19 @@ "Region": { "target": "com.amazonaws.efs#RegionName", "traits": { - "smithy.api#documentation": "To create a file system that uses regional storage, specify the Amazon Web Services Region\n in which to create the destination file system.
" + "smithy.api#documentation": "To create a file system that uses Regional storage, specify the Amazon Web Services Region\n in which to create the destination file system.
" } }, "AvailabilityZoneName": { "target": "com.amazonaws.efs#AvailabilityZoneName", "traits": { - "smithy.api#documentation": "To create a file system that uses One Zone storage, specify the name of the \n Availability Zone in which to create the destination file system.
" + "smithy.api#documentation": "To create a file system that uses EFS One Zone storage, specify the name of the\n Availability Zone in which to create the destination file system.
" } }, "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { - "smithy.api#documentation": "Specifies the KMS key you want to use to encrypt the destination file system. If you do not \n specify a KMS key, EFS uses your default KMS key for Amazon EFS, \n /aws/elasticfilesystem
. This ID can be in one of the following\n formats:
Key ID - A unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
Specifies the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem
. This ID can be in one of the following formats:
Key ID - The unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - The Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - The ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
Returned if there's not enough capacity to provision additional throughput. This value\n might be returned when you try to create a file system in provisioned throughput mode,\n when you attempt to increase the provisioned throughput of an existing file system, or\n when you attempt to change an existing file system from bursting to provisioned\n throughput mode. Try again later.
", + "smithy.api#documentation": "Returned if there's not enough capacity to provision additional throughput. This value\n might be returned when you try to create a file system in provisioned throughput mode,\n when you attempt to increase the provisioned throughput of an existing file system, or\n when you attempt to change an existing file system from Bursting Throughput to\n Provisioned Throughput mode. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -2170,7 +2173,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if the FileSystemPolicy
is is malformed or contains an error such as an invalid\n parameter value or a missing required parameter. Returned in the case of a policy lockout safety check error.
Returned if the FileSystemPolicy
is malformed or contains an error such\n as a parameter value that is not valid or a missing required parameter. Returned in the\n case of a policy lockout safety check error.
Describes a policy used by EFS lifecycle management and EFS intelligent tiering that specifies when to transition \n files into and out of the file system's Infrequent Access (IA) storage class. For more information, see \n EFS Intelligent‐Tiering and EFS Lifecycle Management.
\nWhen using the put-lifecycle-configuration
CLI command or the PutLifecycleConfiguration
API action, \n Amazon EFS requires that each LifecyclePolicy
\n object have only a single transition. This means that in a request body, LifecyclePolicies
needs to be structured as\n an array of LifecyclePolicy
objects, one object for each transition, TransitionToIA
, \n TransitionToPrimaryStorageClass
. For more information, see the request examples in PutLifecycleConfiguration.
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that\n specifies when to transition files into and out of the file system's Infrequent Access (IA)\n storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle\n Management.
\nWhen using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each transition,\n TransitionToIA
, TransitionToPrimaryStorageClass
. For more\n information, see the request examples in PutLifecycleConfiguration.
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use\n with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic,\n growing and shrinking automatically as you add and remove files, so your applications have the\n storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.
", + "smithy.api#documentation": "Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for\n use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and\n remove files, so that your applications have the storage they need, when they need it. For\n more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.
", "smithy.api#title": "Amazon Elastic File System" }, "version": "2015-02-01", @@ -2718,7 +2721,7 @@ } }, "traits": { - "smithy.api#documentation": "The calling account has reached the limit for elastic network interfaces for the\n specific Amazon Web Services Region. The client should try to delete some elastic network interfaces or\n get the account limit raised. For more information, see Amazon VPC Limits\n in the Amazon VPC User Guide (see the Network interfaces per VPC\n entry in the table).
", + "smithy.api#documentation": "The calling account has reached the limit for elastic network interfaces for the\n specific Amazon Web Services Region. Either delete some network interfaces or request\n that the account quota be raised. For more information, see Amazon VPC Quotas\n in the Amazon VPC User Guide (see the Network\n interfaces per Region entry in the Network\n interfaces table).
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2877,7 +2880,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to set the account preference in the current Amazon Web Services Region \n to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for \n new EFS file system and mount target resources. All existing resource IDs are not affected \n by any changes you make. You can set the ID preference during the\n opt-in period as EFS transitions to long resource IDs. For more information, \n see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. \n Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.
\nUse this operation to set the account preference in the current Amazon Web Services Region \n to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for \n new EFS file system and mount target resources. All existing resource IDs are not affected \n by any changes you make. You can set the ID preference during the\n opt-in period as EFS transitions to long resource IDs. For more information, \n see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference\n to use the short 8 character format resource ID. Contact Amazon Web Services support if you\n receive an error and must use short IDs for file system and mount target resources.
\nSpecifies the EFS resource ID preference to set for the user's Amazon Web Services account, \n in the current Amazon Web Services Region, either LONG_ID
(17 characters), or \n SHORT_ID
(8 characters).
Starting in October, 2021, you will receive an error when setting the account \n preference to SHORT_ID
. Contact Amazon Web Services support if you receive an \n error and need to use short IDs for file system and mount target resources.
Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, \n in the current Amazon Web Services Region, either LONG_ID
(17 characters), or \n SHORT_ID
(8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to\n SHORT_ID
. Contact Amazon Web Services support if you receive an error and must\n use short IDs for file system and mount target resources.
(Optional) A flag to indicate whether to bypass the FileSystemPolicy
lockout safety check. The policy lockout safety check \n determines whether the policy in the request will prevent the principal making the request will be locked out from making future PutFileSystemPolicy
requests on the file system.\n Set BypassPolicyLockoutSafetyCheck
to True
only when you intend to prevent \n the principal that is making the request from making a subsequent PutFileSystemPolicy
request on the file system. \n The default value is False.\n
(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy
lockout safety check. The lockout safety check \n determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy
requests on this file system.\n Set BypassPolicyLockoutSafetyCheck
to True
only when you intend to prevent \n the IAM principal that is making the request from making subsequent PutFileSystemPolicy
requests on this file system. \n The default value is False
.\n
Enables lifecycle management by creating a new LifecycleConfiguration
\n object. A LifecycleConfiguration
object defines when files in an Amazon EFS file\n system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class.\n To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass
to AFTER_1_ACCESS
.\n For more information, see EFS Lifecycle Management.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a\n LifecycleConfiguration
object already exists for the specified file system, a\n PutLifecycleConfiguration
call modifies the existing configuration. A\n PutLifecycleConfiguration
call with an empty LifecyclePolicies
\n array in the request body deletes any existing LifecycleConfiguration
and\n turns off lifecycle management for the file system.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
\nA LifecyclePolicies
array of LifecyclePolicy
objects that\n define when files are moved to the IA storage class. Amazon EFS requires that each LifecyclePolicy
\n object have only have a single transition, so the LifecyclePolicies
array needs to be structured with separate \n LifecyclePolicy
objects. See the example requests in the following section for more information.
This operation requires permissions for the\n elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted\n file system.
Use this action to manage EFS lifecycle management and intelligent tiering. A \n LifecycleConfiguration
consists of one or more LifecyclePolicy
objects that \n define the following:
\n EFS Lifecycle management - When Amazon EFS \n automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class.
\nTo enable EFS Lifecycle management, set the value of TransitionToIA
to one of the available options.
\n EFS Intelligent tiering - When Amazon EFS \n automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard.
\nTo enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass
to AFTER_1_ACCESS
.
For more information, see EFS Lifecycle Management.
\nEach Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a\n LifecycleConfiguration
object already exists for the specified file system, a\n PutLifecycleConfiguration
call modifies the existing configuration. A\n PutLifecycleConfiguration
call with an empty LifecyclePolicies
\n array in the request body deletes any existing LifecycleConfiguration
and\n turns off lifecycle management and intelligent tiering for the file system.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying lifecycle management \n and intelligent tiering.
\nA LifecyclePolicies
array of LifecyclePolicy
objects that\n define when files are moved into IA storage, and when they are moved back to Standard storage.
Amazon EFS requires that each LifecyclePolicy
\n object have only have a single transition, so the LifecyclePolicies
array needs to be structured with separate \n LifecyclePolicy
objects. See the example requests in the following section for more information.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.
An array of LifecyclePolicy
objects that define the file system's\n LifecycleConfiguration
object. A LifecycleConfiguration
object\n informs EFS lifecycle management and intelligent tiering of the following:
When to move files in the file system from primary storage to the IA storage class.
\nWhen to move files that are in IA storage to primary storage.
\nWhen using the put-lifecycle-configuration
CLI command or the PutLifecycleConfiguration
API action, \n Amazon EFS requires that each LifecyclePolicy
\n object have only a single transition. This means that in a request body, LifecyclePolicies
needs to be structured as\n an array of LifecyclePolicy
objects, one object for each transition, TransitionToIA
, TransitionToPrimaryStorageClass
. \n See the example requests in the following section for more information.
An array of LifecyclePolicy
objects that define the file system's\n LifecycleConfiguration
object. A LifecycleConfiguration
object\n informs EFS lifecycle management and EFS Intelligent-Tiering of the following:
When to move files in the file system from primary storage to the IA storage class.
\nWhen to move files that are in IA storage to primary storage.
\nWhen using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each transition,\n TransitionToIA
, TransitionToPrimaryStorageClass
. See the example\n requests in the following section for more information.
The ARN of the current source file system in the replication configuration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the current source file system in the replication\n configuration.
", "smithy.api#required": {} } }, @@ -3121,7 +3124,7 @@ "Destinations": { "target": "com.amazonaws.efs#Destinations", "traits": { - "smithy.api#documentation": "Array of destination objects. Only one destination object is supported.
", + "smithy.api#documentation": "An array of destination objects. Only one destination object is supported.
", "smithy.api#required": {} } } @@ -3147,7 +3150,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if the specified file system did not have a replication configuration.
", + "smithy.api#documentation": "Returned if the specified file system does not have a replication\n configuration.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3321,7 +3324,7 @@ } }, "traits": { - "smithy.api#documentation": "Returned if one of the specified security groups doesn't exist in the subnet's\n VPC.
", + "smithy.api#documentation": "Returned if one of the specified security groups doesn't exist in the subnet's\n virtual private cloud (VPC).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3498,6 +3501,22 @@ "target": "com.amazonaws.efs#Tag" } }, + "com.amazonaws.efs#ThrottlingException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.efs#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Returned when the CreateAccessPoint
API action is called too quickly and \n the number of Access Points in the account is nearing the limit of 120.
Returned if you don’t wait at least 24 hours before changing the throughput mode, or\n decreasing the Provisioned Throughput value.
", + "smithy.api#documentation": "Returned if you don’t wait at least 24 hours before either changing the throughput mode, or\n decreasing the Provisioned Throughput value.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 071d7dbb54e..95d1d84a198 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1607,14 +1607,14 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system. \n MULTI_AZ_1
is the supported ONTAP deployment type.
Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system.
\n\n MULTI_AZ_1
- (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1
- A file system configured for Single-AZ\n redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.
", "smithy.api#required": {} } }, "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "Specifies the IP address range in which the endpoints to access your file system\n will be created. By default, Amazon FSx selects an unused IP address range for you\n from the 198.19.* range.
\nThe Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.
\n(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default, Amazon FSx selects an unused IP address\n range for you from the 198.19.* range.
\nThe Endpoint IP address range you select for your file system must exist outside\n the VPC's CIDR range and must be at least /30 or larger.
\nRequired when DeploymentType
is set to MULTI_AZ_1
. This specifies the subnet \n in which you want the preferred file server to be located.
Required when DeploymentType
is set to MULTI_AZ_1
. This\n specifies the subnet in which you want the preferred file server to be located.
Specifies the virtual private cloud (VPC) route tables in which your file system's\n endpoints will be created. You should specify all VPC route tables associated with the\n subnets in which your clients are located. By default, Amazon FSx selects your VPC's\n default route table.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.
" } }, "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "Sets the throughput capacity for the file system that you're creating. \n Valid values are 128, 256, 512, 1024, and 2048 MBps.
", + "smithy.api#documentation": "Sets the throughput capacity for the file system that you're creating. Valid values\n are 128, 256, 512, 1024, and 2048 MBps.
", "smithy.api#required": {} } }, @@ -1653,7 +1653,7 @@ } }, "traits": { - "smithy.api#documentation": "The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
" + "smithy.api#documentation": "The ONTAP configuration properties of the FSx for ONTAP file system that you\n are creating.
" } }, "com.amazonaws.fsx#CreateFileSystemOpenZFSConfiguration": { @@ -5460,6 +5460,10 @@ { "value": "MULTI_AZ_1", "name": "MULTI_AZ_1" + }, + { + "value": "SINGLE_AZ_1", + "name": "SINGLE_AZ_1" } ] } @@ -5488,13 +5492,13 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "The ONTAP file system deployment type.
" + "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type in use in the file\n system.
\n\n MULTI_AZ_1
- (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1
- A file system configured for Single-AZ\n redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.
" } }, "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "The IP address range in which the endpoints to access your file system\n are created.
\nThe Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.
\n(Multi-AZ only) The IP address range in which the endpoints to access your file system\n are created.
\nThe Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.
\nThe VPC route tables in which your file system's endpoints are\n created.
" + "smithy.api#documentation": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are\n created.
" } }, "ThroughputCapacity": { diff --git a/codegen/sdk/aws-models/iottwinmaker.json b/codegen/sdk/aws-models/iottwinmaker.json index ded96f68bef..12a064c404b 100644 --- a/codegen/sdk/aws-models/iottwinmaker.json +++ b/codegen/sdk/aws-models/iottwinmaker.json @@ -15,7 +15,7 @@ "name": "iottwinmaker" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "\n TwinMaker is in public preview and is subject to change.\n
\nIoT TwinMaker is a service that enables you to build operational digital twins of\n physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors,\n cameras, and enterprise applications so you can create data visualizations to monitor your\n physical factory, building, or industrial plant. You can use this real-world data to\n monitor operations and diagnose and repair errors.
", + "smithy.api#documentation": "IoT TwinMaker is a service that enables you to build operational digital twins of\n physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors,\n cameras, and enterprise applications so you can create data visualizations to monitor your\n physical factory, building, or industrial plant. You can use this real-world data to\n monitor operations and diagnose and repair errors.
", "smithy.api#title": "AWS IoT TwinMaker" }, "version": "2021-11-29", @@ -518,7 +518,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a component type.
\n\n TwinMaker is in public preview and is subject to change.\n
\nCreates a component type.
", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -949,7 +949,7 @@ "isNative": { "target": "com.amazonaws.iottwinmaker#Boolean", "traits": { - "smithy.api#documentation": "A Boolean value that specifies whether the data connector is native to TwinMaker.
" + "smithy.api#documentation": "A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
" } } }, @@ -2092,15 +2092,19 @@ "startDateTime": { "target": "com.amazonaws.iottwinmaker#Timestamp", "traits": { - "smithy.api#documentation": "The date and time of the earliest property value to return.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This field is deprecated and will throw an error in the future. Use startTime instead." + }, + "smithy.api#documentation": "The date and time of the earliest property value to return.
" } }, "endDateTime": { "target": "com.amazonaws.iottwinmaker#Timestamp", "traits": { - "smithy.api#documentation": "The date and time of the latest property value to return.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This field is deprecated and will throw an error in the future. Use endTime instead." + }, + "smithy.api#documentation": "The date and time of the latest property value to return.
" } }, "interpolation": { @@ -2126,6 +2130,12 @@ "traits": { "smithy.api#documentation": "The time direction to use in the result order.
" } + }, + "startTime": { + "target": "com.amazonaws.iottwinmaker#Time" + }, + "endTime": { + "target": "com.amazonaws.iottwinmaker#Time" } } }, @@ -2704,6 +2714,12 @@ "traits": { "smithy.api#documentation": "The ID of the component type in the entities in the list.
" } + }, + "externalId": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The external-Id property of a component. The external-Id property is the primary key of an external storage system.
" + } } }, "traits": { @@ -3371,6 +3387,10 @@ { "value": "DELETE", "name": "DELETE" + }, + { + "value": "CREATE", + "name": "CREATE" } ] } @@ -3381,8 +3401,10 @@ "timestamp": { "target": "com.amazonaws.iottwinmaker#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp of a value for a time series property.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This field is deprecated and will throw an error in the future. Use time instead." + }, + "smithy.api#documentation": "The timestamp of a value for a time series property.
" } }, "value": { @@ -3391,6 +3413,9 @@ "smithy.api#documentation": "An object that specifies a value for a time series property.
", "smithy.api#required": {} } + }, + "time": { + "target": "com.amazonaws.iottwinmaker#Time" } }, "traits": { @@ -3527,7 +3552,14 @@ } }, "com.amazonaws.iottwinmaker#S3Location": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+$)" + } }, "com.amazonaws.iottwinmaker#S3Url": { "type": "string", @@ -3827,8 +3859,21 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.iottwinmaker#Time": { + "type": "string", + "traits": { + "smithy.api#documentation": "Timestamp represented in ISO 8601 format", + "smithy.api#length": { + "min": 20, + "max": 35 + } + } + }, "com.amazonaws.iottwinmaker#Timestamp": { - "type": "timestamp" + "type": "timestamp", + "traits": { + "smithy.api#documentation": "supports epoch seconds value" + } }, "com.amazonaws.iottwinmaker#TooManyTagsException": { "type": "structure", @@ -4357,11 +4402,7 @@ "com.amazonaws.iottwinmaker#Value": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z_\\-0-9]+$" + "smithy.api#pattern": ".*" } }, "com.amazonaws.iottwinmaker#Values": { diff --git a/codegen/sdk/aws-models/mediaconvert.json b/codegen/sdk/aws-models/mediaconvert.json index 1262af7ede2..f343051a78b 100644 --- a/codegen/sdk/aws-models/mediaconvert.json +++ b/codegen/sdk/aws-models/mediaconvert.json @@ -3424,6 +3424,22 @@ ] } }, + "com.amazonaws.mediaconvert#CmfcKlvMetadata": { + "type": "string", + "traits": { + "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#enum": [ + { + "value": "PASSTHROUGH", + "name": "PASSTHROUGH" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.mediaconvert#CmfcScte35Esam": { "type": "string", "traits": { @@ -3501,6 +3517,13 @@ "smithy.api#jsonName": "iFrameOnlyManifest" } }, + "KlvMetadata": { + "target": "com.amazonaws.mediaconvert#CmfcKlvMetadata", + "traits": { + "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#jsonName": "klvMetadata" + } + }, "Scte35Esam": { "target": "com.amazonaws.mediaconvert#CmfcScte35Esam", "traits": { @@ -12826,6 +12849,22 @@ ] } }, + "com.amazonaws.mediaconvert#M2tsKlvMetadata": { + "type": "string", + "traits": { + "smithy.api#documentation": "Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#enum": [ + { + "value": "PASSTHROUGH", + "name": "PASSTHROUGH" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.mediaconvert#M2tsNielsenId3": { "type": "string", "traits": { @@ -13075,6 +13114,13 @@ "smithy.api#jsonName": "fragmentTime" } }, + "KlvMetadata": { + "target": "com.amazonaws.mediaconvert#M2tsKlvMetadata", + "traits": { + "smithy.api#documentation": "Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#jsonName": "klvMetadata" + } + }, "MaxPcrInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max500", "traits": { @@ -14036,6 +14082,22 @@ ] } }, + "com.amazonaws.mediaconvert#MpdKlvMetadata": { + "type": "string", + "traits": { + "smithy.api#documentation": "Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "PASSTHROUGH", + "name": "PASSTHROUGH" + } + ] + } + }, "com.amazonaws.mediaconvert#MpdScte35Esam": { "type": "string", "traits": { @@ -14092,6 +14154,13 @@ "smithy.api#jsonName": "captionContainerType" } }, + "KlvMetadata": { + "target": "com.amazonaws.mediaconvert#MpdKlvMetadata", + "traits": { + "smithy.api#documentation": "Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#jsonName": "klvMetadata" + } + }, "Scte35Esam": { "target": "com.amazonaws.mediaconvert#MpdScte35Esam", "traits": { @@ -18889,7 +18958,7 @@ "StylePassthrough": { "target": "com.amazonaws.mediaconvert#WebvttStylePassthrough", "traits": { - "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict (STRICT). MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank.", "smithy.api#jsonName": "stylePassthrough" } } @@ -18930,7 +18999,7 @@ "com.amazonaws.mediaconvert#WebvttStylePassthrough": { "type": "string", "traits": { - "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", + "smithy.api#documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict (STRICT). MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank.", "smithy.api#enum": [ { "value": "ENABLED", @@ -18939,6 +19008,10 @@ { "value": "DISABLED", "name": "DISABLED" + }, + { + "value": "STRICT", + "name": "STRICT" } ] } diff --git a/codegen/sdk/aws-models/mediapackage-vod.json b/codegen/sdk/aws-models/mediapackage-vod.json index 2a71cf74041..d0a268f3e7d 100644 --- a/codegen/sdk/aws-models/mediapackage-vod.json +++ b/codegen/sdk/aws-models/mediapackage-vod.json @@ -761,6 +761,13 @@ "smithy.api#jsonName": "profile" } }, + "ScteMarkersSource": { + "target": "com.amazonaws.mediapackagevod#ScteMarkersSource", + "traits": { + "smithy.api#documentation": "The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.", + "smithy.api#jsonName": "scteMarkersSource" + } + }, "StreamSelection": { "target": "com.amazonaws.mediapackagevod#StreamSelection", "traits": { @@ -1838,6 +1845,21 @@ }, "com.amazonaws.mediapackagevod#MediaPackageVod": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaPackage Vod", + "arnNamespace": "mediapackage-vod", + "cloudFormationName": "MediaPackageVod", + "cloudTrailEventSource": "mediapackagevod.amazonaws.com", + "endpointPrefix": "mediapackage-vod" + }, + "aws.auth#sigv4": { + "name": "mediapackage-vod" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Elemental MediaPackage VOD", + "smithy.api#title": "AWS Elemental MediaPackage VOD" + }, "version": "2018-11-07", "operations": [ { @@ -1891,22 +1913,7 @@ { "target": "com.amazonaws.mediapackagevod#UpdatePackagingGroup" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaPackage Vod", - "arnNamespace": "mediapackage-vod", - "cloudFormationName": "MediaPackageVod", - "cloudTrailEventSource": "mediapackagevod.amazonaws.com", - "endpointPrefix": "mediapackage-vod" - }, - "aws.auth#sigv4": { - "name": "mediapackage-vod" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Elemental MediaPackage VOD", - "smithy.api#title": "AWS Elemental MediaPackage VOD" - } + ] }, "com.amazonaws.mediapackagevod#MssEncryption": { "type": "structure", @@ -2110,6 +2117,21 @@ ] } }, + "com.amazonaws.mediapackagevod#ScteMarkersSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SEGMENTS", + "name": "SEGMENTS" + }, + { + "value": "MANIFEST", + "name": "MANIFEST" + } + ] + } + }, "com.amazonaws.mediapackagevod#SegmentTemplateFormat": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/pi.json b/codegen/sdk/aws-models/pi.json index b54a70e7d47..c772fc74247 100644 --- a/codegen/sdk/aws-models/pi.json +++ b/codegen/sdk/aws-models/pi.json @@ -112,79 +112,79 @@ "ServiceType": { "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights will return metrics. The only valid value for \n ServiceType is RDS
.\n
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
\n\n RDS
\n
\n DOCDB
\n
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. \n For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.\n
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. \n For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.\n
The date and time specifying the beginning of the requested time series data. You must specify a\n StartTime
within the past 7 days. The value specified is inclusive, \n which means that data points equal to or greater than StartTime
are returned.\n
The value for StartTime
must be earlier than the value for EndTime
.\n
The date and time specifying the beginning of the requested time series data. You must specify a\n StartTime
within the past 7 days. The value specified is inclusive, \n which means that data points equal to or greater than StartTime
are returned.\n
The value for StartTime
must be earlier than the value for EndTime
.\n
The date and time specifying the end of the requested time series data. The value specified is\n exclusive, which means that data points less than (but not equal to) EndTime
are\n returned.
The value for EndTime
must be later than the value for\n StartTime
.
The date and time specifying the end of the requested time series data. The value specified is\n exclusive, which means that data points less than (but not equal to) EndTime
are\n returned.
The value for EndTime
must be later than the value for StartTime
.
The name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- a scaled representation of the number of active sessions for the database engine.\n
\n db.sampledload.avg
- the raw number of active sessions for the database engine.\n
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
\n and db.sampledload.avg
are the same value. If the number of active sessions is greater than \n the internal threshold, Performance Insights samples the active sessions, with db.load.avg
\n showing the scaled values, db.sampledload.avg
showing the raw values, and \n db.sampledload.avg
less than db.load.avg
. For most use cases, you can \n query db.load.avg
only.\n
The name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- A scaled representation of the number of active sessions for the database engine.
\n db.sampledload.avg
- The raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
\n and db.sampledload.avg
are the same value. If the number of active sessions is greater than \n the internal threshold, Performance Insights samples the active sessions, with db.load.avg
\n showing the scaled values, db.sampledload.avg
showing the raw values, and \n db.sampledload.avg
less than db.load.avg
. For most use cases, you can \n query db.load.avg
only.\n
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as \n one second, or as long as one day (86400 seconds). Valid values are:\n
\n\n 1
(one second)
\n 60
(one minute)
\n 300
(five minutes)
\n 3600
(one hour)
\n 86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a \n goal of returning roughly 100-200 data points in the response.\n
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as \n one second, or as long as one day (86400 seconds). Valid values are:\n
\n\n 1
(one second)
\n 60
(one minute)
\n 300
(five minutes)
\n 3600
(one hour)
\n 86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a \n goal of returning roughly 100-200 data points in the response.\n
A specification for how to aggregate the data points from a query result. You must specify \n a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide \n the names of specific dimensions within this group. You can also request that Performance Insights return \n a limited number of values for a dimension.\n
", + "smithy.api#documentation": "A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all\n dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return\n a limited number of values for a dimension.
", "smithy.api#required": {} } }, "AdditionalMetrics": { "target": "com.amazonaws.pi#AdditionalMetricsList", "traits": { - "smithy.api#documentation": "Additional metrics for the top N
dimension keys. \n If the specified dimension group in the GroupBy
parameter is db.sql_tokenized
, you can \n specify per-SQL metrics to get the values for the top N
SQL digests. The response syntax is\n \"AdditionalMetrics\" : { \"string\" : \"string\" }
.\n
Additional metrics for the top N
dimension keys. If the specified dimension group in the GroupBy
parameter is\n db.sql_tokenized
, you can specify per-SQL metrics to get the values for the top N
SQL digests. The response\n syntax is as follows: \"AdditionalMetrics\" : { \"string\" : \"string\" }
.
For each dimension specified in GroupBy
, specify a secondary dimension \n to further subdivide the partition keys in the response.\n
For each dimension specified in GroupBy
, specify a secondary dimension \n to further subdivide the partition keys in the response.\n
One or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy
or\n Partition
parameters.
A single filter for any other dimension in this dimension group.
\nOne or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy
or\n Partition
parameters.
A single filter for any other dimension in this dimension group.
\nThe maximum number of items to return in the response. If more items exist than the \n specified MaxRecords
value, a pagination token is included in the response \n so that the remaining results can be retrieved.\n
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a\n pagination token is included in the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords
.\n
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond\n the token, up to the value specified by MaxRecords
.
The start time for the returned dimension keys, after alignment to a granular boundary (as \n specified by PeriodInSeconds
). AlignedStartTime
will be less than or \n equal to the value of the user-specified StartTime
.\n
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
).\n AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned dimension keys, after alignment to a granular boundary (as \n specified by PeriodInSeconds
). AlignedEndTime
will be greater than \n or equal to the value of the user-specified Endtime
.\n
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
).\n AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
If PartitionBy
was present in the request, PartitionKeys
contains \n the breakdown of dimension keys by the specified partitions.\n
If PartitionBy
was present in the request, PartitionKeys
contains the breakdown of dimension keys by the\n specified partitions.
A pagination token that indicates the response didn’t return all available records\n because MaxRecords
was specified in the previous request. To get the \n remaining records, specify NextToken
in a separate request with this value.\n
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the\n previous request. To get the remaining records, specify NextToken
in a separate request with this value.
The name of the dimension group. Valid values are:
\n \n\n db
- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,\n Aurora MySQL, Amazon RDS MySQL, and MariaDB)
\n db.application
- The name of the application that is connected to the database (only Aurora\n PostgreSQL and RDS PostgreSQL)
\n db.host
- The host name of the connected client (all engines)
\n db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
\n db.sql
- The SQL that is currently executing (all engines)
\n db.sql_tokenized
- The SQL digest (all engines)
\n db.wait_event
- The event for which the database backend is waiting (all engines)
\n db.wait_event_type
- The type of event for which the database backend is waiting (all engines)
\n db.user
- The user logged in to the database (all engines)
The name of the dimension group. Valid values are as follows:
\n\n db
- The name of the database to which the client is connected. The following values are permitted:
Aurora PostgreSQL
\nAmazon RDS PostgreSQL
\nAurora MySQL
\nAmazon RDS MySQL
\nAmazon RDS MariaDB
\nAmazon DocumentDB
\n\n db.application
- The name of the application that is connected to the database. The following values are\n permitted:
Aurora PostgreSQL
\nAmazon RDS PostgreSQL
\nAmazon DocumentDB
\n\n db.host
- The host name of the connected client (all engines).
\n db.query
- The query that is currently running (only Amazon DocumentDB).
\n db.query_tokenized
- The digest query (only Amazon DocumentDB).
\n db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
\n db.sql
- The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
\n db.sql_tokenized
- The SQL digest (all engines except Amazon DocumentDB).
\n db.user
- The user logged in to the database (all engines except Amazon DocumentDB).
\n db.wait_event
- The event for which the database backend is waiting (all engines except Amazon DocumentDB).
\n db.wait_event_type
- The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
\n db.wait_state
- The event for which the database backend is waiting (only Amazon DocumentDB).
A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.
\nValid values for elements in the Dimensions
array are:
\n db.application.name
- The name of the application that is connected to the database (only\n Aurora PostgreSQL and RDS PostgreSQL)
\n db.host.id
- The host ID of the connected client (all engines)
\n db.host.name
- The host name of the connected client (all engines)
\n db.name
- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS\n PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
\n db.session_type.name
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
\n db.sql.id
- The SQL ID generated by Performance Insights (all engines)
\n db.sql.db_id
- The SQL ID generated by the database (all engines)
\n db.sql.statement
- The SQL text that is being executed (all engines)
\n db.sql.tokenized_id
\n
\n db.sql_tokenized.id
- The SQL digest ID generated by Performance Insights (all engines)
\n db.sql_tokenized.db_id
- SQL digest ID generated by the database (all engines)
\n db.sql_tokenized.statement
- The SQL digest text (all engines)
\n db.user.id
- The ID of the user logged in to the database (all engines)
\n db.user.name
- The name of the user logged in to the database (all engines)
\n db.wait_event.name
- The event for which the backend is waiting (all engines)
\n db.wait_event.type
- The type of event for which the backend is waiting (all engines)
\n db.wait_event_type.name
- The name of the event type for which the backend is waiting (all\n engines)
A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.
\nValid values for elements in the Dimensions
array are:
\n db.application.name
- The name of the application that is connected to the database. Valid values are as follows:
Aurora PostgreSQL
\nAmazon RDS PostgreSQL
\nAmazon DocumentDB
\n\n db.host.id
- The host ID of the connected client (all engines).
\n db.host.name
- The host name of the connected client (all engines).
\n db.name
- The name of the database to which the client is connected. Valid values are as follows:
Aurora PostgreSQL
\nAmazon RDS PostgreSQL
\nAurora MySQL
\nAmazon RDS MySQL
\nAmazon RDS MariaDB
\nAmazon DocumentDB
\n\n db.query.id
- The query ID generated by Performance Insights (only Amazon DocumentDB).
\n db.query.db_id
- The query ID generated by the database (only Amazon DocumentDB).
\n db.query.statement
- The text of the query that is being run (only Amazon DocumentDB).
\n db.query.tokenized_id
\n
\n db.query.tokenized.id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
\n db.query.tokenized.db_id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
\n db.query.tokenized.statement
- The text of the query digest (only Amazon DocumentDB).
\n db.session_type.name
- The type of the current session (only Amazon DocumentDB).
\n db.sql.id
- The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
\n db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with\n pi-
(all engines except Amazon DocumentDB).
\n db.sql.statement
- The full text of the SQL statement that is running, as in SELECT * FROM employees
\n (all engines except Amazon DocumentDB)
\n db.sql.tokenized_id
\n
\n db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console,\n db.sql_tokenized.id
is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot\n database issues.
\n db.sql_tokenized.db_id
- Either the native database ID used to refer to the SQL statement, or a synthetic ID such as\n pi-2372568224
that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).
\n db.sql_tokenized.statement
- The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id =\n ?
(all engines except Amazon DocumentDB)
\n db.user.id
- The ID of the user logged in to the database (all engines except Amazon DocumentDB).
\n db.user.name
- The name of the user logged in to the database (all engines except Amazon DocumentDB).
\n db.wait_event.name
- The event for which the backend is waiting (all engines except Amazon DocumentDB).
\n db.wait_event.type
- The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
\n db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines except\n Amazon DocumentDB).
\n db.wait_state.name
- The event for which the backend is waiting (only Amazon DocumentDB).
A logical grouping of Performance Insights metrics for a related subject area. For example, the\n db.sql
dimension group consists of the following dimensions:\n db.sql.id
, db.sql.db_id
, db.sql.statement
, and\n db.sql.tokenized_id
.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.
\nA logical grouping of Performance Insights metrics for a related subject area. For example, the\n db.sql
dimension group consists of the following dimensions:
\n db.sql.id
- The hash of a running SQL statement, generated by Performance Insights.
\n db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with\n pi-
.
\n db.sql.statement
- The full text of the SQL statement that is running, for example, SELECT * FROM\n employees
.
\n db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL \n statements, only the first 500 bytes are returned.
\nThe value of the dimension detail data. For the db.sql.statement
dimension, this value is either the\n full or truncated SQL query, depending on the return status.
The value of the dimension detail data. Depending on the return status, this value is either the \n full or truncated SQL query for the following dimensions:
\n\n db.query.statement
(Amazon DocumentDB)
\n db.sql.statement
(Amazon RDS and Aurora)
The full name of the dimension. The full name includes the group name and key name. The only valid value is\n db.sql.statement
.
The full name of the dimension. The full name includes the group name and key name. The following values are valid:
\n\n db.query.statement
(Amazon DocumentDB)
\n db.sql.statement
(Amazon RDS and Aurora)
The status of the dimension detail data. Possible values include the following:
\n\n AVAILABLE
- The dimension detail data is ready to be retrieved.
\n PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is\n required. If the requested detail data for db.sql.statement
has the status PROCESSING
,\n Performance Insights returns the truncated query.
\n UNAVAILABLE
- The dimension detail data could not be collected successfully.
The status of the dimension detail data. Possible values include the following:
\n\n AVAILABLE
- The dimension detail data is ready to be retrieved.
\n PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the\n requested detail data has the status PROCESSING
, Performance Insights returns the truncated query.
\n UNAVAILABLE
- The dimension detail data could not be collected successfully.
The status of the feature on the DB instance. Possible values include the following:\n
\n\n ENABLED
: the feature is enabled on the instance.
\n DISABLED
: the feature is disabled on the instance.
\n UNSUPPORTED
: the feature isn't supported on the instance.
\n ENABLED_PENDING_REBOOT
: the feature is enabled on the instance but requires \n a reboot to take effect.
\n DISABLED_PENDING_REBOOT
: the feature is disabled on the instance but requires \n a reboot to take effect.
\n UNKNOWN
: the feature status couldn't be determined.
The status of the feature on the DB instance. Possible values include the following:
\n\n ENABLED
- The feature is enabled on the instance.
\n DISABLED
- The feature is disabled on the instance.
\n UNSUPPORTED
- The feature isn't supported on the instance.
\n ENABLED_PENDING_REBOOT
- The feature is enabled on the instance but requires a reboot to take effect.
\n DISABLED_PENDING_REBOOT
- The feature is disabled on the instance but requires a reboot to take effect.
\n UNKNOWN
- The feature status couldn't be determined.
Get the attributes of the specified dimension group for a DB instance or data source. \n For example, if you specify a SQL ID, GetDimensionKeyDetails
retrieves \n the full text of the dimension db.sql.statement
cassociated with this ID. \n This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
\n don't support retrieval of large SQL statement text.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,\n GetDimensionKeyDetails
retrieves the full text of the dimension db.sql.statement
associated with this ID.\n This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
don't support retrieval of large\n SQL statement text.
The name of the dimension group. The only valid value is db.sql
. Performance Insights searches the\n specified group for the dimension group ID.
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:
\n\n db.query
(Amazon DocumentDB only)
\n db.sql
(Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql
,\n the group ID is db.sql.id
.
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql
, the group ID is\n db.sql.id
. The following group ID values are valid:
\n db.sql.id
for dimension group db.sql
(Aurora and RDS only)
\n db.query.id
for dimension group db.query
(DocumentDB only)
A list of dimensions to retrieve the detail data for within the given dimension group. \n For the dimension group db.sql
, specify either the full dimension name \n db.sql.statement
or the short dimension name statement
. \n If you don't specify this parameter, Performance Insights returns all \n dimension data within the specified dimension group.\n
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
\n\n db.sql
- Specify either the full dimension name db.sql.statement
or the short dimension name\n statement
(Aurora and RDS only).
\n db.query
- Specify either the full dimension name db.query.statement
or the short dimension name\n statement
(DocumentDB only).
Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide\n specific dimension groups and dimensions, and provide aggregation and filtering criteria for\n each group.
\nEach response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.
\nRetrieve Performance Insights metrics for a set of data sources over a time period. You can provide\n specific dimension groups and dimensions, and provide aggregation and filtering criteria for\n each group.
\nEach response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.
\nThe Amazon Web Services service for which Performance Insights returns metrics. The only valid value for ServiceType is\n RDS
.
The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
\n\n RDS
\n
\n DOCDB
\n
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use a DB instance as a data source, specify its DbiResourceId
value. For example, specify\n db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is\n returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An array of one or more queries to perform. Each query must specify a Performance Insights metric, and\n can optionally specify aggregation and filtering criteria.
", + "smithy.api#documentation": "An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering\n criteria.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.pi#ISOTimestamp", "traits": { - "smithy.api#documentation": "The date and time specifying the beginning of the requested time series data. You can't\n specify a StartTime
that's earlier than 7 days ago. The value specified is\n inclusive - data points equal to or greater than StartTime
\n will be returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the beginning of the requested time series query range. You can't\n specify a StartTime
that is earlier than 7 days ago. By default, Performance Insights has 7 days of \n retention, but you can extend this range up to 2 years. The value specified is\n inclusive. Thus, the command returns data points equal to or greater \n than StartTime
.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series data. The value specified is \n exclusive - data points less than (but not equal to) EndTime
will be returned.
The value for EndTime
must be later than the value for StartTime
.
The date and time specifying the end of the requested time series query range. The value \n specified is exclusive. Thus, the command returns data points less than \n (but not equal to) EndTime
.
The value for EndTime
must be later than the value for StartTime
.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as\n one second, or as long as one day (86400 seconds). Valid values are:
\n \n\n 1
(one second)
\n 60
(one minute)
\n 300
(five minutes)
\n 3600
(one hour)
\n 86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights will choose a value for\n you, with a goal of returning roughly 100-200 data points in the response.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400\n seconds). Valid values are:
\n\n 1
(one second)
\n 60
(one minute)
\n 300
(five minutes)
\n 3600
(one hour)
\n 86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data\n points in the response.
The maximum number of items to return in the response. \n If more items exist than the specified MaxRecords
value, a pagination \n token is included in the response so that the remaining \n results can be retrieved.\n
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a\n pagination token is included in the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond\n the token, up to the value specified by MaxRecords
.
The start time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds
). AlignedStartTime
will be less than or\n equal to the value of the user-specified StartTime
.
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
).\n AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds
). AlignedEndTime
will be greater than\n or equal to the value of the user-specified Endtime
.
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
).\n AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from \n this data source.\n
\nTo use a DB instance as a data source, you specify its DbiResourceId
value - \n for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
\n
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is\n returned as DbiResourceId
.
An array of metric results,, where each array element contains all of the data points for a particular dimension.
" + "smithy.api#documentation": "An array of metric results, where each array element contains all of the data points for a \n particular dimension.
" } }, "NextToken": { @@ -916,7 +916,7 @@ "MetricTypes": { "target": "com.amazonaws.pi#MetricTypeList", "traits": { - "smithy.api#documentation": "The types of metrics to return in the response. Valid values in the array include the following:
\n\n os
(OS counter metrics)
\n db
(DB load metrics)
\n db.sql.stats
(per-SQL metrics)
\n db.sql_tokenized.stats
(per-SQL digest metrics)
The types of metrics to return in the response. Valid values in the array include the following:
\n\n os
(OS counter metrics) - All engines
\n db
(DB load metrics) - All engines except for Amazon DocumentDB
\n db.sql.stats
(per-SQL metrics) - All engines except for Amazon DocumentDB
\n db.sql_tokenized.stats
(per-SQL digest metrics) - All engines except for Amazon DocumentDB
The maximum number of items to return. If the MaxRecords
value is less than the number of \n existing items, the response includes a pagination token.\n
The maximum number of items to return. If the MaxRecords
value is less than the number \n of existing items, the response includes a pagination token.
An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" + "smithy.api#documentation": "An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" } }, "NextToken": { "target": "com.amazonaws.pi#NextToken", "traits": { - "smithy.api#documentation": "A pagination token that indicates the response didn’t return all available records\n because MaxRecords
was specified in the previous request. To get the remaining \n records, specify NextToken
in a separate request with this value.\n
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the\n previous request. To get the remaining records, specify NextToken
in a separate request with this value.
The name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- a scaled representation of the number of active sessions\n for the database engine.
\n db.sampledload.avg
- the raw number of active sessions for the\n database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
\n are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
\n showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. \n For most use cases, you can query db.load.avg
only.
The name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- A scaled representation of the number of active sessions for the \n database engine.
\n db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same\n value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the\n scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than\n db.load.avg
. For most use cases, you can query db.load.avg
only.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on \n data captured from a running DB instance. The guide provides detailed information about Performance Insights \n data types, parameters and errors.\n
\n \nWhen Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. \n Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. \n Performance Insights offers a domain-specific view of DB load.\n
\nDB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional \n time-series dataset. The time dimension provides DB load data for each time point in the \n queried time range. Each time point decomposes overall load in relation to the requested dimensions, \n measured at that time point. Examples include SQL, Wait event, User, and Host.\n
\n\nTo learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n
\nTo learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n
\nAmazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide\n provides detailed information about Performance Insights data types, parameters and errors.
\nWhen Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the\n authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
\nDB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension\n provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested\n dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
\nTo learn more about Performance Insights and Amazon Aurora DB instances, go to the \n Amazon Aurora User Guide\n .
\nTo learn more about Performance Insights and Amazon RDS DB instances, go to the \n Amazon RDS User Guide\n .
\nTo learn more about Performance Insights and Amazon DocumentDB clusters, go to the \n Amazon DocumentDB Developer Guide\n .
\nThe name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- a scaled representation of the number of active sessions\n for the database engine.
\n db.sampledload.avg
- the raw number of active sessions for the\n database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and \n db.sampledload.avg
are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, \n db.sampledload.avg
showing the raw values, and db.sampledload.avg
less \n than db.load.avg
. For most use cases, you can query db.load.avg
only.\n
The name of a Performance Insights metric to be measured.
\nValid values for Metric
are:
\n db.load.avg
- A scaled representation of the number of active sessions for the database engine.
\n db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights\n operating system counters in the Amazon Aurora User Guide.
\nIf the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and \n db.sampledload.avg
are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, \n db.sampledload.avg
showing the raw values, and db.sampledload.avg
less \n than db.load.avg
. For most use cases, you can query db.load.avg
only.\n
The versions that are currently available for the specified managed rule group.
" } + }, + "CurrentDefaultVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "The name of the version that's currently set as the default.
" + } } } }, @@ -5302,7 +5317,7 @@ } }, "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet
, to provide information about the sign-in page of your application.
Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet
, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig
objects for any rule group configuration, for example UsernameField
and PasswordField
. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath
, PasswordField
, PayloadType
and UsernameField
.
Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet
, to provide information about the sign-in page of your application.
Additional information that's used by a managed rule group. Most managed rule groups don't require this.
\nUse this for the account takeover prevention managed rule group \n AWSManagedRulesATPRuleSet
, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig
objects for any rule group configuration, for example UsernameField
and PasswordField
. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath
, PasswordField
, PayloadType
and UsernameField
.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" } }, + "VersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
" + } + }, "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { @@ -6226,7 +6247,7 @@ "Policy": { "target": "com.amazonaws.wafv2#PolicyString", "traits": { - "smithy.api#documentation": "The policy to attach to the specified rule group.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect
, Action
, and Principal
.
\n Effect
must specify Allow
.
\n Action
must specify wafv2:CreateWebACL
, wafv2:UpdateWebACL
, and wafv2:PutFirewallManagerRuleGroups
. WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource
parameter.
For more information, see IAM Policies.
", + "smithy.api#documentation": "The policy to attach to the specified rule group.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect
, Action
, and Principal
.
\n Effect
must specify Allow
.
\n Action
must specify wafv2:CreateWebACL
, wafv2:UpdateWebACL
, and \n wafv2:PutFirewallManagerRuleGroups
and may optionally specify wafv2:GetRuleGroup
. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource
parameter.
For more information, see IAM Policies.
", "smithy.api#required": {} } } @@ -8287,7 +8308,7 @@ } }, "traits": { - "smithy.api#documentation": "The operation failed because the specified policy isn't in the proper format.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect
, Action
, and Principal
.
\n Effect
must specify Allow
.
\n Action
must specify wafv2:CreateWebACL
, wafv2:UpdateWebACL
, and wafv2:PutFirewallManagerRuleGroups
. WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource
parameter.
For more information, see IAM Policies.
", + "smithy.api#documentation": "The operation failed because the specified policy isn't in the proper format.
\n \nThe policy specifications must conform to the following:
\nThe policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
\nThe policy must include specifications for Effect
, Action
, and Principal
.
\n Effect
must specify Allow
.
\n Action
must specify wafv2:CreateWebACL
, wafv2:UpdateWebACL
, and \n wafv2:PutFirewallManagerRuleGroups
and may optionally specify wafv2:GetRuleGroup
. \n WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource
parameter.
For more information, see IAM Policies.
", "smithy.api#error": "client" } }, diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index d43afeef999..08cf7d68748 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -561,6 +561,14 @@ { "value": "GRAPHICSPRO", "name": "GRAPHICSPRO" + }, + { + "value": "GRAPHICS_G4DN", + "name": "GRAPHICS_G4DN" + }, + { + "value": "GRAPHICSPRO_G4DN", + "name": "GRAPHICSPRO_G4DN" } ] } @@ -3289,7 +3297,7 @@ "IngestionProcess": { "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", "traits": { - "smithy.api#documentation": "The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming\n Protocol (WSP). To use WSP, specify a value that ends in _WSP
. To use PCoIP,\n specify a value that does not end in _WSP
.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify\n BYOL_REGULAR
or BYOL_REGULAR_WSP
, depending on the\n protocol.
The ingestion process to be used when importing the image, depending on which protocol \n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming Protocol \n (WSP). To use WSP, specify a value that ends in _WSP
. To use PCoIP, specify a value \n that does not end in _WSP
.
For non-GPU-enabled images (bundles other than Graphics.g4dn, GraphicsPro.g4dn, Graphics, \n or GraphicsPro), specify BYOL_REGULAR
or BYOL_REGULAR_WSP
, depending\n on the protocol.
Use BYOL_GRAPHICS_G4DN
ingestion for both Graphics.g4dn and\n GraphicsPro.g4dn.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.
\nAlthough this parameter is an array, only one item is allowed at this time.
\nIf specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.
\nAlthough this parameter is an array, only one item is allowed at this time
\nMicrosoft Office 2016 application subscription through AWS is currently not supported \n for Graphics.g4dn Bring Your Own License (BYOL) images
\n