Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceV2Client, DeleteResourcePolicyCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2"; // ES Modules import + * // const { PinpointSMSVoiceV2Client, DeleteResourcePolicyCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2"); // CommonJS import + * const client = new PinpointSMSVoiceV2Client(config); + * const input = { // DeleteResourcePolicyRequest + * ResourceArn: "STRING_VALUE", // required + * }; + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * // { // DeleteResourcePolicyResult + * // ResourceArn: "STRING_VALUE", + * // Policy: "STRING_VALUE", + * // CreatedTimestamp: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput} + * @returns {@link DeleteResourcePolicyCommandOutput} + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request was denied because you don't have sufficient permissions to access the + * resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The API encountered an unexpected error and couldn't complete the request. You might + * be able to successfully issue the request again in the future.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A requested resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *An error that occurred because too many requests were sent during a certain amount of + * time.
+ * + * @throws {@link ValidationException} (client fault) + *A validation exception for a field.
+ * + * @throws {@link PinpointSMSVoiceV2ServiceException} + *Base exception class for all service exceptions from PinpointSMSVoiceV2 service.
+ * + * @public + */ +export class DeleteResourcePolicyCommand extends $Command + .classBuilder< + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, + PinpointSMSVoiceV2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: PinpointSMSVoiceV2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("PinpointSMSVoiceV2", "DeleteResourcePolicy", {}) + .n("PinpointSMSVoiceV2Client", "DeleteResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_DeleteResourcePolicyCommand) + .de(de_DeleteResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteResourcePolicyRequest; + output: DeleteResourcePolicyResult; + }; + sdk: { + input: DeleteResourcePolicyCommandInput; + output: DeleteResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeOptOutListsCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeOptOutListsCommand.ts index 774d82104d14..17434070f609 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeOptOutListsCommand.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeOptOutListsCommand.ts @@ -50,6 +50,7 @@ export interface DescribeOptOutListsCommandOutput extends DescribeOptOutListsRes * ], * NextToken: "STRING_VALUE", * MaxResults: Number("int"), + * Owner: "STRING_VALUE", * }; * const command = new DescribeOptOutListsCommand(input); * const response = await client.send(command); diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePhoneNumbersCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePhoneNumbersCommand.ts index ff97c8c33ab0..be9a52ecf1d9 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePhoneNumbersCommand.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePhoneNumbersCommand.ts @@ -59,6 +59,7 @@ export interface DescribePhoneNumbersCommandOutput extends DescribePhoneNumbersR * ], * NextToken: "STRING_VALUE", * MaxResults: Number("int"), + * Owner: "STRING_VALUE", * }; * const command = new DescribePhoneNumbersCommand(input); * const response = await client.send(command); diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePoolsCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePoolsCommand.ts index 9d869b9516a7..b88d8754eb68 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePoolsCommand.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribePoolsCommand.ts @@ -62,6 +62,7 @@ export interface DescribePoolsCommandOutput extends DescribePoolsResult, __Metad * ], * NextToken: "STRING_VALUE", * MaxResults: Number("int"), + * Owner: "STRING_VALUE", * }; * const command = new DescribePoolsCommand(input); * const response = await client.send(command); diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeSenderIdsCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeSenderIdsCommand.ts index 82b32d2285ec..424fdbc38d5e 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeSenderIdsCommand.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeSenderIdsCommand.ts @@ -61,6 +61,7 @@ export interface DescribeSenderIdsCommandOutput extends DescribeSenderIdsResult, * ], * NextToken: "STRING_VALUE", * MaxResults: Number("int"), + * Owner: "STRING_VALUE", * }; * const command = new DescribeSenderIdsCommand(input); * const response = await client.send(command); diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/GetResourcePolicyCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/GetResourcePolicyCommand.ts new file mode 100644 index 000000000000..fa9df53d5d86 --- /dev/null +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/GetResourcePolicyCommand.ts @@ -0,0 +1,116 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetResourcePolicyRequest, GetResourcePolicyResult } from "../models/models_0"; +import { + PinpointSMSVoiceV2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../PinpointSMSVoiceV2Client"; +import { de_GetResourcePolicyCommand, se_GetResourcePolicyCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetResourcePolicyCommand}. + */ +export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest {} +/** + * @public + * + * The output of {@link GetResourcePolicyCommand}. + */ +export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResult, __MetadataBearer {} + +/** + *Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceV2Client, GetResourcePolicyCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2"; // ES Modules import + * // const { PinpointSMSVoiceV2Client, GetResourcePolicyCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2"); // CommonJS import + * const client = new PinpointSMSVoiceV2Client(config); + * const input = { // GetResourcePolicyRequest + * ResourceArn: "STRING_VALUE", // required + * }; + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * // { // GetResourcePolicyResult + * // ResourceArn: "STRING_VALUE", + * // Policy: "STRING_VALUE", + * // CreatedTimestamp: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput} + * @returns {@link GetResourcePolicyCommandOutput} + * @see {@link GetResourcePolicyCommandInput} for command's `input` shape. + * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request was denied because you don't have sufficient permissions to access the + * resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The API encountered an unexpected error and couldn't complete the request. You might + * be able to successfully issue the request again in the future.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A requested resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *An error that occurred because too many requests were sent during a certain amount of + * time.
+ * + * @throws {@link ValidationException} (client fault) + *A validation exception for a field.
+ * + * @throws {@link PinpointSMSVoiceV2ServiceException} + *Base exception class for all service exceptions from PinpointSMSVoiceV2 service.
+ * + * @public + */ +export class GetResourcePolicyCommand extends $Command + .classBuilder< + GetResourcePolicyCommandInput, + GetResourcePolicyCommandOutput, + PinpointSMSVoiceV2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: PinpointSMSVoiceV2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("PinpointSMSVoiceV2", "GetResourcePolicy", {}) + .n("PinpointSMSVoiceV2Client", "GetResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_GetResourcePolicyCommand) + .de(de_GetResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetResourcePolicyRequest; + output: GetResourcePolicyResult; + }; + sdk: { + input: GetResourcePolicyCommandInput; + output: GetResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/PutResourcePolicyCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/PutResourcePolicyCommand.ts new file mode 100644 index 000000000000..50c8d6a0eb25 --- /dev/null +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/PutResourcePolicyCommand.ts @@ -0,0 +1,119 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutResourcePolicyRequest, PutResourcePolicyResult } from "../models/models_0"; +import { + PinpointSMSVoiceV2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../PinpointSMSVoiceV2Client"; +import { de_PutResourcePolicyCommand, se_PutResourcePolicyCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutResourcePolicyCommand}. + */ +export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {} +/** + * @public + * + * The output of {@link PutResourcePolicyCommand}. + */ +export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResult, __MetadataBearer {} + +/** + *Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for + * sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about + * resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceV2Client, PutResourcePolicyCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2"; // ES Modules import + * // const { PinpointSMSVoiceV2Client, PutResourcePolicyCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2"); // CommonJS import + * const client = new PinpointSMSVoiceV2Client(config); + * const input = { // PutResourcePolicyRequest + * ResourceArn: "STRING_VALUE", // required + * Policy: "STRING_VALUE", // required + * }; + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * // { // PutResourcePolicyResult + * // ResourceArn: "STRING_VALUE", + * // Policy: "STRING_VALUE", + * // CreatedTimestamp: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput} + * @returns {@link PutResourcePolicyCommandOutput} + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request was denied because you don't have sufficient permissions to access the + * resource.
+ * + * @throws {@link InternalServerException} (server fault) + *The API encountered an unexpected error and couldn't complete the request. You might + * be able to successfully issue the request again in the future.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A requested resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *An error that occurred because too many requests were sent during a certain amount of + * time.
+ * + * @throws {@link ValidationException} (client fault) + *A validation exception for a field.
+ * + * @throws {@link PinpointSMSVoiceV2ServiceException} + *Base exception class for all service exceptions from PinpointSMSVoiceV2 service.
+ * + * @public + */ +export class PutResourcePolicyCommand extends $Command + .classBuilder< + PutResourcePolicyCommandInput, + PutResourcePolicyCommandOutput, + PinpointSMSVoiceV2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: PinpointSMSVoiceV2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("PinpointSMSVoiceV2", "PutResourcePolicy", {}) + .n("PinpointSMSVoiceV2Client", "PutResourcePolicyCommand") + .f(void 0, void 0) + .ser(se_PutResourcePolicyCommand) + .de(de_PutResourcePolicyCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutResourcePolicyRequest; + output: PutResourcePolicyResult; + }; + sdk: { + input: PutResourcePolicyCommandInput; + output: PutResourcePolicyCommandOutput; + }; + }; +} diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/index.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/index.ts index e2b6afbf57b9..761eacd07e3b 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/commands/index.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/commands/index.ts @@ -25,6 +25,7 @@ export * from "./DeleteProtectConfigurationCommand"; export * from "./DeleteRegistrationAttachmentCommand"; export * from "./DeleteRegistrationCommand"; export * from "./DeleteRegistrationFieldValueCommand"; +export * from "./DeleteResourcePolicyCommand"; export * from "./DeleteTextMessageSpendLimitOverrideCommand"; export * from "./DeleteVerifiedDestinationNumberCommand"; export * from "./DeleteVoiceMessageSpendLimitOverrideCommand"; @@ -51,12 +52,14 @@ export * from "./DisassociateOriginationIdentityCommand"; export * from "./DisassociateProtectConfigurationCommand"; export * from "./DiscardRegistrationVersionCommand"; export * from "./GetProtectConfigurationCountryRuleSetCommand"; +export * from "./GetResourcePolicyCommand"; export * from "./ListPoolOriginationIdentitiesCommand"; export * from "./ListRegistrationAssociationsCommand"; export * from "./ListTagsForResourceCommand"; export * from "./PutKeywordCommand"; export * from "./PutOptedOutNumberCommand"; export * from "./PutRegistrationFieldValueCommand"; +export * from "./PutResourcePolicyCommand"; export * from "./ReleasePhoneNumberCommand"; export * from "./ReleaseSenderIdCommand"; export * from "./RequestPhoneNumberCommand"; diff --git a/clients/client-pinpoint-sms-voice-v2/src/models/models_0.ts b/clients/client-pinpoint-sms-voice-v2/src/models/models_0.ts index a2754e85c380..b2b55540b229 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/models/models_0.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/models/models_0.ts @@ -130,6 +130,9 @@ export interface AssociateOriginationIdentityRequest { /** *The pool to update with the new Identity. This value can be either the PoolId or * PoolArn, and you can find these values using DescribePools.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutListName or OptOutListArn to remove the phone number from.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and * OptOutListArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from.
+ * @public + */ + ResourceArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteResourcePolicyResult { + /** + *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.
+ * @public + */ + ResourceArn?: string; + + /** + *The JSON formatted resource-based policy that was deleted.
+ * @public + */ + Policy?: string; + + /** + *The time when the resource-based policy was created, in UNIX epoch time format.
+ * @public + */ + CreatedTimestamp?: Date; +} + /** * @public */ @@ -2860,6 +2916,9 @@ export interface DescribeKeywordsRequest { * SenderIdArn. You can use DescribePhoneNumbers to find the values for * PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used * to get the values for SenderId and SenderIdArn. + *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and * OptOutListArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutLists to show the details of. This is an array of strings that can be either * the OptOutListName or OptOutListArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
The unique identifier of phone numbers to find information about. This is an array of * strings that can be either the PhoneNumberId or PhoneNumberArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
The unique identifier of pools to find. This is an array of strings that can be either * the PoolId or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
An array of SenderIdAndCountry objects to search for.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
The unique identifier for the pool to disassociate with the origination identity. This * value can be either the PoolId or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
+ * @public + */ + ResourceArn: string | undefined; +} + +/** + * @public + */ +export interface GetResourcePolicyResult { + /** + *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
+ * @public + */ + ResourceArn?: string; + + /** + *The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.
+ * @public + */ + Policy?: string; + + /** + *The time when the resource-based policy was created, in UNIX epoch time format.
+ * @public + */ + CreatedTimestamp?: Date; +} + /** * @public * @enum @@ -5661,6 +5813,9 @@ export interface ListPoolOriginationIdentitiesRequest { /** *The unique identifier for the pool. This value can be either the PoolId or * PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutListName or OptOutListArn to add the phone number to.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *The JSON formatted resource-based policy to attach.
+ * @public + */ + Policy: string | undefined; +} + +/** + * @public + */ +export interface PutResourcePolicyResult { + /** + *The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
+ * @public + */ + ResourceArn?: string; + + /** + *The JSON formatted Resource Policy.
+ * @public + */ + Policy?: string; + + /** + *The time when the resource-based policy was created, in UNIX epoch time format.
+ * @public + */ + CreatedTimestamp?: Date; +} + /** * @public */ @@ -6137,6 +6338,9 @@ export interface ReleasePhoneNumberRequest { /** *The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and * PhoneNumberArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The name of the OptOutList to associate with the phone number. You can use the * OptOutListName or OptOutListArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The pool to associated with the phone number. You can use the PoolId or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The origination identity of the message. This can be either the PhoneNumber, * PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The origination identity of the message. This can be either the PhoneNumber, * PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The origination identity of the message. This can be either the PhoneNumber, * PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The origination identity to use for the voice call. This can be the PhoneNumber, * PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The unique identifier of the phone number. Valid values for this field can be either * the PhoneNumberId or PhoneNumberArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The unique identifier of the pool to update. Valid values are either the PoolId or * PoolArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The OptOutList to associate with the pool. Valid values are either OptOutListName or * OptOutListArn.
+ *If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
+ *The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.
", + "smithy.api#documentation": "The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nAfter the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nAfter the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn to remove the phone number from.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", + "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nDeletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.
" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON formatted resource-based policy that was deleted.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { "type": "operation", "input": { @@ -3581,7 +3651,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
" + "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe maximum number of results to return per each request.
" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
" + "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe maximum number of results to return per each request.
" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
" + "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe maximum number of results to return per each request.
" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
An array of SenderIdAndCountry objects to search for.
" + "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe maximum number of results to return per each request.
" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
", + "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nRetrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { "type": "string", "traits": { @@ -6027,7 +6191,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn to add the phone number to.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nAttaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for\n sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about\n resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON formatted resource-based policy to attach.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON formatted Resource Policy.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior": { "type": "string", "traits": { @@ -9824,7 +10089,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
", + "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.
" + "smithy.api#documentation": "The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe pool to associated with the phone number. You can use the PoolId or PoolArn.
" + "smithy.api#documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
", + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
", + "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
", + "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
" + "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\n