From 200c12672fc18dbdc743f2d2ee547449e6d57ae4 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 Feb 2024 19:14:30 +0000 Subject: [PATCH] feat(client-ssm): This release adds support for sharing Systems Manager parameters with other AWS accounts. --- .../commands/DeleteResourcePolicyCommand.ts | 30 +++- .../src/commands/DescribeParametersCommand.ts | 9 +- .../commands/GetParameterHistoryCommand.ts | 4 +- .../commands/GetResourcePoliciesCommand.ts | 3 + .../src/commands/PutResourcePolicyCommand.ts | 43 ++++- .../StopAutomationExecutionCommand.ts | 2 +- .../src/commands/TerminateSessionCommand.ts | 3 +- clients/client-ssm/src/models/models_0.ts | 153 ++++++++-------- clients/client-ssm/src/models/models_1.ts | 170 +++++++++++++----- clients/client-ssm/src/models/models_2.ts | 49 ++++- .../client-ssm/src/protocols/Aws_json1_1.ts | 75 +++++++- codegen/sdk-codegen/aws-models/ssm.json | 124 ++++++++++--- 12 files changed, 497 insertions(+), 168 deletions(-) diff --git a/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts index 84c595d2b900..4a6c3d91dee5 100644 --- a/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts @@ -28,10 +28,22 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR /** * @public - *

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, - * OpsItemGroup is the only resource that supports Systems Manager resource policies. The - * resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with - * OpsCenter operational work items (OpsItems).

+ *

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following + * resources support Systems Manager resource policies.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -58,6 +70,13 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* + * @throws {@link MalformedResourcePolicyDocumentException} (client fault) + *

The specified policy document is malformed or invalid, or excessive + * PutResourcePolicy or DeleteResourcePolicy calls have been made.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified parameter to be shared could not be found.

+ * * @throws {@link ResourcePolicyConflictException} (client fault) *

The hash provided in the call doesn't match the stored hash. This exception is thrown when * trying to update an obsolete policy version or when multiple requests to update a policy are @@ -67,6 +86,9 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR *

One or more parameters specified for the call aren't valid. Verify the parameters and their * values and try again.

* + * @throws {@link ResourcePolicyNotFoundException} (client fault) + *

No policies with the specified policy ID and hash could be found.

+ * * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* diff --git a/clients/client-ssm/src/commands/DescribeParametersCommand.ts b/clients/client-ssm/src/commands/DescribeParametersCommand.ts index a761cc3c31a7..b655a412b0b3 100644 --- a/clients/client-ssm/src/commands/DescribeParametersCommand.ts +++ b/clients/client-ssm/src/commands/DescribeParametersCommand.ts @@ -28,7 +28,8 @@ export interface DescribeParametersCommandOutput extends DescribeParametersResul /** * @public - *

Get information about a parameter.

+ *

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable + * the Shared option.

*

Request results are returned on a best-effort basis. If you specify MaxResults * in the request, the response includes information up to the limit specified. The number of items * returned, however, can be between zero and the value of MaxResults. If the service @@ -36,8 +37,8 @@ export interface DescribeParametersCommandOutput extends DescribeParametersResul * matching values up to that point and a NextToken. You can specify the * NextToken in a subsequent call to get the next set of results.

* - *

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must - * also update the key alias the parameter uses to reference KMS. Otherwise, + *

If you change the KMS key alias for the KMS key used to encrypt a parameter, + * then you must also update the key alias the parameter uses to reference KMS. Otherwise, * DescribeParameters retrieves whatever the original key alias was * referencing.

* @@ -67,6 +68,7 @@ export interface DescribeParametersCommandOutput extends DescribeParametersResul * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", + * Shared: true || false, * }; * const command = new DescribeParametersCommand(input); * const response = await client.send(command); @@ -74,6 +76,7 @@ export interface DescribeParametersCommandOutput extends DescribeParametersResul * // Parameters: [ // ParameterMetadataList * // { // ParameterMetadata * // Name: "STRING_VALUE", + * // ARN: "STRING_VALUE", * // Type: "String" || "StringList" || "SecureString", * // KeyId: "STRING_VALUE", * // LastModifiedDate: new Date("TIMESTAMP"), diff --git a/clients/client-ssm/src/commands/GetParameterHistoryCommand.ts b/clients/client-ssm/src/commands/GetParameterHistoryCommand.ts index ff36f695e8fa..d17632518f51 100644 --- a/clients/client-ssm/src/commands/GetParameterHistoryCommand.ts +++ b/clients/client-ssm/src/commands/GetParameterHistoryCommand.ts @@ -34,8 +34,8 @@ export interface GetParameterHistoryCommandOutput extends GetParameterHistoryRes * @public *

Retrieves the history of all changes to a parameter.

* - *

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must - * also update the key alias the parameter uses to reference KMS. Otherwise, + *

If you change the KMS key alias for the KMS key used to encrypt a parameter, + * then you must also update the key alias the parameter uses to reference KMS. Otherwise, * GetParameterHistory retrieves whatever the original key alias was * referencing.

* diff --git a/clients/client-ssm/src/commands/GetResourcePoliciesCommand.ts b/clients/client-ssm/src/commands/GetResourcePoliciesCommand.ts index 2ef2048d0ae2..fa19b5750a24 100644 --- a/clients/client-ssm/src/commands/GetResourcePoliciesCommand.ts +++ b/clients/client-ssm/src/commands/GetResourcePoliciesCommand.ts @@ -64,6 +64,9 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesRes * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified parameter to be shared could not be found.

+ * * @throws {@link ResourcePolicyInvalidParameterException} (client fault) *

One or more parameters specified for the call aren't valid. Verify the parameters and their * values and try again.

diff --git a/clients/client-ssm/src/commands/PutResourcePolicyCommand.ts b/clients/client-ssm/src/commands/PutResourcePolicyCommand.ts index 650366a185cf..22d9e967f056 100644 --- a/clients/client-ssm/src/commands/PutResourcePolicyCommand.ts +++ b/clients/client-ssm/src/commands/PutResourcePolicyCommand.ts @@ -30,9 +30,36 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons * @public *

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the * IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. - * Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. - * The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact - * with OpsCenter operational work items (OpsItems).

+ * The following resources support Systems Manager resource policies.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,6 +90,13 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* + * @throws {@link MalformedResourcePolicyDocumentException} (client fault) + *

The specified policy document is malformed or invalid, or excessive + * PutResourcePolicy or DeleteResourcePolicy calls have been made.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified parameter to be shared could not be found.

+ * * @throws {@link ResourcePolicyConflictException} (client fault) *

The hash provided in the call doesn't match the stored hash. This exception is thrown when * trying to update an obsolete policy version or when multiple requests to update a policy are @@ -77,6 +111,9 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons * greater than 1024 bytes in size. And only one policy can be attached to * OpsItemGroup. Verify these limits and try again.

* + * @throws {@link ResourcePolicyNotFoundException} (client fault) + *

No policies with the specified policy ID and hash could be found.

+ * * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* diff --git a/clients/client-ssm/src/commands/StopAutomationExecutionCommand.ts b/clients/client-ssm/src/commands/StopAutomationExecutionCommand.ts index 31373a45bcca..91b4e1dcc4cb 100644 --- a/clients/client-ssm/src/commands/StopAutomationExecutionCommand.ts +++ b/clients/client-ssm/src/commands/StopAutomationExecutionCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StopAutomationExecutionRequest, StopAutomationExecutionResult } from "../models/models_1"; +import { StopAutomationExecutionRequest, StopAutomationExecutionResult } from "../models/models_2"; import { de_StopAutomationExecutionCommand, se_StopAutomationExecutionCommand } from "../protocols/Aws_json1_1"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; diff --git a/clients/client-ssm/src/commands/TerminateSessionCommand.ts b/clients/client-ssm/src/commands/TerminateSessionCommand.ts index d2a15896abe1..0f848fef4b8b 100644 --- a/clients/client-ssm/src/commands/TerminateSessionCommand.ts +++ b/clients/client-ssm/src/commands/TerminateSessionCommand.ts @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { TerminateSessionRequest } from "../models/models_1"; -import { TerminateSessionResponse } from "../models/models_2"; +import { TerminateSessionRequest, TerminateSessionResponse } from "../models/models_2"; import { de_TerminateSessionCommand, se_TerminateSessionCommand } from "../protocols/Aws_json1_1"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; diff --git a/clients/client-ssm/src/models/models_0.ts b/clients/client-ssm/src/models/models_0.ts index 6b745318f691..2a860b4df6c2 100644 --- a/clients/client-ssm/src/models/models_0.ts +++ b/clients/client-ssm/src/models/models_0.ts @@ -2269,8 +2269,8 @@ export interface DocumentRequires { /** * @public *

An optional field specifying the version of the artifact associated with the document. For - * example, 12.6. This value is unique across all versions of a document, and - * can't be changed.

+ * example, 12.6. This value is unique across all versions of a document, and can't be + * changed.

*/ VersionName?: string; } @@ -4650,6 +4650,10 @@ export interface DeleteParameterRequest { /** * @public *

The name of the parameter to delete.

+ * + *

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name + * itself.

+ * */ Name: string | undefined; } @@ -4687,6 +4691,10 @@ export interface DeleteParametersRequest { * @public *

The names of the parameters to delete. After deleting a parameter, wait for at least 30 * seconds to create a parameter with the same name.

+ * + *

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name + * itself.

+ * */ Names: string[] | undefined; } @@ -4830,6 +4838,51 @@ export interface DeleteResourcePolicyRequest { */ export interface DeleteResourcePolicyResponse {} +/** + * @public + *

The specified policy document is malformed or invalid, or excessive + * PutResourcePolicy or DeleteResourcePolicy calls have been made.

+ */ +export class MalformedResourcePolicyDocumentException extends __BaseException { + readonly name: "MalformedResourcePolicyDocumentException" = "MalformedResourcePolicyDocumentException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "MalformedResourcePolicyDocumentException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, MalformedResourcePolicyDocumentException.prototype); + this.Message = opts.Message; + } +} + +/** + * @public + *

The specified parameter to be shared could not be found.

+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ResourceNotFoundException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ResourceNotFoundException.prototype); + this.Message = opts.Message; + } +} + /** * @public *

The hash provided in the call doesn't match the stored hash. This exception is thrown when @@ -4879,6 +4932,28 @@ export class ResourcePolicyInvalidParameterException extends __BaseException { } } +/** + * @public + *

No policies with the specified policy ID and hash could be found.

+ */ +export class ResourcePolicyNotFoundException extends __BaseException { + readonly name: "ResourcePolicyNotFoundException" = "ResourcePolicyNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ResourcePolicyNotFoundException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ResourcePolicyNotFoundException.prototype); + this.Message = opts.Message; + } +} + /** * @public */ @@ -6862,8 +6937,8 @@ export interface DescribeDocumentRequest { /** * @public *

An optional field specifying the version of the artifact associated with the document. For - * example, 12.6. This value is unique across all versions of a document, and - * can't be changed.

+ * example, 12.6. This value is unique across all versions of a document, and can't be + * changed.

*/ VersionName?: string; } @@ -9352,66 +9427,6 @@ export interface DescribeMaintenanceWindowTasksRequest { NextToken?: string; } -/** - * @public - * @enum - */ -export const MaintenanceWindowTaskCutoffBehavior = { - CancelTask: "CANCEL_TASK", - ContinueTask: "CONTINUE_TASK", -} as const; - -/** - * @public - */ -export type MaintenanceWindowTaskCutoffBehavior = - (typeof MaintenanceWindowTaskCutoffBehavior)[keyof typeof MaintenanceWindowTaskCutoffBehavior]; - -/** - * @public - *

Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed - * node-level logs to.

- * - *

- * LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the - * OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. - * For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance - * window task types, see MaintenanceWindowTaskInvocationParameters.

- * - */ -export interface LoggingInfo { - /** - * @public - *

The name of an S3 bucket where execution logs are stored.

- */ - S3BucketName: string | undefined; - - /** - * @public - *

(Optional) The S3 bucket subfolder.

- */ - S3KeyPrefix?: string; - - /** - * @public - *

The Amazon Web Services Region where the S3 bucket is located.

- */ - S3Region: string | undefined; -} - -/** - * @public - *

Defines the values for a task parameter.

- */ -export interface MaintenanceWindowTaskParameterValueExpression { - /** - * @public - *

This field contains an array of 0 or more strings, each 1 to 255 characters in - * length.

- */ - Values?: string[]; -} - /** * @internal */ @@ -9598,13 +9613,3 @@ export const DescribeMaintenanceWindowTargetsResultFilterSensitiveLog = ( ...obj, ...(obj.Targets && { Targets: obj.Targets.map((item) => MaintenanceWindowTargetFilterSensitiveLog(item)) }), }); - -/** - * @internal - */ -export const MaintenanceWindowTaskParameterValueExpressionFilterSensitiveLog = ( - obj: MaintenanceWindowTaskParameterValueExpression -): any => ({ - ...obj, - ...(obj.Values && { Values: SENSITIVE_STRING }), -}); diff --git a/clients/client-ssm/src/models/models_1.ts b/clients/client-ssm/src/models/models_1.ts index d01eb88fc9fd..ed4814e358ce 100644 --- a/clients/client-ssm/src/models/models_1.ts +++ b/clients/client-ssm/src/models/models_1.ts @@ -17,11 +17,8 @@ import { DocumentType, ExecutionMode, InstanceAssociationOutputLocation, - LoggingInfo, MaintenanceWindowExecutionStatus, MaintenanceWindowResourceType, - MaintenanceWindowTaskCutoffBehavior, - MaintenanceWindowTaskParameterValueExpression, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, @@ -50,6 +47,66 @@ import { import { SSMServiceException as __BaseException } from "./SSMServiceException"; +/** + * @public + * @enum + */ +export const MaintenanceWindowTaskCutoffBehavior = { + CancelTask: "CANCEL_TASK", + ContinueTask: "CONTINUE_TASK", +} as const; + +/** + * @public + */ +export type MaintenanceWindowTaskCutoffBehavior = + (typeof MaintenanceWindowTaskCutoffBehavior)[keyof typeof MaintenanceWindowTaskCutoffBehavior]; + +/** + * @public + *

Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed + * node-level logs to.

+ * + *

+ * LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the + * OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. + * For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance + * window task types, see MaintenanceWindowTaskInvocationParameters.

+ * + */ +export interface LoggingInfo { + /** + * @public + *

The name of an S3 bucket where execution logs are stored.

+ */ + S3BucketName: string | undefined; + + /** + * @public + *

(Optional) The S3 bucket subfolder.

+ */ + S3KeyPrefix?: string; + + /** + * @public + *

The Amazon Web Services Region where the S3 bucket is located.

+ */ + S3Region: string | undefined; +} + +/** + * @public + *

Defines the values for a task parameter.

+ */ +export interface MaintenanceWindowTaskParameterValueExpression { + /** + * @public + *

This field contains an array of 0 or more strings, each 1 to 255 characters in + * length.

+ */ + Values?: string[]; +} + /** * @public *

Information about a task defined for a maintenance window.

@@ -659,6 +716,22 @@ export interface DescribeParametersRequest { * call.)

*/ NextToken?: string; + + /** + * @public + *

Lists parameters that are shared with you.

+ * + *

By default when using this option, the command returns parameters that have been shared + * using a standard Resource Access Manager Resource Share. In order for a parameter that was shared + * using the PutResourcePolicy command to be returned, the associated + * RAM Resource Share Created From Policy must have been promoted to + * a standard Resource Share using the RAM + * PromoteResourceShareCreatedFromPolicy API operation.

+ *

For more information about sharing parameters, see Working with + * shared parameters in the Amazon Web Services Systems Manager User Guide.

+ * + */ + Shared?: boolean; } /** @@ -720,8 +793,8 @@ export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType]; /** * @public - *

Metadata includes information like the ARN of the last user and the date/time the parameter - * was last used.

+ *

Metadata includes information like the Amazon Resource Name (ARN) of the last user to update + * the parameter and the date and time the parameter was last used.

*/ export interface ParameterMetadata { /** @@ -730,6 +803,12 @@ export interface ParameterMetadata { */ Name?: string; + /** + * @public + *

The (ARN) of the last user to update the parameter.

+ */ + ARN?: string; + /** * @public *

The type of parameter. Valid parameter types include the following: String, @@ -2461,8 +2540,8 @@ export interface GetDocumentRequest { /** * @public *

An optional field specifying the version of the artifact associated with the document. For - * example, 12.6. This value is unique across all versions of a document and can't - * be changed.

+ * example, 12.6. This value is unique across all versions of a document and can't be + * changed.

*/ VersionName?: string; @@ -2554,7 +2633,8 @@ export interface GetDocumentResult { /** * @public - *

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

+ *

The version of the artifact associated with the document. For example, 12.6. This value is + * unique across all versions of a document, and can't be changed.

*/ VersionName?: string; @@ -4242,9 +4322,12 @@ export interface GetOpsSummaryResult { export interface GetParameterRequest { /** * @public - *

The name of the parameter you want to query.

+ *

The name or Amazon Resource Name (ARN) of the parameter that you want to query. For + * parameters shared with you from another account, you must use the full ARN.

*

To query by parameter label, use "Name": "name:label". To query by parameter * version, use "Name": "name:version".

+ *

For more information about shared parameters, see Working with shared parameters in + * the Amazon Web Services Systems Manager User Guide.

*/ Name: string | undefined; @@ -4388,7 +4471,8 @@ export class ParameterVersionNotFound extends __BaseException { export interface GetParameterHistoryRequest { /** * @public - *

The name of the parameter for which you want to review history.

+ *

The name or Amazon Resource Name (ARN) of the parameter for which you want to review + * history. For parameters shared with you from another account, you must use the full ARN.

*/ Name: string | undefined; @@ -4528,9 +4612,12 @@ export interface GetParameterHistoryResult { export interface GetParametersRequest { /** * @public - *

Names of the parameters for which you want to query information.

+ *

The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For + * parameters shared with you from another account, you must use the full ARNs.

*

To query by parameter label, use "Name": "name:label". To query by parameter * version, use "Name": "name:version".

+ *

For more information about shared parameters, see Working with shared parameters in + * the Amazon Web Services Systems Manager User Guide.

*/ Names: string[] | undefined; @@ -5041,6 +5128,10 @@ export interface LabelParameterVersionRequest { /** * @public *

The parameter name on which you want to attach one or more labels.

+ * + *

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name + * itself.

+ * */ Name: string | undefined; @@ -7241,8 +7332,8 @@ export interface DocumentIdentifier { /** * @public *

An optional field specifying the version of the artifact associated with the document. For - * example, 12.6. This value is unique across all versions of a document, and - * can't be changed.

+ * example, 12.6. This value is unique across all versions of a document, and can't be + * changed.

*/ VersionName?: string; @@ -7380,7 +7471,8 @@ export interface DocumentVersionInfo { /** * @public - *

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

+ *

The version of the artifact associated with the document. For example, 12.6. This value is + * unique across all versions of a document, and can't be changed.

*/ VersionName?: string; @@ -9024,10 +9116,14 @@ export class PoliciesLimitExceededException extends __BaseException { export interface PutParameterRequest { /** * @public - *

The fully qualified name of the parameter that you want to add to the system. The fully - * qualified name includes the complete hierarchy of the parameter path and name. For parameters in - * a hierarchy, you must include a leading forward slash character (/) when you create or reference - * a parameter. For example: /Dev/DBServer/MySQL/db-string13 + *

The fully qualified name of the parameter that you want to add to the system.

+ * + *

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name + * itself.

+ * + *

The fully qualified name includes the complete hierarchy of the parameter path and name. For + * parameters in a hierarchy, you must include a leading forward slash character (/) when you create + * or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13 *

*

Naming Constraints:

*
    @@ -10857,38 +10953,14 @@ export const StopType = { export type StopType = (typeof StopType)[keyof typeof StopType]; /** - * @public - */ -export interface StopAutomationExecutionRequest { - /** - * @public - *

    The execution ID of the Automation to stop.

    - */ - AutomationExecutionId: string | undefined; - - /** - * @public - *

    The stop request type. Valid types include the following: Cancel and Complete. The default - * type is Cancel.

    - */ - Type?: StopType; -} - -/** - * @public - */ -export interface StopAutomationExecutionResult {} - -/** - * @public + * @internal */ -export interface TerminateSessionRequest { - /** - * @public - *

    The ID of the session to terminate.

    - */ - SessionId: string | undefined; -} +export const MaintenanceWindowTaskParameterValueExpressionFilterSensitiveLog = ( + obj: MaintenanceWindowTaskParameterValueExpression +): any => ({ + ...obj, + ...(obj.Values && { Values: SENSITIVE_STRING }), +}); /** * @internal diff --git a/clients/client-ssm/src/models/models_2.ts b/clients/client-ssm/src/models/models_2.ts index 6bc03f631286..d5d86e2f4d04 100644 --- a/clients/client-ssm/src/models/models_2.ts +++ b/clients/client-ssm/src/models/models_2.ts @@ -12,9 +12,6 @@ import { DocumentDescription, DocumentFormat, InstanceAssociationOutputLocation, - LoggingInfo, - MaintenanceWindowTaskCutoffBehavior, - MaintenanceWindowTaskParameterValueExpression, MetadataValue, OperatingSystem, OpsItemDataValue, @@ -35,16 +32,54 @@ import { DocumentReviewCommentSource, InventoryFilter, InventoryGroup, + LoggingInfo, + MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskInvocationParameters, MaintenanceWindowTaskInvocationParametersFilterSensitiveLog, + MaintenanceWindowTaskParameterValueExpression, OpsFilter, OpsItemStatus, OpsResultAttribute, ResultAttribute, + StopType, } from "./models_1"; import { SSMServiceException as __BaseException } from "./SSMServiceException"; +/** + * @public + */ +export interface StopAutomationExecutionRequest { + /** + * @public + *

    The execution ID of the Automation to stop.

    + */ + AutomationExecutionId: string | undefined; + + /** + * @public + *

    The stop request type. Valid types include the following: Cancel and Complete. The default + * type is Cancel.

    + */ + Type?: StopType; +} + +/** + * @public + */ +export interface StopAutomationExecutionResult {} + +/** + * @public + */ +export interface TerminateSessionRequest { + /** + * @public + *

    The ID of the session to terminate.

    + */ + SessionId: string | undefined; +} + /** * @public */ @@ -63,6 +98,10 @@ export interface UnlabelParameterVersionRequest { /** * @public *

    The name of the parameter from which you want to delete one or more labels.

    + * + *

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name + * itself.

    + *     */ Name: string | undefined; @@ -539,8 +578,8 @@ export interface UpdateDocumentRequest { /** * @public *

    An optional field specifying the version of the artifact you are updating with the document. - * For example, 12.6. This value is unique across all versions of a document, and - * can't be changed.

    + * For example, 12.6. This value is unique across all versions of a document, and can't be + * changed.

    */ VersionName?: string; diff --git a/clients/client-ssm/src/protocols/Aws_json1_1.ts b/clients/client-ssm/src/protocols/Aws_json1_1.ts index 6bcae8230ec0..4030cdf99f3c 100644 --- a/clients/client-ssm/src/protocols/Aws_json1_1.ts +++ b/clients/client-ssm/src/protocols/Aws_json1_1.ts @@ -580,12 +580,11 @@ import { InvalidTargetMaps, InvalidTypeNameException, InventoryDeletionStatusItem, - LoggingInfo, MaintenanceWindowExecution, MaintenanceWindowExecutionTaskIdentity, MaintenanceWindowExecutionTaskInvocationIdentity, MaintenanceWindowFilter, - MaintenanceWindowTaskParameterValueExpression, + MalformedResourcePolicyDocumentException, MaxDocumentSizeExceeded, MetadataValue, OpsItemAccessDeniedException, @@ -625,8 +624,10 @@ import { ResourceDataSyncSource, ResourceInUseException, ResourceLimitExceededException, + ResourceNotFoundException, ResourcePolicyConflictException, ResourcePolicyInvalidParameterException, + ResourcePolicyNotFoundException, ReviewInformation, Runbook, S3OutputLocation, @@ -778,11 +779,13 @@ import { ListResourceDataSyncRequest, ListResourceDataSyncResult, ListTagsForResourceRequest, + LoggingInfo, MaintenanceWindowAutomationParameters, MaintenanceWindowLambdaParameters, MaintenanceWindowRunCommandParameters, MaintenanceWindowStepFunctionsParameters, MaintenanceWindowTaskInvocationParameters, + MaintenanceWindowTaskParameterValueExpression, ModifyDocumentPermissionRequest, NotificationConfig, NotificationEvent, @@ -837,10 +840,8 @@ import { StartAutomationExecutionRequest, StartChangeRequestExecutionRequest, StartSessionRequest, - StopAutomationExecutionRequest, SubTypeCountLimitExceededException, TargetNotConnected, - TerminateSessionRequest, TotalSizeLimitExceededException, UnsupportedCalendarException, UnsupportedFeatureRequiredException, @@ -862,6 +863,8 @@ import { OpsMetadataKeyLimitExceededException, ResourceDataSyncConflictException, StatusUnchanged, + StopAutomationExecutionRequest, + TerminateSessionRequest, UnlabelParameterVersionRequest, UpdateAssociationRequest, UpdateAssociationResult, @@ -5644,12 +5647,21 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext): case "ResourceDataSyncNotFoundException": case "com.amazonaws.ssm#ResourceDataSyncNotFoundException": throw await de_ResourceDataSyncNotFoundExceptionRes(parsedOutput, context); + case "MalformedResourcePolicyDocumentException": + case "com.amazonaws.ssm#MalformedResourcePolicyDocumentException": + throw await de_MalformedResourcePolicyDocumentExceptionRes(parsedOutput, context); + case "ResourceNotFoundException": + case "com.amazonaws.ssm#ResourceNotFoundException": + throw await de_ResourceNotFoundExceptionRes(parsedOutput, context); case "ResourcePolicyConflictException": case "com.amazonaws.ssm#ResourcePolicyConflictException": throw await de_ResourcePolicyConflictExceptionRes(parsedOutput, context); case "ResourcePolicyInvalidParameterException": case "com.amazonaws.ssm#ResourcePolicyInvalidParameterException": throw await de_ResourcePolicyInvalidParameterExceptionRes(parsedOutput, context); + case "ResourcePolicyNotFoundException": + case "com.amazonaws.ssm#ResourcePolicyNotFoundException": + throw await de_ResourcePolicyNotFoundExceptionRes(parsedOutput, context); case "TargetInUseException": case "com.amazonaws.ssm#TargetInUseException": throw await de_TargetInUseExceptionRes(parsedOutput, context); @@ -7094,6 +7106,22 @@ const de_ItemSizeLimitExceededExceptionRes = async ( return __decorateServiceException(exception, body); }; +/** + * deserializeAws_json1_1MalformedResourcePolicyDocumentExceptionRes + */ +const de_MalformedResourcePolicyDocumentExceptionRes = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const body = parsedOutput.body; + const deserialized: any = _json(body); + const exception = new MalformedResourcePolicyDocumentException({ + $metadata: deserializeMetadata(parsedOutput), + ...deserialized, + }); + return __decorateServiceException(exception, body); +}; + /** * deserializeAws_json1_1MaxDocumentSizeExceededRes */ @@ -7571,6 +7599,22 @@ const de_ResourceLimitExceededExceptionRes = async ( return __decorateServiceException(exception, body); }; +/** + * deserializeAws_json1_1ResourceNotFoundExceptionRes + */ +const de_ResourceNotFoundExceptionRes = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const body = parsedOutput.body; + const deserialized: any = _json(body); + const exception = new ResourceNotFoundException({ + $metadata: deserializeMetadata(parsedOutput), + ...deserialized, + }); + return __decorateServiceException(exception, body); +}; + /** * deserializeAws_json1_1ResourcePolicyConflictExceptionRes */ @@ -7619,6 +7663,22 @@ const de_ResourcePolicyLimitExceededExceptionRes = async ( return __decorateServiceException(exception, body); }; +/** + * deserializeAws_json1_1ResourcePolicyNotFoundExceptionRes + */ +const de_ResourcePolicyNotFoundExceptionRes = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const body = parsedOutput.body; + const deserialized: any = _json(body); + const exception = new ResourcePolicyNotFoundException({ + $metadata: deserializeMetadata(parsedOutput), + ...deserialized, + }); + return __decorateServiceException(exception, body); +}; + /** * deserializeAws_json1_1ServiceSettingNotFoundRes */ @@ -10756,6 +10816,8 @@ const de_MaintenanceWindowTaskInvocationParameters = ( // de_MaintenanceWindowTaskParameterValueList omitted. +// de_MalformedResourcePolicyDocumentException omitted. + // de_MaxDocumentSizeExceeded omitted. // de_MetadataMap omitted. @@ -11051,6 +11113,7 @@ const de_ParameterList = (output: any, context: __SerdeContext): Parameter[] => */ const de_ParameterMetadata = (output: any, context: __SerdeContext): ParameterMetadata => { return take(output, { + ARN: __expectString, AllowedPattern: __expectString, DataType: __expectString, Description: __expectString, @@ -11348,12 +11411,16 @@ const de_ResourceDataSyncItemList = (output: any, context: __SerdeContext): Reso // de_ResourceLimitExceededException omitted. +// de_ResourceNotFoundException omitted. + // de_ResourcePolicyConflictException omitted. // de_ResourcePolicyInvalidParameterException omitted. // de_ResourcePolicyLimitExceededException omitted. +// de_ResourcePolicyNotFoundException omitted. + // de_ResourcePolicyParameterNamesList omitted. // de_ResumeSessionResponse omitted. diff --git a/codegen/sdk-codegen/aws-models/ssm.json b/codegen/sdk-codegen/aws-models/ssm.json index ac3fe4e15829..d7cfdc5f65d2 100644 --- a/codegen/sdk-codegen/aws-models/ssm.json +++ b/codegen/sdk-codegen/aws-models/ssm.json @@ -7252,7 +7252,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The name of the parameter to delete.

    ", + "smithy.api#documentation": "

    The name of the parameter to delete.

    \n \n

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

    \n     ", "smithy.api#required": {} } } @@ -7291,7 +7291,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

    The names of the parameters to delete. After deleting a parameter, wait for at least 30\n seconds to create a parameter with the same name.

    ", + "smithy.api#documentation": "

    The names of the parameters to delete. After deleting a parameter, wait for at least 30\n seconds to create a parameter with the same name.

    \n \n

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

    \n     ", "smithy.api#required": {} } } @@ -7432,15 +7432,24 @@ { "target": "com.amazonaws.ssm#InternalServerError" }, + { + "target": "com.amazonaws.ssm#MalformedResourcePolicyDocumentException" + }, + { + "target": "com.amazonaws.ssm#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssm#ResourcePolicyConflictException" }, { "target": "com.amazonaws.ssm#ResourcePolicyInvalidParameterException" + }, + { + "target": "com.amazonaws.ssm#ResourcePolicyNotFoundException" } ], "traits": { - "smithy.api#documentation": "

    Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,\n OpsItemGroup is the only resource that supports Systems Manager resource policies. The\n resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with\n OpsCenter operational work items (OpsItems).

    " + "smithy.api#documentation": "

    Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following\n resources support Systems Manager resource policies.

    \n
      \n
    • \n

      \n OpsItemGroup - The resource policy for OpsItemGroup enables\n Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

      \n
      • \n
    • \n

      \n Parameter - The resource policy is used to share a parameter with other\n accounts using Resource Access Manager (RAM). For more information about\n cross-account sharing of parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.

      \n
      • \n
    " } }, "com.amazonaws.ssm#DeleteResourcePolicyRequest": { @@ -8469,7 +8478,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and can't be\n changed.

    " } } }, @@ -9854,7 +9863,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Get information about a parameter.

    \n

    Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

    \n \n

    If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must\n also update the key alias the parameter uses to reference KMS. Otherwise,\n DescribeParameters retrieves whatever the original key alias was\n referencing.

    \n     ", + "smithy.api#documentation": "

    Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable\n the Shared option.

    \n

    Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

    \n \n

    If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n DescribeParameters retrieves whatever the original key alias was\n referencing.

    \n     ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9888,6 +9897,13 @@ "traits": { "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } + }, + "Shared": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

    Lists parameters that are shared with you.

    \n \n

    By default when using this option, the command returns parameters that have been shared\n using a standard Resource Access Manager Resource Share. In order for a parameter that was shared\n using the PutResourcePolicy command to be returned, the associated\n RAM Resource Share Created From Policy must have been promoted to\n a standard Resource Share using the RAM\n PromoteResourceShareCreatedFromPolicy API operation.

    \n

    For more information about sharing parameters, see Working with\n shared parameters in the Amazon Web Services Systems Manager User Guide.

    \n     " + } } }, "traits": { @@ -10814,7 +10830,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and can't be\n changed.

    " } }, "PlatformTypes": { @@ -11125,7 +11141,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and can't be\n changed.

    " } } }, @@ -11466,7 +11482,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

    " + "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, 12.6. This value is\n unique across all versions of a document, and can't be changed.

    " } }, "CreatedDate": { @@ -12418,7 +12434,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document and can't\n be changed.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document and can't be\n changed.

    " } }, "DocumentVersion": { @@ -12462,7 +12478,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

    " + "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, 12.6. This value is\n unique across all versions of a document, and can't be changed.

    " } }, "DocumentVersion": { @@ -13647,7 +13663,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the history of all changes to a parameter.

    \n \n

    If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must\n also update the key alias the parameter uses to reference KMS. Otherwise,\n GetParameterHistory retrieves whatever the original key alias was\n referencing.

    \n     ", + "smithy.api#documentation": "

    Retrieves the history of all changes to a parameter.

    \n \n

    If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n GetParameterHistory retrieves whatever the original key alias was\n referencing.

    \n     ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -13661,7 +13677,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The name of the parameter for which you want to review history.

    ", + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the parameter for which you want to review\n history. For parameters shared with you from another account, you must use the full ARN.

    ", "smithy.api#required": {} } }, @@ -13715,7 +13731,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The name of the parameter you want to query.

    \n

    To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

    ", + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the parameter that you want to query. For\n parameters shared with you from another account, you must use the full ARN.

    \n

    To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

    \n

    For more information about shared parameters, see Working with shared parameters in\n the Amazon Web Services Systems Manager User Guide.

    ", "smithy.api#required": {} } }, @@ -13884,7 +13900,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

    Names of the parameters for which you want to query information.

    \n

    To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

    ", + "smithy.api#documentation": "

    The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For\n parameters shared with you from another account, you must use the full ARNs.

    \n

    To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

    \n

    For more information about shared parameters, see Working with shared parameters in\n the Amazon Web Services Systems Manager User Guide.

    ", "smithy.api#required": {} } }, @@ -14133,6 +14149,9 @@ { "target": "com.amazonaws.ssm#InternalServerError" }, + { + "target": "com.amazonaws.ssm#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssm#ResourcePolicyInvalidParameterException" } @@ -16782,7 +16801,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The parameter name on which you want to attach one or more labels.

    ", + "smithy.api#documentation": "

    The parameter name on which you want to attach one or more labels.

    \n \n

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

    \n     ", "smithy.api#required": {} } }, @@ -19361,6 +19380,22 @@ "target": "com.amazonaws.ssm#MaintenanceWindowIdentityForTarget" } }, + "com.amazonaws.ssm#MalformedResourcePolicyDocumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedResourcePolicyDocumentException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

    The specified policy document is malformed or invalid, or excessive\n PutResourcePolicy or DeleteResourcePolicy calls have been made.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#ManagedInstanceId": { "type": "string", "traits": { @@ -22026,6 +22061,12 @@ "smithy.api#documentation": "

    The parameter name.

    " } }, + "ARN": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

    The (ARN) of the last user to update the parameter.

    " + } + }, "Type": { "target": "com.amazonaws.ssm#ParameterType", "traits": { @@ -22089,7 +22130,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Metadata includes information like the ARN of the last user and the date/time the parameter\n was last used.

    " + "smithy.api#documentation": "

    Metadata includes information like the Amazon Resource Name (ARN) of the last user to update\n the parameter and the date and time the parameter was last used.

    " } }, "com.amazonaws.ssm#ParameterMetadataList": { @@ -23664,7 +23705,7 @@ "com.amazonaws.ssm#Policy": { "type": "string", "traits": { - "smithy.api#pattern": "^\\S+$" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.ssm#PolicyHash": { @@ -23970,7 +24011,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The fully qualified name of the parameter that you want to add to the system. The fully\n qualified name includes the complete hierarchy of the parameter path and name. For parameters in\n a hierarchy, you must include a leading forward slash character (/) when you create or reference\n a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

    \n

    Naming Constraints:

    \n
      \n
    • \n

      Parameter names are case sensitive.

      \n
      • \n
    • \n

      A parameter name must be unique within an Amazon Web Services Region

      \n
      • \n
    • \n

      A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

      \n
      • \n
    • \n

      Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

      \n

      In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

      \n
      • \n
    • \n

      A parameter name can't include spaces.

      \n
      • \n
    • \n

      Parameter hierarchies are limited to a maximum depth of fifteen levels.

      \n
      • \n
    \n

    For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

    \n \n

    The maximum length constraint of 2048 characters listed below includes 1037 characters\n reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is\n 1011 characters. This includes the characters in the ARN that precede the name you specify, such\n as arn:aws:ssm:us-east-2:111122223333:parameter/.

    \n     ", + "smithy.api#documentation": "

    The fully qualified name of the parameter that you want to add to the system.

    \n \n

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

    \n     \n

    The fully qualified name includes the complete hierarchy of the parameter path and name. For\n parameters in a hierarchy, you must include a leading forward slash character (/) when you create\n or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

    \n

    Naming Constraints:

    \n
      \n
    • \n

      Parameter names are case sensitive.

      \n
      • \n
    • \n

      A parameter name must be unique within an Amazon Web Services Region

      \n
      • \n
    • \n

      A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

      \n
      • \n
    • \n

      Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

      \n

      In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

      \n
      • \n
    • \n

      A parameter name can't include spaces.

      \n
      • \n
    • \n

      Parameter hierarchies are limited to a maximum depth of fifteen levels.

      \n
      • \n
    \n

    For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

    \n \n

    The maximum length constraint of 2048 characters listed below includes 1037 characters\n reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is\n 1011 characters. This includes the characters in the ARN that precede the name you specify, such\n as arn:aws:ssm:us-east-2:111122223333:parameter/.

    \n     ", "smithy.api#required": {} } }, @@ -24074,6 +24115,12 @@ { "target": "com.amazonaws.ssm#InternalServerError" }, + { + "target": "com.amazonaws.ssm#MalformedResourcePolicyDocumentException" + }, + { + "target": "com.amazonaws.ssm#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssm#ResourcePolicyConflictException" }, @@ -24082,10 +24129,13 @@ }, { "target": "com.amazonaws.ssm#ResourcePolicyLimitExceededException" + }, + { + "target": "com.amazonaws.ssm#ResourcePolicyNotFoundException" } ], "traits": { - "smithy.api#documentation": "

    Creates or updates a Systems Manager resource policy. A resource policy helps you to define the\n IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources.\n Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies.\n The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact\n with OpsCenter operational work items (OpsItems).

    " + "smithy.api#documentation": "

    Creates or updates a Systems Manager resource policy. A resource policy helps you to define the\n IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources.\n The following resources support Systems Manager resource policies.

    \n
      \n
    • \n

      \n OpsItemGroup - The resource policy for OpsItemGroup enables\n Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

      \n
      • \n
    • \n

      \n Parameter - The resource policy is used to share a parameter with other\n accounts using Resource Access Manager (RAM).

      \n

      To share a parameter, it must be in the advanced parameter tier. For information about\n parameter tiers, see Managing parameter tiers. For information about\n changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced\n parameter.

      \n

      To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in\n the Key Management Service Developer Guide.

      \n \n

      While you can share a parameter using the Systems Manager PutResourcePolicy operation,\n we recommend using Resource Access Manager (RAM) instead. This is because using\n PutResourcePolicy requires the extra step of promoting the parameter to a\n standard RAM Resource Share using the RAM\n PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't\n be returned by the Systems Manager DescribeParameters API operation using the --shared option.

      \n

      For more information, see Sharing a\n parameter in the Amazon Web Services Systems Manager User Guide\n

      \n       \n
      • \n
    " } }, "com.amazonaws.ssm#PutResourcePolicyRequest": { @@ -25402,6 +25452,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

    The specified parameter to be shared could not be found.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#ResourcePolicyConflictException": { "type": "structure", "members": { @@ -25471,6 +25537,22 @@ } } }, + "com.amazonaws.ssm#ResourcePolicyNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourcePolicyNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

    No policies with the specified policy ID and hash could be found.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#ResourcePolicyParameterNamesList": { "type": "list", "member": { @@ -27982,7 +28064,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The name of the parameter from which you want to delete one or more labels.

    ", + "smithy.api#documentation": "

    The name of the parameter from which you want to delete one or more labels.

    \n \n

    You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

    \n     ", "smithy.api#required": {} } }, @@ -28615,7 +28697,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact you are updating with the document.\n For example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact you are updating with the document.\n For example, 12.6. This value is unique across all versions of a document, and can't be\n changed.

    " } }, "DocumentVersion": {