diff --git a/.changes/1.35.15.json b/.changes/1.35.15.json new file mode 100644 index 0000000000..b6a59055f0 --- /dev/null +++ b/.changes/1.35.15.json @@ -0,0 +1,32 @@ +[ + { + "category": "``dynamodb``", + "description": "Doc-only update for DynamoDB. Added information about async behavior for TagResource and UntagResource APIs and updated the description of ResourceInUseException.", + "type": "api-change" + }, + { + "category": "``elbv2``", + "description": "Add paginators for the ELBv2 DescribeListenerCertificates and DescribeRules APIs. Fix broken waiter for the ELBv2 DescribeLoadBalancers API.", + "type": "api-change" + }, + { + "category": "``ivs-realtime``", + "description": "IVS Real-Time now offers customers the ability to broadcast to Stages using RTMP(S).", + "type": "api-change" + }, + { + "category": "``kafka``", + "description": "Amazon MSK Replicator can now replicate data to identically named topics between MSK clusters within the same AWS Region or across different AWS Regions.", + "type": "api-change" + }, + { + "category": "``sagemaker``", + "description": "Amazon Sagemaker supports orchestrating SageMaker HyperPod clusters with Amazon EKS", + "type": "api-change" + }, + { + "category": "``sagemaker-runtime``", + "description": "AWS SageMaker Runtime feature: Add sticky routing to support stateful inference models.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index be409add97..e224da5a25 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,17 @@ CHANGELOG ========= +1.35.15 +======= + +* api-change:``dynamodb``: Doc-only update for DynamoDB. Added information about async behavior for TagResource and UntagResource APIs and updated the description of ResourceInUseException. +* api-change:``elbv2``: Add paginators for the ELBv2 DescribeListenerCertificates and DescribeRules APIs. Fix broken waiter for the ELBv2 DescribeLoadBalancers API. +* api-change:``ivs-realtime``: IVS Real-Time now offers customers the ability to broadcast to Stages using RTMP(S). +* api-change:``kafka``: Amazon MSK Replicator can now replicate data to identically named topics between MSK clusters within the same AWS Region or across different AWS Regions. +* api-change:``sagemaker``: Amazon Sagemaker supports orchestrating SageMaker HyperPod clusters with Amazon EKS +* api-change:``sagemaker-runtime``: AWS SageMaker Runtime feature: Add sticky routing to support stateful inference models. + + 1.35.14 ======= diff --git a/botocore/__init__.py b/botocore/__init__.py index 3c0af10ef0..4f58e0cc3d 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.35.14' +__version__ = '1.35.15' class NullHandler(logging.Handler): diff --git a/botocore/data/dynamodb/2012-08-10/service-2.json b/botocore/data/dynamodb/2012-08-10/service-2.json index 9b95e4b201..e3511f9b90 100644 --- a/botocore/data/dynamodb/2012-08-10/service-2.json +++ b/botocore/data/dynamodb/2012-08-10/service-2.json @@ -766,7 +766,7 @@ {"shape":"InternalServerError"}, {"shape":"ResourceInUseException"} ], - "documentation":"
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", + "documentation":"Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
TagResource
is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource
request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource
uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource
request again.
The application or removal of tags using TagResource
and UntagResource
APIs is eventually consistent. ListTagsOfResource
API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", "endpointdiscovery":{ } }, @@ -823,7 +823,7 @@ {"shape":"InternalServerError"}, {"shape":"ResourceInUseException"} ], - "documentation":"Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource
up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", + "documentation":"Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource
up to five times per second, per account.
UntagResource
is an asynchronous operation. If you issue a ListTagsOfResource request immediately after an UntagResource
request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource
uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource
request again.
The application or removal of tags using TagResource
and UntagResource
APIs is eventually consistent. ListTagsOfResource
API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", "endpointdiscovery":{ } }, @@ -5230,7 +5230,7 @@ "documentation":"The resource which is being attempted to be changed is in use.
" } }, - "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING
state.
The operation conflicts with the resource's availability. For example:
You attempted to recreate an existing table.
You tried to delete a table currently in the CREATING
state.
You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
", "exception":true }, "ResourceNotFoundException":{ diff --git a/botocore/data/elbv2/2015-12-01/waiters-2.json b/botocore/data/elbv2/2015-12-01/waiters-2.json index 9f3d77d828..0a7e8afdd5 100644 --- a/botocore/data/elbv2/2015-12-01/waiters-2.json +++ b/botocore/data/elbv2/2015-12-01/waiters-2.json @@ -13,7 +13,7 @@ }, { "matcher": "error", - "expected": "LoadBalancerNotFound", + "expected": "LoadBalancerNotFoundException", "state": "retry" } ] @@ -38,7 +38,7 @@ { "state": "retry", "matcher": "error", - "expected": "LoadBalancerNotFound" + "expected": "LoadBalancerNotFoundException" } ] }, @@ -55,7 +55,7 @@ }, { "matcher": "error", - "expected": "LoadBalancerNotFound", + "expected": "LoadBalancerNotFoundException", "state": "success" } ] diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index f3745188fe..b4355eba40 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -1757,6 +1757,12 @@ "tags" : [ "dualstack" ] } ] }, + "eu-central-2" : { + "variants" : [ { + "hostname" : "appmesh.eu-central-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "eu-north-1" : { "variants" : [ { "hostname" : "appmesh.eu-north-1.api.aws", @@ -1769,6 +1775,12 @@ "tags" : [ "dualstack" ] } ] }, + "eu-south-2" : { + "variants" : [ { + "hostname" : "appmesh.eu-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "eu-west-1" : { "variants" : [ { "hostname" : "appmesh.eu-west-1.api.aws", diff --git a/botocore/data/ivs-realtime/2020-07-14/paginators-1.json b/botocore/data/ivs-realtime/2020-07-14/paginators-1.json index c0d2208c7c..a7ae6129ac 100644 --- a/botocore/data/ivs-realtime/2020-07-14/paginators-1.json +++ b/botocore/data/ivs-realtime/2020-07-14/paginators-1.json @@ -5,6 +5,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "publicKeys" + }, + "ListIngestConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "ingestConfigurations" } } } diff --git a/botocore/data/ivs-realtime/2020-07-14/service-2.json b/botocore/data/ivs-realtime/2020-07-14/service-2.json index 76bbe212f3..6d76fe7d40 100644 --- a/botocore/data/ivs-realtime/2020-07-14/service-2.json +++ b/botocore/data/ivs-realtime/2020-07-14/service-2.json @@ -3,8 +3,8 @@ "metadata":{ "apiVersion":"2020-07-14", "endpointPrefix":"ivsrealtime", + "jsonVersion":"1.1", "protocol":"rest-json", - "protocols":["rest-json"], "serviceAbbreviation":"ivsrealtime", "serviceFullName":"Amazon Interactive Video Service RealTime", "serviceId":"IVS RealTime", @@ -33,6 +33,23 @@ ], "documentation":"Creates an EncoderConfiguration object.
" }, + "CreateIngestConfiguration":{ + "name":"CreateIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateIngestConfigurationRequest"}, + "output":{"shape":"CreateIngestConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
" + }, "CreateParticipantToken":{ "name":"CreateParticipantToken", "http":{ @@ -107,6 +124,24 @@ ], "documentation":"Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
" }, + "DeleteIngestConfiguration":{ + "name":"DeleteIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/DeleteIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"DeleteIngestConfigurationRequest"}, + "output":{"shape":"DeleteIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force
is set to true
.
Shuts down and deletes the specified stage (disconnecting all participants).
" + "documentation":"Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn
from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.
Disconnects a specified participant and revokes the participant permanently from a specified stage.
" + "documentation":"Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn
in the IngestConfiguration to be an empty string.
Gets information about the specified EncoderConfiguration resource.
" }, + "GetIngestConfiguration":{ + "name":"GetIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetIngestConfigurationRequest"}, + "output":{"shape":"GetIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about the specified IngestConfiguration.
" + }, "GetParticipant":{ "name":"GetParticipant", "http":{ @@ -354,6 +405,21 @@ ], "documentation":"Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
" }, + "ListIngestConfigurations":{ + "name":"ListIngestConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListIngestConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListIngestConfigurationsRequest"}, + "output":{"shape":"ListIngestConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
" + }, "ListParticipantEvents":{ "name":"ListParticipantEvents", "http":{ @@ -482,7 +548,7 @@ {"shape":"ConflictException"}, {"shape":"PendingVerification"} ], - "documentation":"Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Removes tags from the resource with the specified ARN.
", "idempotent":true }, + "UpdateIngestConfiguration":{ + "name":"UpdateIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/UpdateIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateIngestConfigurationRequest"}, + "output":{"shape":"UpdateIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
" + }, "UpdateStage":{ "name":"UpdateStage", "http":{ @@ -605,6 +689,7 @@ "max":8500000, "min":1 }, + "Boolean":{"type":"boolean"}, "ChannelArn":{ "type":"string", "max":128, @@ -658,7 +743,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Optional name that can be specified for the IngestConfiguration being created.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "userId":{ + "shape":"UserId", + "documentation":"Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantAttributes", + "documentation":"Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs to broadcast. If this is set to RTMP
, insecureIngest
must be set to true
.
Whether the stage allows insecure RTMP ingest. This must be set to true
, if ingestProtocol
is set to RTMP
. Default: false
.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The IngestConfiguration that was created.
" + } + } + }, "CreateParticipantTokenRequest":{ "type":"structure", "required":["stageArn"], @@ -826,7 +954,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
ARN of the IngestConfiguration.
" + }, + "force":{ + "shape":"Boolean", + "documentation":"Optional field to force deletion of the IngestConfiguration. If this is set to true
when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false
.
Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
" + "documentation":"Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
" }, "reason":{ "shape":"DisconnectParticipantReason", @@ -1107,7 +1254,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Settings for transcoding.
" @@ -1144,7 +1291,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about an EncoderConfiguration.
" @@ -1184,7 +1331,15 @@ "enum":[ "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", - "PUBLISHER_NOT_FOUND" + "PUBLISHER_NOT_FOUND", + "BITRATE_EXCEEDED", + "RESOLUTION_EXCEEDED", + "STREAM_DURATION_EXCEEDED", + "INVALID_AUDIO_CODEC", + "INVALID_VIDEO_CODEC", + "INVALID_PROTOCOL", + "INVALID_STREAM_KEY", + "REUSE_OF_STREAM_KEY" ] }, "EventList":{ @@ -1249,6 +1404,25 @@ } } }, + "GetIngestConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"ARN of the ingest for which the information is to be retrieved.
" + } + } + }, + "GetIngestConfigurationResponse":{ + "type":"structure", + "members":{ + "ingestConfiguration":{ + "shape":"IngestConfiguration", + "documentation":"The IngestConfiguration that was returned.
" + } + } + }, "GetParticipantRequest":{ "type":"structure", "required":[ @@ -1413,7 +1587,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Ingest name
" + }, + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"Ingest configuration ARN.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs for broadcasting.
" + }, + "streamKey":{ + "shape":"StreamKey", + "documentation":"Ingest-key value for the RTMP(S) protocol.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"ID of the participant within the stage.
" + }, + "state":{ + "shape":"IngestConfigurationState", + "documentation":"State of the ingest configuration. It is ACTIVE
if a publisher currently is publishing to the stage associated with the ingest configuration.
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantAttributes", + "documentation":"Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Object specifying an ingest configuration.
" + }, + "IngestConfigurationArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+" + }, + "IngestConfigurationList":{ + "type":"list", + "member":{"shape":"IngestConfigurationSummary"} + }, + "IngestConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "IngestConfigurationStageArn":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$" + }, + "IngestConfigurationState":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "IngestConfigurationSummary":{ + "type":"structure", + "required":[ + "arn", + "ingestProtocol", + "stageArn", + "participantId", + "state" + ], + "members":{ + "name":{ + "shape":"IngestConfigurationName", + "documentation":"Ingest name.
" + }, + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"Ingest configuration ARN.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs for broadcasting.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"ID of the participant within the stage.
" + }, + "state":{ + "shape":"IngestConfigurationState", + "documentation":"State of the ingest configuration. It is ACTIVE
if a publisher currently is publishing to the stage associated with the ingest configuration.
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + } + }, + "documentation":"Summary information about an IngestConfiguration.
" + }, + "IngestProtocol":{ + "type":"string", + "enum":[ + "RTMP", + "RTMPS" + ] + }, + "InsecureIngest":{"type":"boolean"}, "InternalServerException":{ "type":"structure", "members":{ @@ -1515,6 +1821,41 @@ } } }, + "ListIngestConfigurationsRequest":{ + "type":"structure", + "members":{ + "filterByStageArn":{ + "shape":"StageArn", + "documentation":"Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
" + }, + "filterByState":{ + "shape":"IngestConfigurationState", + "documentation":"Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListIngestConfigurationsResponse":{ + "type":"structure", + "required":["ingestConfigurations"], + "members":{ + "ingestConfigurations":{ + "shape":"IngestConfigurationList", + "documentation":"List of the matching ingest configurations (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more IngestConfigurations than maxResults
, use nextToken
in the request to get the next set.
The participant’s recording state.
" + }, + "protocol":{ + "shape":"ParticipantProtocol", + "documentation":"Type of ingest protocol that the participant employs for broadcasting.
" } }, "documentation":"Object describing a participant that has joined a stage.
" @@ -1891,6 +2242,15 @@ "type":"list", "member":{"shape":"ParticipantSummary"} }, + "ParticipantProtocol":{ + "type":"string", + "enum":[ + "UNKNOWN", + "WHIP", + "RTMP", + "RTMPS" + ] + }, "ParticipantRecordingFilterByRecordingState":{ "type":"string", "enum":[ @@ -2190,7 +2550,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Object specifying a public key used to sign stage participant tokens.
" @@ -2229,7 +2589,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a public key.
" @@ -2353,7 +2713,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
WHIP endpoint.
" + "documentation":"The endpoint to be used for IVS real-time streaming using the WHIP protocol.
" + }, + "rtmp":{ + "shape":"StageEndpoint", + "documentation":"The endpoint to be used for IVS real-time streaming using the RTMP protocol.
" + }, + "rtmps":{ + "shape":"StageEndpoint", + "documentation":"The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
" } }, - "documentation":"Summary information about various endpoints for a stage.
" + "documentation":"Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.
" }, "StageName":{ "type":"string", @@ -2461,7 +2829,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a stage.
" @@ -2496,7 +2864,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
A complex type that describes a location where recorded videos will be stored.
" @@ -2577,7 +2945,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a storage configuration.
" @@ -2586,6 +2954,11 @@ "type":"list", "member":{"shape":"StorageConfigurationSummary"} }, + "StreamKey":{ + "type":"string", + "pattern":"rt_[0-9]+_[a-z0-9-]+_[a-zA-Z0-9-]+_.+", + "sensitive":true + }, "String":{"type":"string"}, "TagKey":{ "type":"string", @@ -2613,7 +2986,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"Array of tags to be added or updated. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.
Array of tags to be added or updated. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Array of tags to be removed. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.
Array of tags to be removed. Array of maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"Stage ARN that needs to be updated.
" + } + } + }, + "UpdateIngestConfigurationResponse":{ + "type":"structure", + "members":{ + "ingestConfiguration":{ + "shape":"IngestConfiguration", + "documentation":"The updated IngestConfiguration.
" + } + } + }, "UpdateStageRequest":{ "type":"structure", "required":["arn"], @@ -2758,5 +3154,5 @@ }, "errorMessage":{"type":"string"} }, - "documentation":"The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature
to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
" + "documentation":"The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature
to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
" } diff --git a/botocore/data/kafka/2018-11-14/service-2.json b/botocore/data/kafka/2018-11-14/service-2.json index 8c09d49249..0ebb388024 100644 --- a/botocore/data/kafka/2018-11-14/service-2.json +++ b/botocore/data/kafka/2018-11-14/service-2.json @@ -9,46 +9,57 @@ "protocol": "rest-json", "jsonVersion": "1.1", "uid": "kafka-2018-11-14", - "signatureVersion": "v4" + "signatureVersion": "v4", + "auth": [ + "aws.auth#sigv4" + ] }, "operations": { - "BatchAssociateScramSecret" : { - "name" : "BatchAssociateScramSecret", - "http" : { - "method" : "POST", - "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode" : 200 - }, - "input" : { - "shape" : "BatchAssociateScramSecretRequest" - }, - "output" : { - "shape" : "BatchAssociateScramSecretResponse", + "BatchAssociateScramSecret": { + "name": "BatchAssociateScramSecret", + "http": { + "method": "POST", + "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", + "responseCode": 200 + }, + "input": { + "shape": "BatchAssociateScramSecretRequest" + }, + "output": { + "shape": "BatchAssociateScramSecretResponse", "documentation": "\n200 response
\n " }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " - }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " - }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " - } ], - "documentation" : "\nAssociates one or more Scram Secrets with an Amazon MSK cluster.
\n " + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " + }, + { + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " + } + ], + "documentation": "\nAssociates one or more Scram Secrets with an Amazon MSK cluster.
\n " }, "CreateCluster": { "name": "CreateCluster", @@ -398,7 +409,8 @@ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" - }, { + }, + { "shape": "UnauthorizedException", "documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" }, @@ -573,43 +585,51 @@ ], "documentation": "\nReturns a description of the cluster operation specified by the ARN.
\n " }, - "DescribeClusterOperationV2" : { - "name" : "DescribeClusterOperationV2", - "http" : { - "method" : "GET", - "requestUri" : "/api/v2/operations/{clusterOperationArn}", - "responseCode" : 200 - }, - "input" : { - "shape" : "DescribeClusterOperationV2Request" - }, - "output" : { - "shape" : "DescribeClusterOperationV2Response", - "documentation" : "\nHTTP Status Code 200: OK.
" - }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nHTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nHTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nHTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" - }, { - "shape" : "ForbiddenException", - "documentation" : "\nHTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" - }, { - "shape" : "NotFoundException", - "documentation" : "\nHTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\nHTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\nHTTP Status Code 429: Limit exceeded. Resource limit reached.
" - } ], - "documentation" : "\nReturns a description of the cluster operation specified by the ARN.
\n" + "DescribeClusterOperationV2": { + "name": "DescribeClusterOperationV2", + "http": { + "method": "GET", + "requestUri": "/api/v2/operations/{clusterOperationArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeClusterOperationV2Request" + }, + "output": { + "shape": "DescribeClusterOperationV2Response", + "documentation": "\nHTTP Status Code 200: OK.
" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nHTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" + }, + { + "shape": "UnauthorizedException", + "documentation": "\nHTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nHTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" + }, + { + "shape": "ForbiddenException", + "documentation": "\nHTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" + }, + { + "shape": "NotFoundException", + "documentation": "\nHTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\nHTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
" + }, + { + "shape": "TooManyRequestsException", + "documentation": "\nHTTP Status Code 429: Limit exceeded. Resource limit reached.
" + } + ], + "documentation": "\nReturns a description of the cluster operation specified by the ARN.
\n" }, "DescribeConfiguration": { "name": "DescribeConfiguration", @@ -783,43 +803,51 @@ ], "documentation": "\nReturns a description of this MSK VPC connection.
\n " }, - "BatchDisassociateScramSecret" : { - "name" : "BatchDisassociateScramSecret", - "http" : { - "method" : "PATCH", - "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode" : 200 + "BatchDisassociateScramSecret": { + "name": "BatchDisassociateScramSecret", + "http": { + "method": "PATCH", + "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", + "responseCode": 200 }, - "input" : { - "shape" : "BatchDisassociateScramSecretRequest" + "input": { + "shape": "BatchDisassociateScramSecretRequest" }, - "output" : { - "shape" : "BatchDisassociateScramSecretResponse", + "output": { + "shape": "BatchDisassociateScramSecretResponse", "documentation": "\n200 response
\n " }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " - }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " - }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " - } ], - "documentation" : "\nDisassociates one or more Scram Secrets from an Amazon MSK cluster.
\n " + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " + }, + { + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " + } + ], + "documentation": "\nDisassociates one or more Scram Secrets from an Amazon MSK cluster.
\n " }, "GetBootstrapBrokers": { "name": "GetBootstrapBrokers", @@ -857,51 +885,50 @@ "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], - "documentation": "\nA list of brokers that a client application can use to bootstrap.
\n " + "documentation": "\nA list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters
operation to get the ARNs of all the clusters in this account and Region.
Successful response.
\n " }, - "errors" : - [ + "errors": [ { - "shape" : "BadRequestException", - "documentation" : "nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
n " + "shape": "BadRequestException", + "documentation": "nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
n " }, { - "shape" : "UnauthorizedException", - "documentation" : "nThe request is not authorized. The provided credentials couldn't be validated.
n " + "shape": "UnauthorizedException", + "documentation": "nThe request is not authorized. The provided credentials couldn't be validated.
n " }, { - "shape" : "InternalServerErrorException", - "documentation" : "nThere was an unexpected internal server error. Retrying your request might resolve the issue.
n " + "shape": "InternalServerErrorException", + "documentation": "nThere was an unexpected internal server error. Retrying your request might resolve the issue.
n " }, { - "shape" : "ForbiddenException", - "documentation" : "nAccess forbidden. Check your credentials and then retry your request.
n " + "shape": "ForbiddenException", + "documentation": "nAccess forbidden. Check your credentials and then retry your request.
n " }, { - "shape" : "NotFoundException", - "documentation" : "nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
n " + "shape": "NotFoundException", + "documentation": "nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
n " }, { - "shape" : "ServiceUnavailableException", - "documentation" : "n503 response
n " + "shape": "ServiceUnavailableException", + "documentation": "n503 response
n " }, { - "shape" : "TooManyRequestsException", - "documentation" : "n429 response
n " + "shape": "TooManyRequestsException", + "documentation": "n429 response
n " } ], "documentation": "\nGets the Apache Kafka versions to which you can update the MSK cluster.
\n " @@ -974,43 +1001,51 @@ ], "documentation": "\nReturns a list of all the operations that have been performed on the specified MSK cluster.
\n " }, - "ListClusterOperationsV2" : { - "name" : "ListClusterOperationsV2", - "http" : { - "method" : "GET", - "requestUri" : "/api/v2/clusters/{clusterArn}/operations", - "responseCode" : 200 - }, - "input" : { - "shape" : "ListClusterOperationsV2Request" - }, - "output" : { - "shape" : "ListClusterOperationsV2Response", - "documentation" : "\nHTTP Status Code 200: OK.
" - }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nHTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nHTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nHTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" - }, { - "shape" : "ForbiddenException", - "documentation" : "\nHTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" - }, { - "shape" : "NotFoundException", - "documentation" : "\nHTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\nHTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\nHTTP Status Code 429: Limit exceeded. Resource limit reached.
" - } ], - "documentation" : "\nReturns a list of all the operations that have been performed on the specified MSK cluster.
\n " + "ListClusterOperationsV2": { + "name": "ListClusterOperationsV2", + "http": { + "method": "GET", + "requestUri": "/api/v2/clusters/{clusterArn}/operations", + "responseCode": 200 + }, + "input": { + "shape": "ListClusterOperationsV2Request" + }, + "output": { + "shape": "ListClusterOperationsV2Response", + "documentation": "\nHTTP Status Code 200: OK.
" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nHTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" + }, + { + "shape": "UnauthorizedException", + "documentation": "\nHTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nHTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" + }, + { + "shape": "ForbiddenException", + "documentation": "\nHTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" + }, + { + "shape": "NotFoundException", + "documentation": "\nHTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\nHTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
" + }, + { + "shape": "TooManyRequestsException", + "documentation": "\nHTTP Status Code 429: Limit exceeded. Resource limit reached.
" + } + ], + "documentation": "\nReturns a list of all the operations that have been performed on the specified MSK cluster.
\n " }, "ListClusters": { "name": "ListClusters", @@ -1273,43 +1308,51 @@ ], "documentation": "Lists the replicators.
" }, - "ListScramSecrets" : { - "name" : "ListScramSecrets", - "http" : { - "method" : "GET", - "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode" : 200 + "ListScramSecrets": { + "name": "ListScramSecrets", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", + "responseCode": 200 }, - "input" : { - "shape" : "ListScramSecretsRequest" + "input": { + "shape": "ListScramSecretsRequest" }, - "output" : { - "shape" : "ListScramSecretsResponse", + "output": { + "shape": "ListScramSecretsResponse", "documentation": "\n200 response
\n " }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " - }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " - }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " - } ], - "documentation" : "\nReturns a list of the Scram Secrets associated with an Amazon MSK cluster.
\n " + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " + }, + { + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " + } + ], + "documentation": "\nReturns a list of the Scram Secrets associated with an Amazon MSK cluster.
\n " }, "ListTagsForResource": { "name": "ListTagsForResource", @@ -1485,51 +1528,51 @@ ], "documentation": "\nCreates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
\n " }, - "RebootBroker" : { - "name" : "RebootBroker", - "http" : { - "method" : "PUT", - "requestUri" : "/v1/clusters/{clusterArn}/reboot-broker", - "responseCode" : 200 + "RebootBroker": { + "name": "RebootBroker", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/reboot-broker", + "responseCode": 200 }, - "input" : { - "shape" : "RebootBrokerRequest" + "input": { + "shape": "RebootBrokerRequest" }, - "output" : { - "shape" : "RebootBrokerResponse", + "output": { + "shape": "RebootBrokerResponse", "documentation": "\nSuccessful response.
\n " }, - "errors" : [ + "errors": [ { - "shape" : "BadRequestException", + "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { - "shape" : "UnauthorizedException", + "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { - "shape" : "InternalServerErrorException", + "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { - "shape" : "ForbiddenException", + "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { - "shape" : "NotFoundException", + "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { - "shape" : "ServiceUnavailableException", + "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " } ], - "documentation" : "Reboots brokers." + "documentation": "Reboots brokers." }, "TagResource": { "name": "TagResource", @@ -1637,32 +1680,32 @@ }, "errors": [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " } ], "documentation": "\nUpdates EC2 instance type.
\n " @@ -1747,18 +1790,18 @@ ], "documentation": "\nUpdates an MSK configuration.
\n " }, - "UpdateConnectivity" : { - "name" : "UpdateConnectivity", - "http" : { - "method" : "PUT", - "requestUri" : "/v1/clusters/{clusterArn}/connectivity", - "responseCode" : 200 + "UpdateConnectivity": { + "name": "UpdateConnectivity", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/connectivity", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateConnectivityRequest" + "input": { + "shape": "UpdateConnectivityRequest" }, - "output" : { - "shape" : "UpdateConnectivityResponse", + "output": { + "shape": "UpdateConnectivityResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ @@ -1787,7 +1830,7 @@ "documentation": "\n503 response
\n " } ], - "documentation" : "\nUpdates the cluster's connectivity configuration.
\n " + "documentation": "\nUpdates the cluster's connectivity configuration.
\n " }, "UpdateClusterConfiguration": { "name": "UpdateClusterConfiguration", @@ -1831,83 +1874,89 @@ ], "documentation": "\nUpdates the cluster with the configuration that is specified in the request body.
\n " }, - "UpdateClusterKafkaVersion" : { - "name" : "UpdateClusterKafkaVersion", - "http" : { - "method" : "PUT", - "requestUri" : "/v1/clusters/{clusterArn}/version", - "responseCode" : 200 + "UpdateClusterKafkaVersion": { + "name": "UpdateClusterKafkaVersion", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/version", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateClusterKafkaVersionRequest" + "input": { + "shape": "UpdateClusterKafkaVersionRequest" }, - "output" : { - "shape" : "UpdateClusterKafkaVersionResponse", - "documentation" : "\nSuccessful response.
\n " + "output": { + "shape": "UpdateClusterKafkaVersionResponse", + "documentation": "\nSuccessful response.
\n " }, - "errors" : [ + "errors": [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " }, { - "shape" : "TooManyRequestsException", - "documentation" : "\n429 response
\n " + "shape": "TooManyRequestsException", + "documentation": "\n429 response
\n " } ], "documentation": "\nUpdates the Apache Kafka version for the cluster.
\n " }, - "UpdateMonitoring" : { - "name" : "UpdateMonitoring", - "http" : { - "method" : "PUT", - "requestUri" : "/v1/clusters/{clusterArn}/monitoring", - "responseCode" : 200 - }, - "input" : { - "shape" : "UpdateMonitoringRequest" - }, - "output" : { - "shape" : "UpdateMonitoringResponse", - "documentation" : "\nHTTP Status Code 200: OK.
\n " - }, - "errors" : [ { - "shape" : "ServiceUnavailableException", - "documentation" : "\n503 response
\n " - }, { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " - }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " - } ], - "documentation" : "\nUpdates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
\n " + "UpdateMonitoring": { + "name": "UpdateMonitoring", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/monitoring", + "responseCode": 200 + }, + "input": { + "shape": "UpdateMonitoringRequest" + }, + "output": { + "shape": "UpdateMonitoringResponse", + "documentation": "\nHTTP Status Code 200: OK.
\n " + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "\n503 response
\n " + }, + { + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " + } + ], + "documentation": "\nUpdates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
\n " }, "UpdateReplicationInfo": { "name": "UpdateReplicationInfo", @@ -1955,84 +2004,100 @@ ], "documentation": "Updates replication info of a replicator.
" }, - "UpdateSecurity" : { - "name" : "UpdateSecurity", - "http" : { - "method" : "PATCH", - "requestUri" : "/v1/clusters/{clusterArn}/security", - "responseCode" : 200 - }, - "input" : { - "shape" : "UpdateSecurityRequest" - }, - "output" : { - "shape" : "UpdateSecurityResponse" - }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " - }, { - "shape" : "UnauthorizedException", - "documentation" : "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " - }, { - "shape" : "InternalServerErrorException", - "documentation" : "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " - }, { - "shape" : "ForbiddenException", - "documentation" : "\nAccess forbidden. Check your credentials and then retry your request.
\n " - }, { - "shape" : "NotFoundException", - "documentation" : "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "\nThe service cannot complete the request.
\n " - }, { - "shape" : "TooManyRequestsException", - "documentation" : "\nThe request throughput limit was exceeded.
\n " - } ], - "documentation" : "\nUpdates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
\n " - }, - "UpdateStorage" : { - "name" : "UpdateStorage", - "http" : { - "method" : "PUT", - "requestUri" : "/v1/clusters/{clusterArn}/storage", - "responseCode" : 200 - }, - "input" : { - "shape" : "UpdateStorageRequest" - }, - "output" : { - "shape" : "UpdateStorageResponse", - "documentation" : "HTTP Status Code 200: OK." - }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." - }, { - "shape" : "UnauthorizedException", - "documentation" : "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated." - }, { - "shape" : "InternalServerErrorException", - "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." - }, { - "shape" : "ForbiddenException", - "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." - }, { - "shape" : "NotFoundException", - "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." - }, { - "shape" : "ServiceUnavailableException", - "documentation" : "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue." - }, { - "shape" : "TooManyRequestsException", - "documentation" : "HTTP Status Code 429: Limit exceeded. Resource limit reached." - } ], - "documentation" : "Updates cluster broker volume size (or) sets cluster storage mode to TIERED." - } - }, - "shapes": { - "AmazonMskCluster": { + "UpdateSecurity": { + "name": "UpdateSecurity", + "http": { + "method": "PATCH", + "requestUri": "/v1/clusters/{clusterArn}/security", + "responseCode": 200 + }, + "input": { + "shape": "UpdateSecurityRequest" + }, + "output": { + "shape": "UpdateSecurityResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " + }, + { + "shape": "NotFoundException", + "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\nThe service cannot complete the request.
\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\nThe request throughput limit was exceeded.
\n " + } + ], + "documentation": "\nUpdates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
\n " + }, + "UpdateStorage": { + "name": "UpdateStorage", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/storage", + "responseCode": 200 + }, + "input": { + "shape": "UpdateStorageRequest" + }, + "output": { + "shape": "UpdateStorageResponse", + "documentation": "HTTP Status Code 200: OK." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, + { + "shape": "UnauthorizedException", + "documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated." + }, + { + "shape": "InternalServerErrorException", + "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, + { + "shape": "ForbiddenException", + "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + }, + { + "shape": "NotFoundException", + "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue." + }, + { + "shape": "TooManyRequestsException", + "documentation": "HTTP Status Code 429: Limit exceeded. Resource limit reached." + } + ], + "documentation": "Updates cluster broker volume size (or) sets cluster storage mode to TIERED." + } + }, + "shapes": { + "AmazonMskCluster": { "type": "structure", "members": { "MskClusterArn": { @@ -2042,38 +2107,43 @@ } }, "documentation": "Details of an Amazon MSK Cluster.
", - "required": ["MskClusterArn"] - }, - "BatchAssociateScramSecretRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " - }, - "SecretArnList" : { - "shape" : "__listOf__string", - "locationName" : "secretArnList", - "documentation" : "\nList of AWS Secrets Manager secret ARNs.
\n " - } - }, - "documentation" : "\nAssociates sasl scram secrets to cluster.
\n ", - "required" : [ "ClusterArn", "SecretArnList" ] - }, - "BatchAssociateScramSecretResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " - }, - "UnprocessedScramSecrets" : { - "shape" : "__listOfUnprocessedScramSecret", - "locationName" : "unprocessedScramSecrets", - "documentation" : "\nList of errors when associating secrets to cluster.
\n " + "required": [ + "MskClusterArn" + ] + }, + "BatchAssociateScramSecretRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " + }, + "SecretArnList": { + "shape": "__listOf__string", + "locationName": "secretArnList", + "documentation": "\nList of AWS Secrets Manager secret ARNs.
\n " + } + }, + "documentation": "\nAssociates sasl scram secrets to cluster.
\n ", + "required": [ + "ClusterArn", + "SecretArnList" + ] + }, + "BatchAssociateScramSecretResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + }, + "UnprocessedScramSecrets": { + "shape": "__listOfUnprocessedScramSecret", + "locationName": "unprocessedScramSecrets", + "documentation": "\nList of errors when associating secrets to cluster.
\n " } } }, @@ -2104,17 +2174,17 @@ "DEFAULT" ] }, - "BrokerCountUpdateInfo" : { - "type" : "structure", - "members" : { - "CreatedBrokerIds" : { - "shape" : "__listOf__double", - "locationName" : "createdBrokerIds", + "BrokerCountUpdateInfo": { + "type": "structure", + "members": { + "CreatedBrokerIds": { + "shape": "__listOf__double", + "locationName": "createdBrokerIds", "documentation": "\nKafka Broker IDs of brokers being created.
\n " }, - "DeletedBrokerIds" : { - "shape" : "__listOf__double", - "locationName" : "deletedBrokerIds", + "DeletedBrokerIds": { + "shape": "__listOf__double", + "locationName": "deletedBrokerIds", "documentation": "\nKafka Broker IDs of brokers being deleted.
\n " } }, @@ -2128,10 +2198,10 @@ "locationName": "kafkaBrokerNodeId", "documentation": "\nThe ID of the broker to update.
\n " }, - "ProvisionedThroughput" : { - "shape" : "ProvisionedThroughput", - "locationName" : "provisionedThroughput", - "documentation" : "\nEBS volume provisioned throughput information.
\n " + "ProvisionedThroughput": { + "shape": "ProvisionedThroughput", + "locationName": "provisionedThroughput", + "documentation": "\nEBS volume provisioned throughput information.
\n " }, "VolumeSizeGB": { "shape": "__integer", @@ -2189,10 +2259,10 @@ "locationName": "storageInfo", "documentation": "\nContains information about storage volumes attached to MSK broker nodes.
\n " }, - "ConnectivityInfo" : { - "shape" : "ConnectivityInfo", - "locationName" : "connectivityInfo", - "documentation" : "\nInformation about the broker access configuration.
\n " + "ConnectivityInfo": { + "shape": "ConnectivityInfo", + "locationName": "connectivityInfo", + "documentation": "\nInformation about the broker access configuration.
\n " }, "ZoneIds": { "shape": "__listOf__string", @@ -2263,34 +2333,34 @@ }, "documentation": "\nInformation about the current software installed on the cluster.
\n " }, - "ClientAuthentication" : { - "type" : "structure", - "members" : { - "Sasl" : { - "shape" : "Sasl", - "locationName" : "sasl", - "documentation" : "\nDetails for ClientAuthentication using SASL.
\n " + "ClientAuthentication": { + "type": "structure", + "members": { + "Sasl": { + "shape": "Sasl", + "locationName": "sasl", + "documentation": "\nDetails for ClientAuthentication using SASL.
\n " }, "Tls": { "shape": "Tls", "locationName": "tls", "documentation": "\nDetails for ClientAuthentication using TLS.
\n " }, - "Unauthenticated" : { - "shape" : "Unauthenticated", - "locationName" : "unauthenticated", + "Unauthenticated": { + "shape": "Unauthenticated", + "locationName": "unauthenticated", "documentation": "\nContains information about unauthenticated traffic to the cluster.
\n " } }, - "documentation" : "\nIncludes all client authentication information.
\n " + "documentation": "\nIncludes all client authentication information.
\n " }, - "VpcConnectivityClientAuthentication" : { - "type" : "structure", - "members" : { - "Sasl" : { - "shape" : "VpcConnectivitySasl", - "locationName" : "sasl", - "documentation" : "\nSASL authentication type details for VPC connectivity.
\n " + "VpcConnectivityClientAuthentication": { + "type": "structure", + "members": { + "Sasl": { + "shape": "VpcConnectivitySasl", + "locationName": "sasl", + "documentation": "\nSASL authentication type details for VPC connectivity.
\n " }, "Tls": { "shape": "VpcConnectivityTls", @@ -2298,18 +2368,18 @@ "documentation": "\nTLS authentication type details for VPC connectivity.
\n " } }, - "documentation" : "\nIncludes all client authentication information for VPC connectivity.
\n " + "documentation": "\nIncludes all client authentication information for VPC connectivity.
\n " }, - "ServerlessClientAuthentication" : { - "type" : "structure", - "members" : { - "Sasl" : { - "shape" : "ServerlessSasl", - "locationName" : "sasl", - "documentation" : "\nDetails for ClientAuthentication using SASL.
\n " + "ServerlessClientAuthentication": { + "type": "structure", + "members": { + "Sasl": { + "shape": "ServerlessSasl", + "locationName": "sasl", + "documentation": "\nDetails for ClientAuthentication using SASL.
\n " } }, - "documentation" : "\nIncludes all client authentication information.
\n " + "documentation": "\nIncludes all client authentication information.
\n " }, "ClientBroker": { "type": "string", @@ -2320,19 +2390,21 @@ "PLAINTEXT" ] }, - "CloudWatchLogs" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled" + "CloudWatchLogs": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled" }, - "LogGroup" : { - "shape" : "__string", - "locationName" : "logGroup" + "LogGroup": { + "shape": "__string", + "locationName": "logGroup" } }, - "required" : [ "Enabled" ] + "required": [ + "Enabled" + ] }, "ClusterInfo": { "type": "structure", @@ -2387,10 +2459,10 @@ "locationName": "enhancedMonitoring", "documentation": "\nSpecifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
\n " }, - "OpenMonitoring" : { - "shape" : "OpenMonitoring", - "locationName" : "openMonitoring", - "documentation" : "\nSettings for open monitoring using Prometheus.
\n " + "OpenMonitoring": { + "shape": "OpenMonitoring", + "locationName": "openMonitoring", + "documentation": "\nSettings for open monitoring using Prometheus.
\n " }, "LoggingInfo": { "shape": "LoggingInfo", @@ -2406,9 +2478,9 @@ "locationName": "state", "documentation": "\nThe state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
\n " }, - "StateInfo" : { - "shape" : "StateInfo", - "locationName" : "stateInfo" + "StateInfo": { + "shape": "StateInfo", + "locationName": "stateInfo" }, "Tags": { "shape": "__mapOf__string", @@ -2420,15 +2492,15 @@ "locationName": "zookeeperConnectString", "documentation": "\nThe connection string to use to connect to the Apache ZooKeeper cluster.
\n " }, - "ZookeeperConnectStringTls" : { - "shape" : "__string", - "locationName" : "zookeeperConnectStringTls", - "documentation" : "\nThe connection string to use to connect to zookeeper cluster on Tls port.
\n " + "ZookeeperConnectStringTls": { + "shape": "__string", + "locationName": "zookeeperConnectStringTls", + "documentation": "\nThe connection string to use to connect to zookeeper cluster on Tls port.
\n " }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nThis controls storage mode for supported storage tiers.
\n " + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nThis controls storage mode for supported storage tiers.
\n " }, "CustomerActionStatus": { "shape": "CustomerActionStatus", @@ -2476,9 +2548,9 @@ "locationName": "state", "documentation": "\nThe state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
\n " }, - "StateInfo" : { - "shape" : "StateInfo", - "locationName" : "stateInfo", + "StateInfo": { + "shape": "StateInfo", + "locationName": "stateInfo", "documentation": "\nState Info for the Amazon MSK cluster.
\n " }, "Tags": { @@ -2537,10 +2609,10 @@ "locationName": "operationState", "documentation": "\nState of the cluster operation.
\n " }, - "OperationSteps" : { - "shape" : "__listOfClusterOperationStep", - "locationName" : "operationSteps", - "documentation" : "\nSteps completed during the operation.
\n " + "OperationSteps": { + "shape": "__listOfClusterOperationStep", + "locationName": "operationSteps", + "documentation": "\nSteps completed during the operation.
\n " }, "OperationType": { "shape": "__string", @@ -2565,32 +2637,32 @@ }, "documentation": "\nReturns information about a cluster operation.
\n " }, - "ClusterOperationStep" : { - "type" : "structure", - "members" : { - "StepInfo" : { - "shape" : "ClusterOperationStepInfo", - "locationName" : "stepInfo", - "documentation" : "\nInformation about the step and its status.
\n " + "ClusterOperationStep": { + "type": "structure", + "members": { + "StepInfo": { + "shape": "ClusterOperationStepInfo", + "locationName": "stepInfo", + "documentation": "\nInformation about the step and its status.
\n " }, - "StepName" : { - "shape" : "__string", - "locationName" : "stepName", - "documentation" : "\nThe name of the step.
\n " + "StepName": { + "shape": "__string", + "locationName": "stepName", + "documentation": "\nThe name of the step.
\n " } }, - "documentation" : "\nStep taken during a cluster operation.
\n " + "documentation": "\nStep taken during a cluster operation.
\n " }, - "ClusterOperationStepInfo" : { - "type" : "structure", - "members" : { - "StepStatus" : { - "shape" : "__string", - "locationName" : "stepStatus", - "documentation" : "\nThe steps current status.
\n " + "ClusterOperationStepInfo": { + "type": "structure", + "members": { + "StepStatus": { + "shape": "__string", + "locationName": "stepStatus", + "documentation": "\nThe steps current status.
\n " } }, - "documentation" : "\nState information about the operation step.
\n " + "documentation": "\nState information about the operation step.
\n " }, "ClusterState": { "type": "string", @@ -2615,9 +2687,9 @@ ] }, "ProvisionedRequest": { - "type" : "structure", + "type": "structure", "documentation": "\nProvisioned cluster request.
\n ", - "members" : { + "members": { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", @@ -2643,10 +2715,10 @@ "locationName": "enhancedMonitoring", "documentation": "\nSpecifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n " }, - "OpenMonitoring" : { - "shape" : "OpenMonitoringInfo", - "locationName" : "openMonitoring", - "documentation" : "\nThe settings for open monitoring.
\n " + "OpenMonitoring": { + "shape": "OpenMonitoringInfo", + "locationName": "openMonitoring", + "documentation": "\nThe settings for open monitoring.
\n " }, "KafkaVersion": { "shape": "__stringMin1Max128", @@ -2663,10 +2735,10 @@ "locationName": "numberOfBrokerNodes", "documentation": "\nThe number of broker nodes in the cluster.
\n " }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nThis controls storage mode for supported storage tiers.
\n " + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nThis controls storage mode for supported storage tiers.
\n " } }, "required": [ @@ -2676,9 +2748,9 @@ ] }, "Provisioned": { - "type" : "structure", + "type": "structure", "documentation": "\nProvisioned cluster.
\n ", - "members" : { + "members": { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", @@ -2704,10 +2776,10 @@ "locationName": "enhancedMonitoring", "documentation": "\nSpecifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n " }, - "OpenMonitoring" : { - "shape" : "OpenMonitoringInfo", - "locationName" : "openMonitoring", - "documentation" : "\nThe settings for open monitoring.
\n " + "OpenMonitoring": { + "shape": "OpenMonitoringInfo", + "locationName": "openMonitoring", + "documentation": "\nThe settings for open monitoring.
\n " }, "LoggingInfo": { "shape": "LoggingInfo", @@ -2724,15 +2796,15 @@ "locationName": "zookeeperConnectString", "documentation": "\nThe connection string to use to connect to the Apache ZooKeeper cluster.
\n " }, - "ZookeeperConnectStringTls" : { - "shape" : "__string", - "locationName" : "zookeeperConnectStringTls", - "documentation" : "\nThe connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
\n " + "ZookeeperConnectStringTls": { + "shape": "__string", + "locationName": "zookeeperConnectStringTls", + "documentation": "\nThe connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
\n " }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nThis controls storage mode for supported storage tiers.
\n " + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nThis controls storage mode for supported storage tiers.
\n " }, "CustomerActionStatus": { "shape": "CustomerActionStatus", @@ -2746,18 +2818,18 @@ ] }, "VpcConfig": { - "type" : "structure", + "type": "structure", "documentation": "\nThe configuration of the Amazon VPCs for the cluster.
\n ", "members": { "SubnetIds": { "shape": "__listOf__string", "locationName": "subnetIds", - "documentation" : "\nThe IDs of the subnets associated with the cluster.
\n " + "documentation": "\nThe IDs of the subnets associated with the cluster.
\n " }, "SecurityGroupIds": { "shape": "__listOf__string", "locationName": "securityGroupIds", - "documentation" : "\nThe IDs of the security groups associated with the cluster.
\n " + "documentation": "\nThe IDs of the security groups associated with the cluster.
\n " } }, "required": [ @@ -2765,9 +2837,9 @@ ] }, "ServerlessRequest": { - "type" : "structure", + "type": "structure", "documentation": "\nServerless cluster request.
\n ", - "members" : { + "members": { "VpcConfigs": { "shape": "__listOfVpcConfig", "locationName": "vpcConfigs", @@ -2784,9 +2856,9 @@ ] }, "Serverless": { - "type" : "structure", + "type": "structure", "documentation": "\nServerless cluster.
\n ", - "members" : { + "members": { "VpcConfigs": { "shape": "__listOfVpcConfig", "locationName": "vpcConfigs", @@ -2810,7 +2882,6 @@ "shape": "__string", "locationName": "authentication", "documentation": "\nInformation about the auth scheme of Vpc Connection.
\n " - }, "CreationTime": { "shape": "__timestampIso8601", @@ -2831,7 +2902,6 @@ "shape": "__string", "locationName": "owner", "documentation": "\nThe Owner of the Vpc Connection.
\n " - } }, "required": [ @@ -2878,17 +2948,17 @@ "TargetClusterArn" ] }, - "CompatibleKafkaVersion" : { - "type" : "structure", - "members" : { - "SourceVersion" : { - "shape" : "__string", - "locationName" : "sourceVersion", + "CompatibleKafkaVersion": { + "type": "structure", + "members": { + "SourceVersion": { + "shape": "__string", + "locationName": "sourceVersion", "documentation": "\nAn Apache Kafka version.
\n " }, - "TargetVersions" : { - "shape" : "__listOf__string", - "locationName" : "targetVersions", + "TargetVersions": { + "shape": "__listOf__string", + "locationName": "targetVersions", "documentation": "\nA list of Apache Kafka versions.
\n " } }, @@ -3018,7 +3088,7 @@ "httpStatusCode": 409 } }, - "ConnectivityInfo" : { + "ConnectivityInfo": { "type": "structure", "members": { "PublicAccess": { @@ -3048,18 +3118,20 @@ "documentation": "List of regular expression patterns indicating the consumer groups to copy.
" }, "DetectAndCopyNewConsumerGroups": { - "shape": "__boolean", - "locationName": "detectAndCopyNewConsumerGroups", - "documentation": "Enables synchronization of consumer groups to target cluster.
" + "shape": "__boolean", + "locationName": "detectAndCopyNewConsumerGroups", + "documentation": "Enables synchronization of consumer groups to target cluster.
" }, "SynchroniseConsumerGroupOffsets": { "shape": "__boolean", "locationName": "synchroniseConsumerGroupOffsets", "documentation": "Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.
" - } - }, - "documentation": "Details about consumer group replication.
", - "required": ["ConsumerGroupsToReplicate"] + } + }, + "documentation": "Details about consumer group replication.
", + "required": [ + "ConsumerGroupsToReplicate" + ] }, "ConsumerGroupReplicationUpdate": { "type": "structure", @@ -3086,7 +3158,12 @@ } }, "documentation": "Details about consumer group replication.
", - "required": ["ConsumerGroupsToReplicate", "ConsumerGroupsToExclude", "SynchroniseConsumerGroupOffsets", "DetectAndCopyNewConsumerGroups"] + "required": [ + "ConsumerGroupsToReplicate", + "ConsumerGroupsToExclude", + "SynchroniseConsumerGroupOffsets", + "DetectAndCopyNewConsumerGroups" + ] }, "CreateClusterV2Request": { "type": "structure", @@ -3149,10 +3226,10 @@ "locationName": "enhancedMonitoring", "documentation": "\nSpecifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
\n " }, - "OpenMonitoring" : { - "shape" : "OpenMonitoringInfo", - "locationName" : "openMonitoring", - "documentation" : "\nThe settings for open monitoring.
\n " + "OpenMonitoring": { + "shape": "OpenMonitoringInfo", + "locationName": "openMonitoring", + "documentation": "\nThe settings for open monitoring.
\n " }, "KafkaVersion": { "shape": "__stringMin1Max128", @@ -3173,10 +3250,10 @@ "locationName": "tags", "documentation": "\nCreate tags when creating the cluster.
\n " }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nThis controls storage mode for supported storage tiers.
\n " + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nThis controls storage mode for supported storage tiers.
\n " } }, "required": [ @@ -3325,7 +3402,12 @@ } }, "documentation": "Creates a replicator using the specified configuration.
", - "required": ["ServiceExecutionRoleArn", "ReplicatorName", "ReplicationInfoList", "KafkaClusters"] + "required": [ + "ServiceExecutionRoleArn", + "ReplicatorName", + "ReplicationInfoList", + "KafkaClusters" + ] }, "CreateReplicatorResponse": { "type": "structure", @@ -3401,7 +3483,6 @@ "shape": "VpcConnectionState", "locationName": "state", "documentation": "\nThe State of Vpc Connection.
\n " - }, "Authentication": { "shape": "__string", @@ -3435,139 +3516,139 @@ } } }, - "ClusterOperationV2" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nARN of the cluster.
" - }, - "ClusterType" : { - "shape" : "ClusterType", - "locationName" : "clusterType", - "documentation" : "\nType of the backend cluster.
" - }, - "StartTime" : { - "shape" : "__timestampIso8601", - "locationName" : "startTime", - "documentation" : "\nThe time at which operation was started.
" - }, - "EndTime" : { - "shape" : "__timestampIso8601", - "locationName" : "endTime", - "documentation" : "\nThe time at which the operation finished.
" - }, - "ErrorInfo" : { - "shape" : "ErrorInfo", - "locationName" : "errorInfo", - "documentation" : "\nIf cluster operation failed from an error, it describes the error.
" - }, - "OperationArn" : { - "shape" : "__string", - "locationName" : "operationArn", - "documentation" : "\nARN of the cluster operation.
" - }, - "OperationState" : { - "shape" : "__string", - "locationName" : "operationState", - "documentation" : "\nState of the cluster operation.
" - }, - "OperationType" : { - "shape" : "__string", - "locationName" : "operationType", - "documentation" : "\nType of the cluster operation.
" - }, - "Provisioned" : { - "shape" : "ClusterOperationV2Provisioned", - "locationName" : "provisioned", - "documentation" : "\nProperties of a provisioned cluster.
" - }, - "Serverless" : { - "shape" : "ClusterOperationV2Serverless", - "locationName" : "serverless", - "documentation" : "\nProperties of a serverless cluster.
" - } - }, - "documentation" : "\nReturns information about a cluster operation.
" - }, - "ClusterOperationV2Provisioned" : { - "type" : "structure", - "members" : { - "OperationSteps" : { - "shape" : "__listOfClusterOperationStep", - "locationName" : "operationSteps", - "documentation" : "\nSteps completed during the operation.
" - }, - "SourceClusterInfo" : { - "shape" : "MutableClusterInfo", - "locationName" : "sourceClusterInfo", - "documentation" : "\nInformation about cluster attributes before a cluster is updated.
" - }, - "TargetClusterInfo" : { - "shape" : "MutableClusterInfo", - "locationName" : "targetClusterInfo", - "documentation" : "\nInformation about cluster attributes after a cluster is updated.
" - }, - "VpcConnectionInfo" : { - "shape" : "VpcConnectionInfo", - "locationName" : "vpcConnectionInfo", - "documentation" : "\nDescription of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
" - } - }, - "documentation" : "\nReturns information about a provisioned cluster operation.
" - }, - "ClusterOperationV2Serverless" : { - "type" : "structure", - "members" : { - "VpcConnectionInfo" : { - "shape" : "VpcConnectionInfoServerless", - "locationName" : "vpcConnectionInfo", - "documentation" : "\nDescription of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
" - } - }, - "documentation" : "\nReturns information about a serverless cluster operation.
" - }, - "ClusterOperationV2Summary" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nARN of the cluster.
" - }, - "ClusterType" : { - "shape" : "ClusterType", - "locationName" : "clusterType", - "documentation" : "\nType of the backend cluster.
" - }, - "StartTime" : { - "shape" : "__timestampIso8601", - "locationName" : "startTime", - "documentation" : "\nThe time at which operation was started.
" - }, - "EndTime" : { - "shape" : "__timestampIso8601", - "locationName" : "endTime", - "documentation" : "\nThe time at which the operation finished.
" - }, - "OperationArn" : { - "shape" : "__string", - "locationName" : "operationArn", - "documentation" : "\nARN of the cluster operation.
" - }, - "OperationState" : { - "shape" : "__string", - "locationName" : "operationState", - "documentation" : "\nState of the cluster operation.
" - }, - "OperationType" : { - "shape" : "__string", - "locationName" : "operationType", - "documentation" : "\nType of the cluster operation.
" - } + "ClusterOperationV2": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nARN of the cluster.
" + }, + "ClusterType": { + "shape": "ClusterType", + "locationName": "clusterType", + "documentation": "\nType of the backend cluster.
" + }, + "StartTime": { + "shape": "__timestampIso8601", + "locationName": "startTime", + "documentation": "\nThe time at which operation was started.
" + }, + "EndTime": { + "shape": "__timestampIso8601", + "locationName": "endTime", + "documentation": "\nThe time at which the operation finished.
" + }, + "ErrorInfo": { + "shape": "ErrorInfo", + "locationName": "errorInfo", + "documentation": "\nIf cluster operation failed from an error, it describes the error.
" + }, + "OperationArn": { + "shape": "__string", + "locationName": "operationArn", + "documentation": "\nARN of the cluster operation.
" + }, + "OperationState": { + "shape": "__string", + "locationName": "operationState", + "documentation": "\nState of the cluster operation.
" + }, + "OperationType": { + "shape": "__string", + "locationName": "operationType", + "documentation": "\nType of the cluster operation.
" + }, + "Provisioned": { + "shape": "ClusterOperationV2Provisioned", + "locationName": "provisioned", + "documentation": "\nProperties of a provisioned cluster.
" + }, + "Serverless": { + "shape": "ClusterOperationV2Serverless", + "locationName": "serverless", + "documentation": "\nProperties of a serverless cluster.
" + } + }, + "documentation": "\nReturns information about a cluster operation.
" + }, + "ClusterOperationV2Provisioned": { + "type": "structure", + "members": { + "OperationSteps": { + "shape": "__listOfClusterOperationStep", + "locationName": "operationSteps", + "documentation": "\nSteps completed during the operation.
" + }, + "SourceClusterInfo": { + "shape": "MutableClusterInfo", + "locationName": "sourceClusterInfo", + "documentation": "\nInformation about cluster attributes before a cluster is updated.
" + }, + "TargetClusterInfo": { + "shape": "MutableClusterInfo", + "locationName": "targetClusterInfo", + "documentation": "\nInformation about cluster attributes after a cluster is updated.
" + }, + "VpcConnectionInfo": { + "shape": "VpcConnectionInfo", + "locationName": "vpcConnectionInfo", + "documentation": "\nDescription of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
" + } + }, + "documentation": "\nReturns information about a provisioned cluster operation.
" + }, + "ClusterOperationV2Serverless": { + "type": "structure", + "members": { + "VpcConnectionInfo": { + "shape": "VpcConnectionInfoServerless", + "locationName": "vpcConnectionInfo", + "documentation": "\nDescription of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
" + } + }, + "documentation": "\nReturns information about a serverless cluster operation.
" + }, + "ClusterOperationV2Summary": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nARN of the cluster.
" + }, + "ClusterType": { + "shape": "ClusterType", + "locationName": "clusterType", + "documentation": "\nType of the backend cluster.
" + }, + "StartTime": { + "shape": "__timestampIso8601", + "locationName": "startTime", + "documentation": "\nThe time at which operation was started.
" + }, + "EndTime": { + "shape": "__timestampIso8601", + "locationName": "endTime", + "documentation": "\nThe time at which the operation finished.
" + }, + "OperationArn": { + "shape": "__string", + "locationName": "operationArn", + "documentation": "\nARN of the cluster operation.
" + }, + "OperationState": { + "shape": "__string", + "locationName": "operationState", + "documentation": "\nState of the cluster operation.
" + }, + "OperationType": { + "shape": "__string", + "locationName": "operationType", + "documentation": "\nType of the cluster operation.
" + } }, - "documentation" : "\nReturns information about a cluster operation.
" + "documentation": "\nReturns information about a cluster operation.
" }, "ControllerNodeInfo": { "type": "structure", @@ -3583,7 +3664,11 @@ "CustomerActionStatus": { "type": "string", "documentation": "\nA type of an action required from the customer.
", - "enum": [ "CRITICAL_ACTION_REQUIRED", "ACTION_RECOMMENDED", "NONE" ] + "enum": [ + "CRITICAL_ACTION_REQUIRED", + "ACTION_RECOMMENDED", + "NONE" + ] }, "DeleteClusterRequest": { "type": "structure", @@ -3684,7 +3769,9 @@ "documentation": "The Amazon Resource Name (ARN) of the replicator to be deleted.
" } }, - "required": ["ReplicatorArn"] + "required": [ + "ReplicatorArn" + ] }, "DeleteReplicatorResponse": { "type": "structure", @@ -3744,17 +3831,19 @@ "ClusterOperationArn" ] }, - "DescribeClusterOperationV2Request" : { - "type" : "structure", - "members" : { - "ClusterOperationArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterOperationArn", - "documentation" : "ARN of the cluster operation to describe." + "DescribeClusterOperationV2Request": { + "type": "structure", + "members": { + "ClusterOperationArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterOperationArn", + "documentation": "ARN of the cluster operation to describe." } }, - "required" : [ "ClusterOperationArn" ] + "required": [ + "ClusterOperationArn" + ] }, "DescribeClusterOperationResponse": { "type": "structure", @@ -3766,13 +3855,13 @@ } } }, - "DescribeClusterOperationV2Response" : { - "type" : "structure", - "members" : { - "ClusterOperationInfo" : { - "shape" : "ClusterOperationV2", - "locationName" : "clusterOperationInfo", - "documentation" : "\nCluster operation information
" + "DescribeClusterOperationV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfo": { + "shape": "ClusterOperationV2", + "locationName": "clusterOperationInfo", + "documentation": "\nCluster operation information
" } } }, @@ -3953,7 +4042,9 @@ "documentation": "The Amazon Resource Name (ARN) of the replicator to be described.
" } }, - "required": ["ReplicatorArn"] + "required": [ + "ReplicatorArn" + ] }, "DescribeReplicatorResponse": { "type": "structure", @@ -4057,19 +4148,16 @@ "shape": "__listOf__string", "locationName": "subnets", "documentation": "\nThe list of subnets for the VPC connection.
\n " - }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "\nThe list of security groups for the VPC connection.
\n " - }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe creation time of the VPC connection.
\n " - }, "Tags": { "shape": "__mapOf__string", @@ -4078,46 +4166,49 @@ } } }, - "BatchDisassociateScramSecretRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " - }, - "SecretArnList" : { - "shape" : "__listOf__string", - "locationName" : "secretArnList", - "documentation" : "\nList of AWS Secrets Manager secret ARNs.
\n " - } - }, - "documentation" : "\nDisassociates sasl scram secrets to cluster.
\n ", - "required" : [ "ClusterArn", "SecretArnList" ] - }, - "BatchDisassociateScramSecretResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " - }, - "UnprocessedScramSecrets" : { - "shape" : "__listOfUnprocessedScramSecret", - "locationName" : "unprocessedScramSecrets", - "documentation" : "\nList of errors when disassociating secrets to cluster.
\n " + "BatchDisassociateScramSecretRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " + }, + "SecretArnList": { + "shape": "__listOf__string", + "locationName": "secretArnList", + "documentation": "\nList of AWS Secrets Manager secret ARNs.
\n " + } + }, + "documentation": "\nDisassociates sasl scram secrets to cluster.
\n ", + "required": [ + "ClusterArn", + "SecretArnList" + ] + }, + "BatchDisassociateScramSecretResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + }, + "UnprocessedScramSecrets": { + "shape": "__listOfUnprocessedScramSecret", + "locationName": "unprocessedScramSecrets", + "documentation": "\nList of errors when disassociating secrets to cluster.
\n " } } }, "EBSStorageInfo": { "type": "structure", "members": { - "ProvisionedThroughput" : { - "shape" : "ProvisionedThroughput", - "locationName" : "provisionedThroughput", - "documentation" : "\nEBS volume provisioned throughput information.
\n " + "ProvisionedThroughput": { + "shape": "ProvisionedThroughput", + "locationName": "provisionedThroughput", + "documentation": "\nEBS volume provisioned throughput information.
\n " }, "VolumeSize": { "shape": "__integerMin1Max16384", @@ -4215,19 +4306,21 @@ }, "documentation": "\nReturns information about an error state of the cluster.
\n " }, - "Firehose" : { - "type" : "structure", - "members" : { - "DeliveryStream" : { - "shape" : "__string", - "locationName" : "deliveryStream" + "Firehose": { + "type": "structure", + "members": { + "DeliveryStream": { + "shape": "__string", + "locationName": "deliveryStream" }, - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled" + "Enabled": { + "shape": "__boolean", + "locationName": "enabled" } }, - "required" : [ "Enabled" ] + "required": [ + "Enabled" + ] }, "ForbiddenException": { "type": "structure", @@ -4318,23 +4411,23 @@ } } }, - "GetCompatibleKafkaVersionsRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "clusterArn", + "GetCompatibleKafkaVersionsRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "querystring", + "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster check.
\n " } } }, - "GetCompatibleKafkaVersionsResponse" : { - "type" : "structure", - "members" : { - "CompatibleKafkaVersions" : { - "shape" : "__listOfCompatibleKafkaVersion", - "locationName" : "compatibleKafkaVersions", + "GetCompatibleKafkaVersionsResponse": { + "type": "structure", + "members": { + "CompatibleKafkaVersions": { + "shape": "__listOfCompatibleKafkaVersion", + "locationName": "compatibleKafkaVersions", "documentation": "\nA list of CompatibleKafkaVersion objects.
\n " } } @@ -4365,7 +4458,6 @@ "shape": "__string", "locationName": "policy", "documentation": "\nThe cluster policy.
\n " - } } }, @@ -4404,24 +4496,29 @@ } }, "documentation": "Information about Kafka Cluster to be used as source / target for replication.
", - "required": ["VpcConfig", "AmazonMskCluster"] + "required": [ + "VpcConfig", + "AmazonMskCluster" + ] }, - "KafkaClusterClientVpcConfig" : { - "type" : "structure", - "members" : { - "SecurityGroupIds" : { - "shape" : "__listOf__string", - "locationName" : "securityGroupIds", - "documentation" : "The security groups to attach to the ENIs for the broker nodes.
" + "KafkaClusterClientVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "__listOf__string", + "locationName": "securityGroupIds", + "documentation": "The security groups to attach to the ENIs for the broker nodes.
" }, - "SubnetIds" : { - "shape" : "__listOf__string", - "locationName" : "subnetIds", - "documentation" : "The list of subnets in the client VPC to connect to.
" + "SubnetIds": { + "shape": "__listOf__string", + "locationName": "subnetIds", + "documentation": "The list of subnets in the client VPC to connect to.
" } }, - "documentation" : "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
", - "required" : [ "SubnetIds" ] + "documentation": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
", + "required": [ + "SubnetIds" + ] }, "KafkaClusterDescription": { "type": "structure", @@ -4506,29 +4603,31 @@ "ClusterArn" ] }, - "ListClusterOperationsV2Request" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "The arn of the cluster whose operations are being requested." + "ListClusterOperationsV2Request": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "The arn of the cluster whose operations are being requested." }, - "MaxResults" : { - "shape" : "MaxResults", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "The maxResults of the query." + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "The maxResults of the query." }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "The nextToken of the query." + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "The nextToken of the query." } }, - "required" : [ "ClusterArn" ] + "required": [ + "ClusterArn" + ] }, "ListClusterOperationsResponse": { "type": "structure", @@ -4545,18 +4644,18 @@ } } }, - "ListClusterOperationsV2Response" : { - "type" : "structure", - "members" : { - "ClusterOperationInfoList" : { - "shape" : "__listOfClusterOperationV2Summary", - "locationName" : "clusterOperationInfoList", - "documentation" : "\nAn array of cluster operation information objects.
" + "ListClusterOperationsV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfoList": { + "shape": "__listOfClusterOperationV2Summary", + "locationName": "clusterOperationInfoList", + "documentation": "\nAn array of cluster operation information objects.
" }, - "NextToken" : { - "shape" : "__string", - "locationName" : "nextToken", - "documentation" : "\nIf the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
" + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\nIf the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
" } } }, @@ -4824,42 +4923,44 @@ } } }, - "ListScramSecretsRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe arn of the cluster.
\n " - }, - "MaxResults" : { - "shape" : "MaxResults", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "\nThe maxResults of the query.
\n " - }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "\nThe nextToken of the query.
\n " - } - }, - "required" : [ "ClusterArn" ] - }, - "ListScramSecretsResponse" : { - "type" : "structure", - "members" : { - "NextToken" : { - "shape" : "__string", - "locationName" : "nextToken", - "documentation" : "\nPaginated results marker.
\n " - }, - "SecretArnList" : { - "shape" : "__listOf__string", - "locationName" : "secretArnList", - "documentation" : "\nThe list of scram secrets associated with the cluster.
\n " + "ListScramSecretsRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe arn of the cluster.
\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\nThe maxResults of the query.
\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\nThe nextToken of the query.
\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "ListScramSecretsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\nPaginated results marker.
\n " + }, + "SecretArnList": { + "shape": "__listOf__string", + "locationName": "secretArnList", + "documentation": "\nThe list of scram secrets associated with the cluster.
\n " } } }, @@ -4890,11 +4991,11 @@ "ListClientVpcConnectionsRequest": { "type": "structure", "members": { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "MaxResults": { "shape": "MaxResults", @@ -4909,14 +5010,16 @@ "documentation": "\nThe paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.
\n " } }, - "required": [ "ClusterArn" ] + "required": [ + "ClusterArn" + ] }, "ListClientVpcConnectionsResponse": { "type": "structure", "members": { - "ClientVpcConnections" : { - "shape" : "__listOfClientVpcConnection", - "locationName" : "clientVpcConnections", + "ClientVpcConnections": { + "shape": "__listOfClientVpcConnection", + "locationName": "clientVpcConnections", "documentation": "\nList of client VPC connections.
\n " }, "NextToken": { @@ -4946,9 +5049,9 @@ "ListVpcConnectionsResponse": { "type": "structure", "members": { - "VpcConnections" : { - "shape" : "__listOfVpcConnection", - "locationName" : "vpcConnections", + "VpcConnections": { + "shape": "__listOfVpcConnection", + "locationName": "vpcConnections", "documentation": "\nList of VPC connections.
\n " }, "NextToken": { @@ -4958,14 +5061,14 @@ } } }, - "RejectClientVpcConnectionRequest" : { - "type" : "structure", - "members" : { + "RejectClientVpcConnectionRequest": { + "type": "structure", + "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "VpcConnectionArn": { "shape": "__string", @@ -4973,9 +5076,12 @@ "documentation": "\nThe VPC connection ARN.
\n " } }, - "required" : [ "VpcConnectionArn", "ClusterArn" ] + "required": [ + "VpcConnectionArn", + "ClusterArn" + ] }, - "RejectClientVpcConnectionResponse" : { + "RejectClientVpcConnectionResponse": { "type": "structure", "members": { } @@ -4993,7 +5099,9 @@ "locationName": "brokerLogs" } }, - "required": [ "BrokerLogs" ] + "required": [ + "BrokerLogs" + ] }, "MutableClusterInfo": { "type": "structure", @@ -5013,189 +5121,201 @@ "locationName": "numberOfBrokerNodes", "documentation": "\nThe number of broker nodes in the cluster.
\n " }, - "EnhancedMonitoring" : { - "shape" : "EnhancedMonitoring", - "locationName" : "enhancedMonitoring", - "documentation" : "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " + "EnhancedMonitoring": { + "shape": "EnhancedMonitoring", + "locationName": "enhancedMonitoring", + "documentation": "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " }, - "OpenMonitoring" : { - "shape" : "OpenMonitoring", - "locationName" : "openMonitoring", - "documentation" : "\nThe settings for open monitoring.
\n " + "OpenMonitoring": { + "shape": "OpenMonitoring", + "locationName": "openMonitoring", + "documentation": "\nThe settings for open monitoring.
\n " }, - "KafkaVersion" : { - "shape" : "__string", - "locationName" : "kafkaVersion", - "documentation" : "\nThe Apache Kafka version.
\n " + "KafkaVersion": { + "shape": "__string", + "locationName": "kafkaVersion", + "documentation": "\nThe Apache Kafka version.
\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo", - "documentation" : "\nYou can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
\n " + "documentation": "\nYou can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
\n " }, "InstanceType": { - "shape" : "__stringMin5Max32", - "locationName" : "instanceType", - "documentation" : "\nInformation about the Amazon MSK broker type.
\n " + "shape": "__stringMin5Max32", + "locationName": "instanceType", + "documentation": "\nInformation about the Amazon MSK broker type.
\n " }, - "ClientAuthentication" : { - "shape" : "ClientAuthentication", - "locationName" : "clientAuthentication", + "ClientAuthentication": { + "shape": "ClientAuthentication", + "locationName": "clientAuthentication", "documentation": "\nIncludes all client authentication information.
\n " }, - "EncryptionInfo" : { - "shape" : "EncryptionInfo", - "locationName" : "encryptionInfo", + "EncryptionInfo": { + "shape": "EncryptionInfo", + "locationName": "encryptionInfo", "documentation": "\nIncludes all encryption-related information.
\n " }, - "ConnectivityInfo" : { - "shape" : "ConnectivityInfo", - "locationName" : "connectivityInfo", - "documentation" : "\nInformation about the broker access configuration.
\n " + "ConnectivityInfo": { + "shape": "ConnectivityInfo", + "locationName": "connectivityInfo", + "documentation": "\nInformation about the broker access configuration.
\n " }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nThis controls storage mode for supported storage tiers.
\n " + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nThis controls storage mode for supported storage tiers.
\n " }, - "BrokerCountUpdateInfo" : { + "BrokerCountUpdateInfo": { "shape": "BrokerCountUpdateInfo", - "locationName" : "brokerCountUpdateInfo", - "documentation" : "\nDescribes brokers being changed during a broker count update.
\n " + "locationName": "brokerCountUpdateInfo", + "documentation": "\nDescribes brokers being changed during a broker count update.
\n " } }, "documentation": "\nInformation about cluster attributes that can be updated via update APIs.
\n " }, - "NodeExporter" : { - "type" : "structure", - "members" : { - "EnabledInBroker" : { - "shape" : "__boolean", - "locationName" : "enabledInBroker", - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " + "NodeExporter": { + "type": "structure", + "members": { + "EnabledInBroker": { + "shape": "__boolean", + "locationName": "enabledInBroker", + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " } }, - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n ", - "required" : [ "EnabledInBroker" ] + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n ", + "required": [ + "EnabledInBroker" + ] }, - "NodeExporterInfo" : { - "type" : "structure", - "members" : { - "EnabledInBroker" : { - "shape" : "__boolean", - "locationName" : "enabledInBroker", - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " + "NodeExporterInfo": { + "type": "structure", + "members": { + "EnabledInBroker": { + "shape": "__boolean", + "locationName": "enabledInBroker", + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " } }, - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n ", - "required" : [ "EnabledInBroker" ] + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n ", + "required": [ + "EnabledInBroker" + ] }, - "JmxExporter" : { - "type" : "structure", - "members" : { - "EnabledInBroker" : { - "shape" : "__boolean", - "locationName" : "enabledInBroker", - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " + "JmxExporter": { + "type": "structure", + "members": { + "EnabledInBroker": { + "shape": "__boolean", + "locationName": "enabledInBroker", + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " } }, - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n ", - "required" : [ "EnabledInBroker" ] + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n ", + "required": [ + "EnabledInBroker" + ] }, - "JmxExporterInfo" : { - "type" : "structure", - "members" : { - "EnabledInBroker" : { - "shape" : "__boolean", - "locationName" : "enabledInBroker", - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " + "JmxExporterInfo": { + "type": "structure", + "members": { + "EnabledInBroker": { + "shape": "__boolean", + "locationName": "enabledInBroker", + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " } }, - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n ", - "required" : [ "EnabledInBroker" ] + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n ", + "required": [ + "EnabledInBroker" + ] }, - "OpenMonitoring" : { - "type" : "structure", - "members" : { - "Prometheus" : { - "shape" : "Prometheus", - "locationName" : "prometheus", - "documentation" : "\nPrometheus settings.
\n " + "OpenMonitoring": { + "type": "structure", + "members": { + "Prometheus": { + "shape": "Prometheus", + "locationName": "prometheus", + "documentation": "\nPrometheus settings.
\n " } }, - "documentation" : "\nJMX and Node monitoring for the MSK cluster.
\n ", - "required" : [ "Prometheus" ] + "documentation": "\nJMX and Node monitoring for the MSK cluster.
\n ", + "required": [ + "Prometheus" + ] }, - "OpenMonitoringInfo" : { - "type" : "structure", - "members" : { - "Prometheus" : { - "shape" : "PrometheusInfo", - "locationName" : "prometheus", - "documentation" : "\nPrometheus settings.
\n " + "OpenMonitoringInfo": { + "type": "structure", + "members": { + "Prometheus": { + "shape": "PrometheusInfo", + "locationName": "prometheus", + "documentation": "\nPrometheus settings.
\n " } }, - "documentation" : "\nJMX and Node monitoring for the MSK cluster.
\n ", - "required" : [ "Prometheus" ] + "documentation": "\nJMX and Node monitoring for the MSK cluster.
\n ", + "required": [ + "Prometheus" + ] }, - "Prometheus" : { - "type" : "structure", - "members" : { - "JmxExporter" : { - "shape" : "JmxExporter", - "locationName" : "jmxExporter", - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " + "Prometheus": { + "type": "structure", + "members": { + "JmxExporter": { + "shape": "JmxExporter", + "locationName": "jmxExporter", + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " }, - "NodeExporter" : { - "shape" : "NodeExporter", - "locationName" : "nodeExporter", - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " + "NodeExporter": { + "shape": "NodeExporter", + "locationName": "nodeExporter", + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " } }, - "documentation" : "\nPrometheus settings.
\n " + "documentation": "\nPrometheus settings.
\n " }, - "PrometheusInfo" : { - "type" : "structure", - "members" : { - "JmxExporter" : { - "shape" : "JmxExporterInfo", - "locationName" : "jmxExporter", - "documentation" : "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " + "PrometheusInfo": { + "type": "structure", + "members": { + "JmxExporter": { + "shape": "JmxExporterInfo", + "locationName": "jmxExporter", + "documentation": "\nIndicates whether you want to turn on or turn off the JMX Exporter.
\n " }, - "NodeExporter" : { - "shape" : "NodeExporterInfo", - "locationName" : "nodeExporter", - "documentation" : "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " + "NodeExporter": { + "shape": "NodeExporterInfo", + "locationName": "nodeExporter", + "documentation": "\nIndicates whether you want to turn on or turn off the Node Exporter.
\n " } }, - "documentation" : "\nPrometheus settings.
\n " + "documentation": "\nPrometheus settings.
\n " }, - "ProvisionedThroughput" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nProvisioned throughput is enabled or not.
\n " + "ProvisionedThroughput": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nProvisioned throughput is enabled or not.
\n " }, - "VolumeThroughput" : { - "shape" : "__integer", - "locationName" : "volumeThroughput", - "documentation" : "\nThroughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
\n " + "VolumeThroughput": { + "shape": "__integer", + "locationName": "volumeThroughput", + "documentation": "\nThroughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
\n " } }, - "documentation" : "\nContains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
\n " + "documentation": "\nContains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
\n " }, - "PublicAccess" : { - "type" : "structure", - "members" : { - "Type" : { - "shape" : "__string", - "locationName" : "type", - "documentation" : "\nThe value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
\n " + "PublicAccess": { + "type": "structure", + "members": { + "Type": { + "shape": "__string", + "locationName": "type", + "documentation": "\nThe value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
\n " } }, - "documentation" : "Public access control for brokers." + "documentation": "Public access control for brokers." }, "PutClusterPolicyRequest": { "type": "structure", @@ -5204,18 +5324,17 @@ "shape": "__string", "location": "uri", "locationName": "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", - "documentation" : "\nThe policy version.
\n " + "documentation": "\nThe policy version.
\n " }, "Policy": { "shape": "__string", "locationName": "policy", - "documentation" : "\nThe policy.
\n " - + "documentation": "\nThe policy.
\n " } }, "required": [ @@ -5229,147 +5348,152 @@ "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", - "documentation" : "\nThe policy version.
\n " + "documentation": "\nThe policy version.
\n " } } }, - "RebootBrokerRequest" : { - "type" : "structure", - "members" : { - "BrokerIds" : { - "shape" : "__listOf__string", - "locationName" : "brokerIds", - "documentation" : "\nThe list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
\n " - }, - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " - } - }, - "documentation" : "Reboots a node.", - "required" : [ "ClusterArn", "BrokerIds" ] - }, - "RebootBrokerResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " - }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " + "RebootBrokerRequest": { + "type": "structure", + "members": { + "BrokerIds": { + "shape": "__listOf__string", + "locationName": "brokerIds", + "documentation": "\nThe list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
\n " + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " + } + }, + "documentation": "Reboots a node.", + "required": [ + "ClusterArn", + "BrokerIds" + ] + }, + "RebootBrokerResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, - "S3" : { - "type" : "structure", - "members" : { - "Bucket" : { - "shape" : "__string", - "locationName" : "bucket" + "S3": { + "type": "structure", + "members": { + "Bucket": { + "shape": "__string", + "locationName": "bucket" }, - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled" + "Enabled": { + "shape": "__boolean", + "locationName": "enabled" }, - "Prefix" : { - "shape" : "__string", - "locationName" : "prefix" + "Prefix": { + "shape": "__string", + "locationName": "prefix" } }, - "required" : [ "Enabled" ] + "required": [ + "Enabled" + ] }, - "ServerlessSasl" : { - "type" : "structure", - "members" : { - "Iam" : { - "shape" : "Iam", - "locationName" : "iam", - "documentation" : "\nIndicates whether IAM access control is enabled.
\n " + "ServerlessSasl": { + "type": "structure", + "members": { + "Iam": { + "shape": "Iam", + "locationName": "iam", + "documentation": "\nIndicates whether IAM access control is enabled.
\n " } }, - "documentation" : "\nDetails for client authentication using SASL.
\n " + "documentation": "\nDetails for client authentication using SASL.
\n " }, - "Sasl" : { - "type" : "structure", - "members" : { - "Scram" : { - "shape" : "Scram", - "locationName" : "scram", - "documentation" : "\nDetails for SASL/SCRAM client authentication.
\n " + "Sasl": { + "type": "structure", + "members": { + "Scram": { + "shape": "Scram", + "locationName": "scram", + "documentation": "\nDetails for SASL/SCRAM client authentication.
\n " }, - "Iam" : { - "shape" : "Iam", - "locationName" : "iam", - "documentation" : "\nIndicates whether IAM access control is enabled.
\n " + "Iam": { + "shape": "Iam", + "locationName": "iam", + "documentation": "\nIndicates whether IAM access control is enabled.
\n " } }, - "documentation" : "\nDetails for client authentication using SASL.
\n " + "documentation": "\nDetails for client authentication using SASL.
\n " }, - "VpcConnectivitySasl" : { - "type" : "structure", - "members" : { - "Scram" : { - "shape" : "VpcConnectivityScram", - "locationName" : "scram", - "documentation" : "\nDetails for SASL/SCRAM client authentication for VPC connectivity.
\n " + "VpcConnectivitySasl": { + "type": "structure", + "members": { + "Scram": { + "shape": "VpcConnectivityScram", + "locationName": "scram", + "documentation": "\nDetails for SASL/SCRAM client authentication for VPC connectivity.
\n " }, - "Iam" : { - "shape" : "VpcConnectivityIam", - "locationName" : "iam", - "documentation" : "\nDetails for SASL/IAM client authentication for VPC connectivity.
\n " + "Iam": { + "shape": "VpcConnectivityIam", + "locationName": "iam", + "documentation": "\nDetails for SASL/IAM client authentication for VPC connectivity.
\n " } }, - "documentation" : "\nDetails for SASL client authentication for VPC connectivity.
\n " + "documentation": "\nDetails for SASL client authentication for VPC connectivity.
\n " }, - "Scram" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nSASL/SCRAM authentication is enabled or not.
\n " + "Scram": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nSASL/SCRAM authentication is enabled or not.
\n " } }, - "documentation" : "\nDetails for SASL/SCRAM client authentication.
\n " + "documentation": "\nDetails for SASL/SCRAM client authentication.
\n " }, - "VpcConnectivityScram" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nSASL/SCRAM authentication is on or off for VPC connectivity.
\n " + "VpcConnectivityScram": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nSASL/SCRAM authentication is on or off for VPC connectivity.
\n " } }, - "documentation" : "\nDetails for SASL/SCRAM client authentication for VPC connectivity.
\n " + "documentation": "\nDetails for SASL/SCRAM client authentication for VPC connectivity.
\n " }, - "Iam" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nIndicates whether IAM access control is enabled.
\n " + "Iam": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nIndicates whether IAM access control is enabled.
\n " } }, - "documentation" : "\nDetails for IAM access control.
\n " + "documentation": "\nDetails for IAM access control.
\n " }, - "VpcConnectivityIam" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nSASL/IAM authentication is on or off for VPC connectivity.
\n " + "VpcConnectivityIam": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nSASL/IAM authentication is on or off for VPC connectivity.
\n " } }, - "documentation" : "\nDetails for IAM access control for VPC connectivity.
\n " + "documentation": "\nDetails for IAM access control for VPC connectivity.
\n " }, "NodeInfo": { "type": "structure", @@ -5469,7 +5593,13 @@ } }, "documentation": "Specifies configuration for replication between a source and target Kafka cluster.
", - "required": ["TargetCompressionType", "TopicReplication", "ConsumerGroupReplication", "SourceKafkaClusterArn", "TargetKafkaClusterArn"] + "required": [ + "TargetCompressionType", + "TopicReplication", + "ConsumerGroupReplication", + "SourceKafkaClusterArn", + "TargetKafkaClusterArn" + ] }, "ReplicationInfoDescription": { "type": "structure", @@ -5518,42 +5648,70 @@ }, "documentation": "Summarized information of replication between clusters.
" }, - "ReplicationStartingPosition" : { - "type" : "structure", - "members" : { - "Type" : { - "shape" : "ReplicationStartingPositionType", - "locationName" : "type", + "ReplicationStartingPosition": { + "type": "structure", + "members": { + "Type": { + "shape": "ReplicationStartingPositionType", + "locationName": "type", "documentation": "The type of replication starting position.
" } }, "documentation": "Configuration for specifying the position in the topics to start replicating from.
" }, - "ReplicationStartingPositionType" : { - "type" : "string", - "enum" : [ "LATEST", "EARLIEST" ], + "ReplicationStartingPositionType": { + "type": "string", + "enum": [ + "LATEST", + "EARLIEST" + ], "documentation": "The type of replication starting position.
" }, - "ReplicationStateInfo" : { - "type" : "structure", - "members" : { - "Code" : { - "shape" : "__string", - "locationName" : "code", - "documentation" : "Code that describes the current state of the replicator." + "ReplicationTopicNameConfiguration": { + "type": "structure", + "members": { + "Type": { + "shape": "ReplicationTopicNameConfigurationType", + "locationName": "type", + "documentation": "The type of replicated topic name.
" + } + }, + "documentation": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
" + }, + "ReplicationTopicNameConfigurationType": { + "type": "string", + "enum": [ + "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS", + "IDENTICAL" + ], + "documentation": "The type of replicated topic name.
" + }, + "ReplicationStateInfo": { + "type": "structure", + "members": { + "Code": { + "shape": "__string", + "locationName": "code", + "documentation": "Code that describes the current state of the replicator." }, - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "Message that describes the state of the replicator." + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "Message that describes the state of the replicator." } }, - "documentation" : "Details about the state of a replicator" + "documentation": "Details about the state of a replicator" }, "ReplicatorState": { "type": "string", "documentation": "The state of a replicator.
", - "enum": ["RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"] + "enum": [ + "RUNNING", + "CREATING", + "UPDATING", + "DELETING", + "FAILED" + ] }, "ReplicatorSummary": { "type": "structure", @@ -5626,16 +5784,16 @@ "httpStatusCode": 503 } }, - "StateInfo" : { - "type" : "structure", - "members" : { - "Code" : { - "shape" : "__string", - "locationName" : "code" + "StateInfo": { + "type": "structure", + "members": { + "Code": { + "shape": "__string", + "locationName": "code" }, - "Message" : { - "shape" : "__string", - "locationName" : "message" + "Message": { + "shape": "__string", + "locationName": "message" } } }, @@ -5650,10 +5808,13 @@ }, "documentation": "\nContains information about storage volumes attached to MSK broker nodes.
\n " }, - "StorageMode" : { - "type" : "string", - "documentation" : "Controls storage mode for various supported storage tiers.", - "enum" : [ "LOCAL", "TIERED" ] + "StorageMode": { + "type": "string", + "documentation": "Controls storage mode for various supported storage tiers.", + "enum": [ + "LOCAL", + "TIERED" + ] }, "TagResourceRequest": { "type": "structure", @@ -5678,7 +5839,13 @@ "TargetCompressionType": { "type": "string", "documentation": "The type of compression to use producing records to the target cluster.
", - "enum": ["NONE", "GZIP", "SNAPPY", "LZ4", "ZSTD"] + "enum": [ + "NONE", + "GZIP", + "SNAPPY", + "LZ4", + "ZSTD" + ] }, "Tls": { "type": "structure", @@ -5688,10 +5855,10 @@ "locationName": "certificateAuthorityArnList", "documentation": "\nList of ACM Certificate Authority ARNs.
\n " }, - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nSpecifies whether you want to turn on or turn off TLS authentication.
\n " + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nSpecifies whether you want to turn on or turn off TLS authentication.
\n " } }, "documentation": "\nDetails for client authentication using TLS.
\n " @@ -5699,10 +5866,10 @@ "VpcConnectivityTls": { "type": "structure", "members": { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nTLS authentication is on or off for VPC connectivity.
\n " + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nTLS authentication is on or off for VPC connectivity.
\n " } }, "documentation": "\nDetails for TLS client authentication for VPC connectivity.
\n " @@ -5745,11 +5912,16 @@ "locationName": "detectAndCopyNewTopics", "documentation": "Whether to periodically check for new topics and partitions.
" }, - "StartingPosition" : { - "shape" : "ReplicationStartingPosition", - "locationName" : "startingPosition", + "StartingPosition": { + "shape": "ReplicationStartingPosition", + "locationName": "startingPosition", "documentation": "Configuration for specifying the position in the topics to start replicating from.
" }, + "TopicNameConfiguration": { + "shape": "ReplicationTopicNameConfiguration", + "locationName": "topicNameConfiguration", + "documentation": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
" + }, "TopicsToExclude": { "shape": "__listOf__stringMax249", "locationName": "topicsToExclude", @@ -5762,7 +5934,9 @@ } }, "documentation": "Details about topic replication.
", - "required": ["TopicsToReplicate"] + "required": [ + "TopicsToReplicate" + ] }, "TopicReplicationUpdate": { "type": "structure", @@ -5794,15 +5968,21 @@ } }, "documentation": "Details for updating the topic replication of a replicator.
", - "required": ["TopicsToReplicate", "TopicsToExclude", "CopyTopicConfigurations", "DetectAndCopyNewTopics", "CopyAccessControlListsForTopics"] + "required": [ + "TopicsToReplicate", + "TopicsToExclude", + "CopyTopicConfigurations", + "DetectAndCopyNewTopics", + "CopyAccessControlListsForTopics" + ] }, - "Unauthenticated" : { - "type" : "structure", - "members" : { - "Enabled" : { - "shape" : "__boolean", - "locationName" : "enabled", - "documentation" : "\nSpecifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
\n " + "Unauthenticated": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "locationName": "enabled", + "documentation": "\nSpecifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
\n " } } }, @@ -5826,26 +6006,26 @@ "httpStatusCode": 401 } }, - "UnprocessedScramSecret" : { - "type" : "structure", - "members" : { - "ErrorCode" : { - "shape" : "__string", - "locationName" : "errorCode", - "documentation" : "\nError code for associate/disassociate failure.
\n " + "UnprocessedScramSecret": { + "type": "structure", + "members": { + "ErrorCode": { + "shape": "__string", + "locationName": "errorCode", + "documentation": "\nError code for associate/disassociate failure.
\n " }, - "ErrorMessage" : { - "shape" : "__string", - "locationName" : "errorMessage", - "documentation" : "\nError message for associate/disassociate failure.
\n " + "ErrorMessage": { + "shape": "__string", + "locationName": "errorMessage", + "documentation": "\nError message for associate/disassociate failure.
\n " }, - "SecretArn" : { - "shape" : "__string", - "locationName" : "secretArn", - "documentation" : "\nAWS Secrets Manager secret ARN.
\n " + "SecretArn": { + "shape": "__string", + "locationName": "secretArn", + "documentation": "\nAWS Secrets Manager secret ARN.
\n " } }, - "documentation" : "\nError info for scram secret associate/disassociate failure.
\n " + "documentation": "\nError info for scram secret associate/disassociate failure.
\n " }, "UntagResourceRequest": { "type": "structure", @@ -6032,92 +6212,99 @@ } } }, - "UpdateClusterKafkaVersionRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " - }, - "ConfigurationInfo" : { - "shape" : "ConfigurationInfo", - "locationName" : "configurationInfo", + "UpdateClusterKafkaVersionRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " + }, + "ConfigurationInfo": { + "shape": "ConfigurationInfo", + "locationName": "configurationInfo", "documentation": "\nThe custom configuration that should be applied on the new version of cluster.
\n " }, - "CurrentVersion" : { - "shape" : "__string", - "locationName" : "currentVersion", + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", "documentation": "\nCurrent cluster version.
\n " }, - "TargetKafkaVersion" : { - "shape" : "__string", - "locationName" : "targetKafkaVersion" - ,"documentation": "\nTarget Kafka version.
\n " + "TargetKafkaVersion": { + "shape": "__string", + "locationName": "targetKafkaVersion", + "documentation": "\nTarget Kafka version.
\n " } }, - "required" : [ "ClusterArn", "TargetKafkaVersion", "CurrentVersion" ] + "required": [ + "ClusterArn", + "TargetKafkaVersion", + "CurrentVersion" + ] }, - "UpdateClusterKafkaVersionResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", + "UpdateClusterKafkaVersionResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, - "UpdateMonitoringRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " - }, - "CurrentVersion" : { - "shape" : "__string", - "locationName" : "currentVersion", - "documentation" : "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " - }, - "EnhancedMonitoring" : { - "shape" : "EnhancedMonitoring", - "locationName" : "enhancedMonitoring", - "documentation" : "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " - }, - "OpenMonitoring" : { - "shape" : "OpenMonitoringInfo", - "locationName" : "openMonitoring", - "documentation" : "\nThe settings for open monitoring.
\n " + "UpdateMonitoringRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " + }, + "EnhancedMonitoring": { + "shape": "EnhancedMonitoring", + "locationName": "enhancedMonitoring", + "documentation": "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " + }, + "OpenMonitoring": { + "shape": "OpenMonitoringInfo", + "locationName": "openMonitoring", + "documentation": "\nThe settings for open monitoring.
\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo" } }, - "documentation" : "Request body for UpdateMonitoring.", - "required" : [ "ClusterArn", "CurrentVersion" ] + "documentation": "Request body for UpdateMonitoring.", + "required": [ + "ClusterArn", + "CurrentVersion" + ] }, - "UpdateMonitoringResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + "UpdateMonitoringResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, @@ -6157,7 +6344,12 @@ } }, "documentation": "Update information relating to replication between a given source and target Kafka cluster.
", - "required": ["ReplicatorArn", "SourceKafkaClusterArn", "CurrentVersion", "TargetKafkaClusterArn"] + "required": [ + "ReplicatorArn", + "SourceKafkaClusterArn", + "CurrentVersion", + "TargetKafkaClusterArn" + ] }, "UpdateReplicationInfoResponse": { "type": "structure", @@ -6174,93 +6366,99 @@ } } }, - "UpdateSecurityRequest" : { - "type" : "structure", - "members" : { - "ClientAuthentication" : { - "shape" : "ClientAuthentication", - "locationName" : "clientAuthentication", - "documentation" : "\nIncludes all client authentication related information.
\n " - }, - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " - }, - "CurrentVersion" : { - "shape" : "__string", - "locationName" : "currentVersion", - "documentation" : "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " - }, - "EncryptionInfo" : { - "shape" : "EncryptionInfo", - "locationName" : "encryptionInfo", - "documentation" : "\nIncludes all encryption-related information.
\n " - } - }, - "required" : [ "ClusterArn", "CurrentVersion" ] - }, - "UpdateSecurityResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " - }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " + "UpdateSecurityRequest": { + "type": "structure", + "members": { + "ClientAuthentication": { + "shape": "ClientAuthentication", + "locationName": "clientAuthentication", + "documentation": "\nIncludes all client authentication related information.
\n " + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " + }, + "EncryptionInfo": { + "shape": "EncryptionInfo", + "locationName": "encryptionInfo", + "documentation": "\nIncludes all encryption-related information.
\n " + } + }, + "required": [ + "ClusterArn", + "CurrentVersion" + ] + }, + "UpdateSecurityResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, - "UpdateStorageRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " - }, - "CurrentVersion" : { - "shape" : "__string", - "locationName" : "currentVersion", - "documentation" : "\nThe version of cluster to update from. A successful operation will then generate a new version.
\n " - }, - "ProvisionedThroughput" : { - "shape" : "ProvisionedThroughput", - "locationName" : "provisionedThroughput", - "documentation" : "\nEBS volume provisioned throughput information.
\n " - }, - "StorageMode" : { - "shape" : "StorageMode", - "locationName" : "storageMode", - "documentation" : "\nControls storage mode for supported storage tiers.
\n " - }, - "VolumeSizeGB" : { - "shape" : "__integer", - "locationName" : "volumeSizeGB", - "documentation" : "\nsize of the EBS volume to update.
\n " - } - }, - "documentation" : "\nRequest object for UpdateStorage api. Its used to update the storage attributes for the cluster.
\n ", - "required" : [ "ClusterArn", "CurrentVersion" ] - }, - "UpdateStorageResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " - }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " + "UpdateStorageRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster to be updated.
\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\nThe version of cluster to update from. A successful operation will then generate a new version.
\n " + }, + "ProvisionedThroughput": { + "shape": "ProvisionedThroughput", + "locationName": "provisionedThroughput", + "documentation": "\nEBS volume provisioned throughput information.
\n " + }, + "StorageMode": { + "shape": "StorageMode", + "locationName": "storageMode", + "documentation": "\nControls storage mode for supported storage tiers.
\n " + }, + "VolumeSizeGB": { + "shape": "__integer", + "locationName": "volumeSizeGB", + "documentation": "\nsize of the EBS volume to update.
\n " + } + }, + "documentation": "\nRequest object for UpdateStorage api. Its used to update the storage attributes for the cluster.
\n ", + "required": [ + "ClusterArn", + "CurrentVersion" + ] + }, + "UpdateStorageResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, @@ -6269,7 +6467,7 @@ "members": { "Arn": { "shape": "__string", - "location" : "uri", + "location": "uri", "locationName": "arn", "documentation": "\nThe Amazon Resource Name (ARN) of the configuration.
\n " }, @@ -6304,41 +6502,45 @@ } } }, - "UpdateConnectivityRequest" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "clusterArn", + "UpdateConnectivityRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the configuration.
\n " }, - "ConnectivityInfo" : { - "shape" : "ConnectivityInfo", - "locationName" : "connectivityInfo", - "documentation" : "\nInformation about the broker access configuration.
\n " + "ConnectivityInfo": { + "shape": "ConnectivityInfo", + "locationName": "connectivityInfo", + "documentation": "\nInformation about the broker access configuration.
\n " }, - "CurrentVersion" : { - "shape" : "__string", - "locationName" : "currentVersion", - "documentation" : "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\nThe version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
\n " } }, - "documentation" : "Request body for UpdateConnectivity.", - "required" : [ "ClusterArn", "ConnectivityInfo", "CurrentVersion" ] + "documentation": "Request body for UpdateConnectivity.", + "required": [ + "ClusterArn", + "ConnectivityInfo", + "CurrentVersion" + ] }, - "UpdateConnectivityResponse" : { - "type" : "structure", - "members" : { - "ClusterArn" : { - "shape" : "__string", - "locationName" : "clusterArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " + "UpdateConnectivityResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, - "ClusterOperationArn" : { - "shape" : "__string", - "locationName" : "clusterOperationArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, @@ -6348,15 +6550,15 @@ "Type": { "shape": "UserIdentityType", "locationName": "type", - "documentation" : "\nThe identity type of the requester that calls the API operation.
\n " + "documentation": "\nThe identity type of the requester that calls the API operation.
\n " }, "PrincipalId": { "shape": "__string", "locationName": "principalId", - "documentation" : "\nA unique identifier for the requester that calls the API operation.
\n " + "documentation": "\nA unique identifier for the requester that calls the API operation.
\n " } }, - "documentation" : "\nDescription of the requester that calls the API operation.
\n " + "documentation": "\nDescription of the requester that calls the API operation.
\n " }, "UserIdentityType": { "type": "string", @@ -6372,51 +6574,51 @@ "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the VPC connection.
\n " + "documentation": "\nThe Amazon Resource Name (ARN) of the VPC connection.
\n " }, "Owner": { "shape": "__string", "locationName": "owner", - "documentation" : "\nThe owner of the VPC Connection.
\n " + "documentation": "\nThe owner of the VPC Connection.
\n " }, "UserIdentity": { "shape": "UserIdentity", "locationName": "userIdentity", - "documentation" : "\nDescription of the requester that calls the API operation.
\n " + "documentation": "\nDescription of the requester that calls the API operation.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", - "documentation" : "\nThe time when Amazon MSK creates the VPC Connnection.
\n " + "documentation": "\nThe time when Amazon MSK creates the VPC Connnection.
\n " } }, "documentation": "\nDescription of the VPC connection.
\n " }, - "VpcConnectionInfoServerless" : { - "type" : "structure", - "members" : { - "CreationTime" : { - "shape" : "__timestampIso8601", - "locationName" : "creationTime", - "documentation" : "\nThe time when Amazon MSK creates the VPC Connnection.
" + "VpcConnectionInfoServerless": { + "type": "structure", + "members": { + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\nThe time when Amazon MSK creates the VPC Connnection.
" }, - "Owner" : { - "shape" : "__string", - "locationName" : "owner", - "documentation" : "\nThe owner of the VPC Connection.
" + "Owner": { + "shape": "__string", + "locationName": "owner", + "documentation": "\nThe owner of the VPC Connection.
" }, - "UserIdentity" : { - "shape" : "UserIdentity", - "locationName" : "userIdentity", - "documentation" : "\nDescription of the requester that calls the API operation.
" + "UserIdentity": { + "shape": "UserIdentity", + "locationName": "userIdentity", + "documentation": "\nDescription of the requester that calls the API operation.
" }, - "VpcConnectionArn" : { - "shape" : "__string", - "locationName" : "vpcConnectionArn", - "documentation" : "\nThe Amazon Resource Name (ARN) of the VPC connection.
" + "VpcConnectionArn": { + "shape": "__string", + "locationName": "vpcConnectionArn", + "documentation": "\nThe Amazon Resource Name (ARN) of the VPC connection.
" } }, - "documentation" : "Description of the VPC connection." + "documentation": "Description of the VPC connection." }, "VpcConnectionState": { "type": "string", @@ -6432,16 +6634,16 @@ "REJECTING" ] }, - "VpcConnectivity" : { - "type" : "structure", - "members" : { + "VpcConnectivity": { + "type": "structure", + "members": { "ClientAuthentication": { "shape": "VpcConnectivityClientAuthentication", "locationName": "clientAuthentication", "documentation": "\nIncludes all client authentication information for VPC connectivity.
\n " } }, - "documentation" : "VPC connectivity access control for brokers." + "documentation": "VPC connectivity access control for brokers." }, "ZookeeperNodeInfo": { "type": "structure", @@ -6520,28 +6722,28 @@ "shape": "ClusterOperationInfo" } }, - "__listOfClusterOperationV2Summary" : { - "type" : "list", - "member" : { - "shape" : "ClusterOperationV2Summary" + "__listOfClusterOperationV2Summary": { + "type": "list", + "member": { + "shape": "ClusterOperationV2Summary" } }, - "__listOfClusterOperationStep" : { - "type" : "list", - "member" : { - "shape" : "ClusterOperationStep" + "__listOfClusterOperationStep": { + "type": "list", + "member": { + "shape": "ClusterOperationStep" } }, - "__listOfCompatibleKafkaVersion" : { - "type" : "list", - "member" : { - "shape" : "CompatibleKafkaVersion" + "__listOfCompatibleKafkaVersion": { + "type": "list", + "member": { + "shape": "CompatibleKafkaVersion" } }, - "__listOfVpcConfig" : { - "type" : "list", - "member" : { - "shape" : "VpcConfig" + "__listOfVpcConfig": { + "type": "list", + "member": { + "shape": "VpcConfig" } }, "__listOfConfiguration": { @@ -6622,16 +6824,16 @@ "shape": "VpcConnection" } }, - "__listOfUnprocessedScramSecret" : { - "type" : "list", - "member" : { - "shape" : "UnprocessedScramSecret" + "__listOfUnprocessedScramSecret": { + "type": "list", + "member": { + "shape": "UnprocessedScramSecret" } }, - "__listOf__double" : { - "type" : "list", - "member" : { - "shape" : "__double" + "__listOf__double": { + "type": "list", + "member": { + "shape": "__double" } }, "__listOf__string": { @@ -6710,4 +6912,4 @@ } }, "documentation": "\nThe operations for managing an Amazon MSK cluster.
\n " -} +} \ No newline at end of file diff --git a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json index 55bdb9d6f1..dcb227bae2 100644 --- a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json +++ b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"runtime.sagemaker", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon SageMaker Runtime", "serviceId":"SageMaker Runtime", "signatureVersion":"v4", "signingName":"sagemaker", - "uid":"runtime.sagemaker-2017-05-13" + "uid":"runtime.sagemaker-2017-05-13", + "auth":["aws.auth#sigv4"] }, "operations":{ "InvokeEndpoint":{ @@ -296,6 +298,12 @@ "documentation":"If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
", "location":"header", "locationName":"X-Amzn-SageMaker-Inference-Component" + }, + "SessionId":{ + "shape":"SessionIdOrNewSessionConstantHeader", + "documentation":"Creates a stateful session or identifies an existing one. You can do one of the following:
Create a stateful session by specifying the value NEW_SESSION
.
Send your request to an existing stateful session by specifying the ID of that session.
With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the NewSessionId
response parameter. For any subsequent request where you specify that session ID, SageMaker routes the request to the same instance that supports the session.
Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes
header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.
The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID:
in your post-processing function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
", "location":"header", "locationName":"X-Amzn-SageMaker-Custom-Attributes" + }, + "NewSessionId":{ + "shape":"NewSessionResponseHeader", + "documentation":"If you created a stateful session with your request, the ID and expiration time that the model assigns to that session.
", + "location":"header", + "locationName":"X-Amzn-SageMaker-New-Session-Id" + }, + "ClosedSessionId":{ + "shape":"SessionIdHeader", + "documentation":"If you closed a stateful session with your request, the ID of that session.
", + "location":"header", + "locationName":"X-Amzn-SageMaker-Closed-Session-Id" } }, "payload":"Body" @@ -387,6 +407,12 @@ "documentation":"If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response.
", "location":"header", "locationName":"X-Amzn-SageMaker-Inference-Component" + }, + "SessionId":{ + "shape":"SessionIdHeader", + "documentation":"The ID of a stateful session to handle your request.
You can't create a stateful session by using the InvokeEndpointWithResponseStream
action. Instead, you can create one by using the InvokeEndpoint
action. In your request, you specify NEW_SESSION
for the SessionId
request parameter. The response to that request provides the session ID for the NewSessionId
response parameter.
Details of LifeCycle configuration for the instance group.
" }, "ExecutionRole":{ - "shape":"IAMRoleArn", + "shape":"RoleArn", "documentation":"The execution role for the instance group to assume.
" }, "ThreadsPerCore":{ @@ -7266,6 +7266,10 @@ "InstanceStorageConfigs":{ "shape":"ClusterInstanceStorageConfigs", "documentation":"The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
" + }, + "OnStartDeepHealthChecks":{ + "shape":"OnStartDeepHealthChecks", + "documentation":"A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
" } }, "documentation":"Details of an instance group in a SageMaker HyperPod cluster.
" @@ -7307,7 +7311,7 @@ "documentation":"Specifies the LifeCycle configuration for the instance group.
" }, "ExecutionRole":{ - "shape":"IAMRoleArn", + "shape":"RoleArn", "documentation":"Specifies an IAM execution role to be assumed by the instance group.
" }, "ThreadsPerCore":{ @@ -7317,6 +7321,10 @@ "InstanceStorageConfigs":{ "shape":"ClusterInstanceStorageConfigs", "documentation":"Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
" + }, + "OnStartDeepHealthChecks":{ + "shape":"OnStartDeepHealthChecks", + "documentation":"A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
" } }, "documentation":"The specifications of an instance group that you need to define.
" @@ -7348,7 +7356,8 @@ "Failure", "Pending", "ShuttingDown", - "SystemUpdating" + "SystemUpdating", + "DeepHealthCheckInProgress" ] }, "ClusterInstanceStatusDetails":{ @@ -7516,6 +7525,13 @@ "min":1, "pattern":"^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" }, + "ClusterNodeRecovery":{ + "type":"string", + "enum":[ + "Automatic", + "None" + ] + }, "ClusterNodeSummaries":{ "type":"list", "member":{"shape":"ClusterNodeSummary"} @@ -7557,6 +7573,28 @@ "type":"integer", "min":0 }, + "ClusterOrchestrator":{ + "type":"structure", + "required":["Eks"], + "members":{ + "Eks":{ + "shape":"ClusterOrchestratorEksConfig", + "documentation":"The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
" + } + }, + "documentation":"The type of orchestrator used for the SageMaker HyperPod cluster.
" + }, + "ClusterOrchestratorEksConfig":{ + "type":"structure", + "required":["ClusterArn"], + "members":{ + "ClusterArn":{ + "shape":"EksClusterArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
" + } + }, + "documentation":"The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
" + }, "ClusterPrivateDnsHostname":{ "type":"string", "pattern":"^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" @@ -7643,7 +7681,7 @@ }, "AppLifecycleManagement":{ "shape":"AppLifecycleManagement", - "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
" + "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
" } }, "documentation":"The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
" @@ -8620,6 +8658,14 @@ "Tags":{ "shape":"TagList", "documentation":"Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
" + }, + "Orchestrator":{ + "shape":"ClusterOrchestrator", + "documentation":"The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is \"eks\"
, which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic
, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None
, cluster administrators will need to manually manage any faulty cluster instances.
The instance groups of the SageMaker HyperPod cluster.
" }, - "VpcConfig":{"shape":"VpcConfig"} + "VpcConfig":{"shape":"VpcConfig"}, + "Orchestrator":{ + "shape":"ClusterOrchestrator", + "documentation":"The type of orchestrator used for the SageMaker HyperPod cluster.
" + }, + "NodeRecovery":{ + "shape":"ClusterNodeRecovery", + "documentation":"The node recovery mode configured for the SageMaker HyperPod cluster.
" + } } }, "DescribeCodeRepositoryInput":{ @@ -18055,6 +18116,12 @@ "max":10, "pattern":"\\d+" }, + "EksClusterArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" + }, "EmrServerlessComputeConfig":{ "type":"structure", "required":["ExecutionRoleARN"], @@ -20832,12 +20899,6 @@ "type":"integer", "min":1 }, - "IAMRoleArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/[\\w+=,.@-]{1,64}$" - }, "IamIdentity":{ "type":"structure", "members":{ @@ -30091,6 +30152,12 @@ }, "documentation":"A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups
, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
Specify the instance groups to update.
" + }, + "NodeRecovery":{ + "shape":"ClusterNodeRecovery", + "documentation":"The node recovery mode to be applied to the SageMaker HyperPod cluster.
" } } }, diff --git a/docs/source/conf.py b/docs/source/conf.py index 9b50a1b776..74a9229505 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.14' +release = '1.35.15' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.