id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
AmazonMonitronUG-064 | AmazonMonitronUG.pdf | 64 | Lambda. Processing data with Lambda 385 Amazon Monitron • Choose Next. User Guide 4. In the Add permissions page, do the following: • In Permissions policies, choose AWSLambdaKinesisExecutionRole (and AWSKeyManagementServicePowerUser if the Kinesis stream is encrypted). • Leave the configurations in Set permissions boundary as is. • Choose Next. Processing data with Lambda 386 Amazon Monitron User Guide 5. In the Name, review, and create page, do the following: • In Role details, for Role name, enter a name for your role. For example lambda-kinesis- role. You can also choose to add an optional Description. • Leave the settings for Step 1: Select trusted entities and Step 2: Add permissions as is. You can choost to add tags in Step 3: Add tags to keep track of your resources. Processing data with Lambda 387 Amazon Monitron User Guide 6. Select Create role. Step 2: Create the Lambda function 1. Open the Functions page in the Lambda console. 2. Choose Create function. Processing data with Lambda 388 Amazon Monitron 3. Choose Use a blueprint. User Guide 4. In the Blueprints search bar, search and choose kinesis-process-record (nodejs) or kinesis- process-record-python. 5. Choose Configure. Step 3: Configure the Lambda function 1. Choose Function name 2. Choose the role created in the first step as the Execution role. 3. Configure Kinesis trigger. 1. Choose your Kinesis stream. 2. Click Create function. Processing data with Lambda 389 Amazon Monitron User Guide Processing data with Lambda 390 Amazon Monitron User Guide Step 4: Enable Kinesis trigger in AWS Lambda console 1. On the Configuration tab, choose Triggers. 2. Check the box next to the name of the Kinesis stream and choose Enable. The blueprint used in this example only consumes log data from the selected stream. You can further edit Lambda function code later to complete a more complicated task. Understanding the v2 data export schema Each measurement data, its corresponding inference result, gateway connect/disconnect, and sensor connect/disconnect events are exported as one Kinesis data stream record in JSON format. Topics Understanding the v2 data export schema 391 User Guide Amazon Monitron • v2 schema format • v2 schema parameters v2 schema format { "timestamp": "string", "eventId": "string", "version": "2.0", "accountId": "string", "projectName": "string", "projectId": "string", "eventType": "measurement|gatewayConnected|gatewayDisconnected|sensorConnected| sensorDisconnected|assetStateTransition", // measurement "eventPayload": { "siteName": "string", "assetName": "string", "positionName": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "serialNumber": "string", "make": "string", "model": "string", "assetPositionURL": "string", "sensor": { "physicalId": "string", "rssi": number }, "gateway": { "physicalId": "string" }, "sequenceNo": number, "features": { "acceleration": { "band0To6000Hz": { "xAxis": { "rms": number Understanding the v2 data export schema 392 Amazon Monitron User Guide }, "yAxis": { "rms": number }, "zAxis": { "rms": number } }, "band10To1000Hz": { "totalVibration": { "absMax": number, "absMin": number, "crestFactor": number, "rms": number }, "xAxis": { "rms": number }, "yAxis": { "rms": number }, "zAxis": { "rms": number } } }, "velocity": { "band10To1000Hz": { "totalVibration": { "absMax": number, "absMin": number, "crestFactor": number, "rms": number }, "xAxis": { "rms": number }, "yAxis": { "rms": number }, "zAxis": { "rms": number } } Understanding the v2 data export schema 393 User Guide Amazon Monitron }, "temperature": number } "models": { "temperatureML": { "previousPersistentClassificationOutput": "string", "persistentClassificationOutput": "string", "pointwiseClassificationOutput": "string" }, "vibrationISO": { "isoClass": "string", "mutedThreshold": "string", "previousPersistentClassificationOutput": "string", "persistentClassificationOutput": "string", "pointwiseClassificationOutput": "string" }, "vibrationML": { "previousPersistentClassificationOutput": "string", "persistentClassificationOutput": "string", "pointwiseClassificationOutput": "string" } }, "assetPositionId": "string" } // sensorConnected "eventPayload": { "siteName": "string", "assetName": "string", "positionName": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "serialNumber": "string", "make": "string", "model": "string", "assetPositionURL": "string", "sensor": { "physicalId": "string" }, "assetPositionId": "string" Understanding the v2 data export schema 394 Amazon Monitron } User Guide // sensorDisconnected "eventPayload": { "siteName": "string", "assetName": "string", "positionName": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "serialNumber": "string", "make": "string", "model": "string", "assetPositionURL": "string", "sensor": { "physicalId": "string" }, "assetPositionId": "string" } // gatewayConnected "eventPayload": { "siteName": "string", "gatewayName": "string", "gatewayListURL": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "gateway": { "physicalId": "string" } } // gatewayDisconnected "eventPayload": { "siteName": "string", "gatewayName": "string", "gatewayListURL": "string", Understanding the v2 data export schema 395 Amazon Monitron User Guide "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "gateway": { "physicalId": "string" } } // assetStateTransition "eventPayload": { "siteName": "string", "assetName": "string", "positionName": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "serialNumber": "string", "make": "string", "model": "string", "assetPositionURL": "string", "sensor": { "physicalId": "string" }, "assetTransitionType": "measurement|userInput", "assetState": { "newState": "string", "previousState": "string" }, "closureCode": { "failureMode": "string", "failureCause": "string", "actionTaken": "string", "resolvedModels": list<"string"> }, "assetPositionId": "string" } } Understanding the v2 data export schema 396 Amazon Monitron v2 schema parameters User Guide The Amazon Monitron Kinesis data export schema v2 includes the following schema parameters. Some parameters |
AmazonMonitronUG-065 | AmazonMonitronUG.pdf | 65 | "latitude": number, "longitude": number }, "address": "string", "gateway": { "physicalId": "string" } } // assetStateTransition "eventPayload": { "siteName": "string", "assetName": "string", "positionName": "string", "companyName": "string", "geoLocation": { "latitude": number, "longitude": number }, "address": "string", "serialNumber": "string", "make": "string", "model": "string", "assetPositionURL": "string", "sensor": { "physicalId": "string" }, "assetTransitionType": "measurement|userInput", "assetState": { "newState": "string", "previousState": "string" }, "closureCode": { "failureMode": "string", "failureCause": "string", "actionTaken": "string", "resolvedModels": list<"string"> }, "assetPositionId": "string" } } Understanding the v2 data export schema 396 Amazon Monitron v2 schema parameters User Guide The Amazon Monitron Kinesis data export schema v2 includes the following schema parameters. Some parameters are updates from v1 and some are unique to v2. For example, siteName was a first-level parameter in v1. In v2, it is a second-level parameter that can be found under the eventPayload entity. timestamp • The timestamp when the measurement is received by Amazon Monitron service in UTC • Type: String • Pattern: yyyy-mm-dd hh:mm:ss.SSS eventId • The unique data export event ID assigned for each measurement. Can be used to deduplicate the Kinesis stream records received. • Type: String version • Schema version • Type: String • Value: 1.0 or 2.0 accountId • The 12-digit AWS account ID for your Monitron project • Type: String projectName The project name displayed in the app and console. Type: String projectId The unique ID of your Amazon Monitron project. Type: String eventType • The current event stream. Each event type will have a dedicated eventPayload format. Understanding the v2 data export schema 397 Amazon Monitron • Type: String User Guide • Possible values: measurement, gatewayConnected, gatewayDisconnected, sensorConnected, sensorDisconnected, assetStateTransition. eventType: measurement eventPayload.features.acceleration.band0To6000Hz.xAxis.rms • The root mean square of the acceleration observed in the frequency band 0–6000 Hz in the x axis • Type: Number • Unit: m/s^2 eventPayload.features.acceleration.band0To6000Hz.yAxis.rms • The root mean square of the acceleration observed in the frequency band 0–6000 Hz in the y axis • Type: Number • Unit: m/s^2 eventPayload.features.acceleration.band0To6000Hz.zAxis.rms • The root mean square of the acceleration observed in the frequency band 0–6000 Hz in the z axis • Type: Number • Unit: m/s^2 eventPayload.features.acceleration.band10To1000Hz.resultantVector.absMax • The absolute maximum acceleration observed in the frequency band 10–1000 Hz • Type: Number • Unit: m/s^2 eventPayload.features.acceleration.band10To1000Hz.resultantVector.absMin • The absolute minimum acceleration observed in the frequency band 10–1000 Hz • Type: Number • Unit: m/s^2 eventPayload.features.acceleration.band10To1000Hz.resultantVector.crestFactor • The acceleration crest factor observed in the frequency band 10–1000 Hz • Type: Number Understanding the v2 data export schema 398 Amazon Monitron User Guide eventPayload.features.acceleration.band10To1000Hz.resultantVector.rms • The root mean square of the acceleration observed in the frequency band 10–1000 Hz • Type: Number • m/s^2 eventPayload.features.acceleration.band10To1000Hz.xAxis.rms • The root mean square of the acceleration observed in the frequency band 10–1000 Hz in the x axis • Type: Number • m/s^2 eventPayload.features.acceleration.band10To1000Hz.yAxis.rms • The root mean square of the acceleration observed in the frequency band 10–1000 Hz in the y axis • Type: Number • m/s^2 eventPayload.features.acceleration.band10To1000Hz.zAxis.rms • The root mean square of the acceleration observed in the frequency band 10–1000 Hz in the z axis • Type: Number • m/s^2 eventPayload.features.temperature • The temperature observed • Type: Number • °C/degC eventPayload.features.velocity.band10To1000Hz.resultantVector.absMax • The absolute maximum velocity observed in the frequency band 10–1000 Hz • Type: Number • mm/s eventPayload.features.velocity.band10To1000Hz.resultantVector.absMin • The absolute minimum velocity observed in the frequency band 10–1000 Hz • Type: Number Understanding the v2 data export schema 399 Amazon Monitron • mm/s User Guide eventPayload.features.velocity.band10To1000Hz.resultantVector.crestFactor • The velocity crest factor observed in the frequency band 10–1000 Hz • Type: Number eventPayload.features.velocity.band10To1000Hz.resultantVector.rms • The root mean square of the velocity observed in the frequency band 10–1000 Hz • Type: Number • mm/s eventPayload.features.velocity.band10To1000Hz.xAxis.rms • The root mean square of the velocity observed in the frequency band 10–1000 Hz in the x axis • Type: Number • mm/s eventPayload.features.velocity.band10To1000Hz.yAxis.rms • The root mean square of the velocity observed in the frequency band 10–1000 Hz in the y axis • Type: Number • mm/s eventPayload.features.velocity.band10To1000Hz.zAxis.rms • The root mean square of the velocity observed in the frequency band 10–1000 Hz in the z axis • Type: Number • mm/s eventPayload.sequenceNo • The measurement sequence number • Type: Number eventPayload.assetPositionId • The identifier of the sensor position for which the measurement is sent. • Type: String eventPayload.companyName • The name of the company using the asset. Understanding the v2 data export schema 400 User Guide Amazon Monitron • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventPayload.serialNumber • The serial number of the asset. • Type: String eventPayload.make • The make of the asset. • Type: String eventPayload.model • The model of the asset. • Type: String eventType: sensorConnected siteName • The site name |
AmazonMonitronUG-066 | AmazonMonitronUG.pdf | 66 | sent. • Type: String eventPayload.companyName • The name of the company using the asset. Understanding the v2 data export schema 400 User Guide Amazon Monitron • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventPayload.serialNumber • The serial number of the asset. • Type: String eventPayload.make • The make of the asset. • Type: String eventPayload.model • The model of the asset. • Type: String eventType: sensorConnected siteName • The site name displayed in the app • Type: String assetName • The asset name displayed in the app • Type: String positionName • The sensor position name displayed in the app Understanding the v2 data export schema 401 User Guide Amazon Monitron • Type: String assetPositionURL • The sensor URL displayed in the app • Type: String physicalID • The physical ID of the sensor from which the measurement is sent • Type: String eventPayload.assetPositionId • The identifier of the sensor position whose state changed. • Type: String eventPayload.companyName • The name of the company using the asset. • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventPayload.serialNumber • The serial number of the asset. • Type: String eventPayload.make • The make of the asset. • Type: String eventPayload.model • The model of the asset. Understanding the v2 data export schema 402 User Guide Amazon Monitron • Type: String eventType: sensorDisconnected siteName • The site name displayed in the app • Type: String assetName • The asset name displayed in the app • Type: String positionName • The sensor position name displayed in the app • Type: String assetPositionURL • The sensor URL displayed in the app • Type: String physicalID • The physical ID of the sensor from which the measurement is sent • Type: String eventPayload.assetPositionId • The identifier of the sensor position whose state changed. • Type: String eventPayload.companyName • The name of the company using the asset. • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number Understanding the v2 data export schema 403 User Guide Amazon Monitron eventPayload.address • The address of the site. • Type: String eventPayload.serialNumber • The serial number of the asset. • Type: String eventPayload.make • The make of the asset. • Type: String eventPayload.model • The model of the asset. • Type: String eventType: gatewayConnected eventPayload.siteName • The site name displayed in the app • Type: String eventPayload.gatewayName • The name of the gateway as displayed in the app • Type: String eventPayload.gatewayListURL • The gateway URL displayed in the app • Type: String eventPayload.gateway.physicalID • The physical ID of the gateway just connected to transmit data to the Amazon Monitron service • Type: String eventPayload.companyName • The name of the company using the asset. • Type: String Understanding the v2 data export schema 404 Amazon Monitron User Guide eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventType: gatewayDisconnected siteName • The site name displayed in the app • Type: String gatewayName • The name of the gateway as displayed in the app • Type: String gatewayListURL • The gateway URL displayed in the app • Type: String physicalID • The physical ID of the gateway just connected to transmit data to the Amazon Monitron service • Type: String eventPayload.companyName • The name of the company using the asset. • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number Understanding the v2 data export schema 405 Amazon Monitron User Guide eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventType: assetStateTransition eventPayload.siteName • The site name displayed in the app • Type: String eventPayload.assetName • The asset name displayed in the app • Type: String eventPayload.positionName • The sensor position name displayed in the app • Type: String eventPayload.assetPositionURL • The sensor URL displayed in the app • Type: String eventPayload.sensor.physicalID • The physical ID of the sensor from which the measurement is sent • Type: String eventPayload.assetTransitionType • The reason behind the asset state transition • Type: String • Possible values: measurement or userInput eventPayload.assetState.newState • The new state of the asset Understanding the v2 data export schema 406 Amazon Monitron • Type: String eventPayload.assetState.previousState • The previous state of the asset |
AmazonMonitronUG-067 | AmazonMonitronUG.pdf | 67 | eventPayload.assetName • The asset name displayed in the app • Type: String eventPayload.positionName • The sensor position name displayed in the app • Type: String eventPayload.assetPositionURL • The sensor URL displayed in the app • Type: String eventPayload.sensor.physicalID • The physical ID of the sensor from which the measurement is sent • Type: String eventPayload.assetTransitionType • The reason behind the asset state transition • Type: String • Possible values: measurement or userInput eventPayload.assetState.newState • The new state of the asset Understanding the v2 data export schema 406 Amazon Monitron • Type: String eventPayload.assetState.previousState • The previous state of the asset • Type: String eventPayload.closureCode.failureMode User Guide • The failure mode selected by the user when acknowledging this failure • Type: String • Possible values: NO_ISSUE | BLOCKAGE | CAVITATION | CORROSION | DEPOSIT | IMBALANCE | LUBRICATION | MISALIGNMENT | OTHER | RESONANCE | ROTATING_LOOSENESS | STRUCTURAL_LOOSENESS | TRANSMITTED_FAULT | UNDETERMINED eventPayload.closureCode.failureCause • The cause of the failure as selected by the user in the app dropdown when acknowledging a failure. • Type: String • Possible values: ADMINISTRATION | DESIGN | FABRICATION | MAINTENANCE | OPERATION | OTHER | QUALITY | UNDETERMINED | WEAR eventPayload.closureCode.actionTaken • The action taken when closing this anomaly, as selected by the user in the app dropdown. • Type: String • Possible values: ADJUST | CLEAN | LUBRICATE | MODIFY | NO_ACTION | OTHER | OVERHAUL | REPLACE eventPayload.closureCode.resolvedModels • The set of models which called out the issue. • Type: List of Strings • Possible values: vibrationISO | vibrationML | temperatureML eventPayload.assetPositionId • The identifier of the asset position whose state changed. • Type: String models.temperatureML.persistentClassificationOutput • The persistent classification output from the machine learning based temperature model Understanding the v2 data export schema 407 Amazon Monitron • Type: Number • Valid Values: UNKNOWN | HEALTHY | WARNING | ALARM models.temperatureML.pointwiseClassificationOutput User Guide • The point–wise classification output from the machine learning based temperature model • Type: String • Valid Values: UNKNOWN | INITIALIZING | HEALTHY | WARNING | ALARM models.vibrationISO.isoClass • The ISO 20816 class (a standard for measurement and evaluation of machine vibration) used by the ISO based vibration model • Type: String • Valid Values: CLASS1 | CLASS2 | CLASS3 | CLASS4 models.vibrationISO.mutedThreshold • The threshold to mute the notification from the ISO based vibration model • Type: String • Valid Values: WARNING | ALARM models.vibrationISO.persistentClassificationOutput • The persistent classification output from the ISO based vibration model • Type: String • Valid Values: UNKNOWN | HEALTHY | WARNING | ALARM models.vibrationISO.pointwiseClassificationOutput • The point–wise classification output from the the ISO based vibration model • Type: String • Valid Values: UNKNOWN | HEALTHY | WARNING | ALARM | MUTED_WARNING | MUTED_ALARM models.vibrationML.persistentClassificationOutput • The persistent classification output from the machine learning based vibration model • Type: String • Valid Values: UNKNOWN | HEALTHY | WARNING | ALARM models.vibrationML.pointwiseClassificationOutput • The point–wise classification output from the machine learning based vibration model Understanding the v2 data export schema 408 Amazon Monitron • Type: String User Guide • Valid Values: UNKNOWN | INITIALIZING | HEALTHY | WARNING | ALARM assetState.newState • The machine status after processing the measurement • Type: String • Valid Values: UNKNOWN | HEALTHY | NEEDS_MAINTENANCE | WARNING | ALARM assetState.previousState • The machine status before processing the measurement • Type: String • Valid Values: UNKNOWN | HEALTHY | NEEDS_MAINTENANCE | WARNING | ALARM eventPayload.companyName • The name of the company using the asset. • Type: String eventPayload.geoLocation.latitude • The latitude of the site's physical location. • Type: Number eventPayload.geoLocation.longitude • The longitude of the site's physical location. • Type: Number eventPayload.address • The address of the site. • Type: String eventPayload.serialNumber • The serial number of the asset. • Type: String eventPayload.make • The make of the asset. • Type: String eventPayload.model • The model of the asset. Understanding the v2 data export schema 409 Amazon Monitron • Type: String Migration from Kinesis v1 to v2 User Guide If you are currently using the v1 data schema, you may already be sending data to Amazon S3, or further processing the data stream payload with Lambda. Topics • Updating the data schema to v2 • Updating data processing with Lambda Updating the data schema to v2 If you have already configured a data stream with the v1 schema, you can update your data export process by doing the following: 1. Open your Amazon Monitron console. 2. Navigate to your project. 3. 4. 5. Stop the current live data export. Start the live data export to create a new data stream. Select the newly created data stream. 6. Choose start live data export. At this point, the new schema will send your payload through the data stream. 7. (Optional) Go to the Kinesis console and delete your old data stream. 8. Configure a |
AmazonMonitronUG-068 | AmazonMonitronUG.pdf | 68 | data schema to v2 If you have already configured a data stream with the v1 schema, you can update your data export process by doing the following: 1. Open your Amazon Monitron console. 2. Navigate to your project. 3. 4. 5. Stop the current live data export. Start the live data export to create a new data stream. Select the newly created data stream. 6. Choose start live data export. At this point, the new schema will send your payload through the data stream. 7. (Optional) Go to the Kinesis console and delete your old data stream. 8. Configure a new delivery method for your newly created data stream with the v2 schema. Your new stream now delivers payloads conforming to the v2 schema to your new bucket. We recommend using two distinct buckets to have a consistent format in case you want to process all the data in these buckets. For example, using other services such as Athena and AWS Glue. Note If you were delivering your data to Amazon S3, learn how to store exported data in Amazon S3 for details on how to deliver your data to Amazon S3 with the v2 schema. Migration from Kinesis v1 to v2 410 Amazon Monitron Note User Guide If you were using a Lambda function to process your payloads, learn how to process data with Lambda. You can also refer to the updating with Lambda section for more information. Updating data processing with Lambda Updating the data processing with Lambda requires you to consider that the v2 data stream is now event-based. Your initial v1 Lambda code may have been similar to the following: import base64 def main_handler(event): # Kinesis "data" blob is base64 encoded so decode here: for record in event['Records']: payload = base64.b64decode(record["kinesis"]["data"]) measurement = payload["measurement"] projectDisplayName = payload["projectDisplayName"] # Process the content of the measurement # ... Since the v1 data schema is on a deprecation path, the previous Lambda code won't work with all the new data streams. The following Python sample code will process events from Kinesis stream with the data schema v2. This code uses the new eventType parameter to orient the processing to the appropriate handler: import base64 handlers = { "measurement": measurementEventHandler, "gatewayConnected": gatewayConnectedEventHandler, "gatewayDisconnected": gatewayDisconnectedEventHandler, "sensorConnected": sensorConnectedEventHandler, "sensorDisconnected": sensorDisconnectedEventHandler, } Migration from Kinesis v1 to v2 411 Amazon Monitron User Guide def main_handler(event): # Kinesis "data" blob is base64 encoded so decode here: for record in event['Records']: payload = base64.b64decode(record["kinesis"]["data"]) eventType = payload["eventType"] if eventType not in handler.keys(): log.info("No event handler found for the event type: {event['eventType']}") return # Invoke the appropriate handler based on the event type. eventPayload = payload["eventPayload"] eventHandler = handlers[eventType] eventHandler(eventPayload) def measurementEventHandler(measurementEventPayload): # Handle measurement event projectName = measurementEventPayload["projectName"] # ... def gatewayConnectedEventHandler(gatewayConnectedEventPayload): # Handle gateway connected event # Other event handler functions Migration from Kinesis v1 to v2 412 Amazon Monitron User Guide Monitoring costs Amazon Monitron assigns AWS–generated tags to each sensor: a project tag and a site tag. If you use AWS Cost Explorer, you can use these assigned tag values to get cost reports filtered to specific Amazon Monitron projects and sites. Topics • Conceptual overview • Billing tag keys and tag values • Retrieving project tag values • Retrieving site tag values • Activating billing tags • Viewing cost reports Conceptual overview When you set up Amazon Monitron, you create a project in which you configure and install your Amazon Monitron resources. Every project, in turn, can be linked to mutliple sites, or organized collections of assets, gateways, and sensors linked together based on either a common location or function. Each site can contain multiple Amazon Monitron sensors, attached to multiple assets or machines, transmitting the asset data collected through multiple gateways. While all your sites, assets, gateways, and sensors exist conveniently within one project, your Amazon Monitron setup might be more distributed in practice. For example, your company may own one project to monitor sites located in different geographical locations, or grouped together by different business use cases and needs. Or you may own multiple projects, each with its own specific configuration. Partners who integrate Amazon Monitron, may also wish to assign a project to each of their own customers While getting an overall understanding of your Amazon Monitron costs is useful, what your business may need is a more granular understanding of the usage and costs attached to each project, location, or business use case. This may also be necessary for internal cost allocation purpose between different divisions. Conceptual overview 413 Amazon Monitron User Guide In these situations, using Amazon Monitron assigned AWS–generated tags in AWS Cost Explorer can help you understand and plan your business resources better. Billing tag keys and tag values Amazon Monitron uses AWS–generated tags to internally assign project and site level tag values. You |
AmazonMonitronUG-069 | AmazonMonitronUG.pdf | 69 | While getting an overall understanding of your Amazon Monitron costs is useful, what your business may need is a more granular understanding of the usage and costs attached to each project, location, or business use case. This may also be necessary for internal cost allocation purpose between different divisions. Conceptual overview 413 Amazon Monitron User Guide In these situations, using Amazon Monitron assigned AWS–generated tags in AWS Cost Explorer can help you understand and plan your business resources better. Billing tag keys and tag values Amazon Monitron uses AWS–generated tags to internally assign project and site level tag values. You can use these tags to find your projects and sites on the AWS Cost Explorer console. The tag keys are of the following format: • Project – aws:monitron:project • Site – aws:monitron:location_level4 Retrieving project tag values You can retrieve your assigned project value using your Amazon Monitron web app. The tag value for your project is the project ID. To retrieve the specific tag value assigned to your Amazon Monitron project: 1. Open the Amazon Monitron console at https://console.aws.amazon.com/monitron. 2. Choose Create Project. 3. In the navigation pane, choose Projects. The list of projects is displayed under Projects. Billing tag keys and tag values 414 Amazon Monitron User Guide 4. Choose the project that you want to get details on. 5. Copy the tag value from your Project Id. You can use this project id to filter costs in AWS Cost Explorer console. Retrieving site tag values You can retrieve your assigned site tag value using your Amazon Monitron web app. The tag value for your site is the Id. To retrieve the specific tag value assigned to your Amazon Monitron site: 1. Open the Amazon Monitron console at https://console.aws.amazon.com/monitron. 2. Choose Create project. 3. If you're creating a project for the first time, follow the steps outlined in Creating a project. If you're choosing an existing project, from the left navigation menu, select Projects, and then select the project you want to create custom asset classes for. 4. From the project details page, choose Open in Amazon Monitron web app. Retrieving site tag values 415 Amazon Monitron User Guide 5. From the left navigation pane, choose Sites. The list of sites is displayed. 6. Choose the site that you want to get details on. 7. Copy the tag value from your Id. You can use this id to filter costs in AWS Cost Explorer console. Activating billing tags To begin using project and site level cost tracker tags, you must do the following: Activating billing tags 416 Amazon Monitron User Guide 1. Prerequisite – You must activate AWS Cost Explorer on the AWS Management Console. This requires minimal setup. We recommend you follow the steps outlined in the AWS Cost Management guide. 2. Activate the Amazon Monitron AWS–generated tags in your AWS billing account. From your AWS Billing and Cost Management left navigation pane: a. From Cost Organization, select Cost allocation tags. You will find the AWS generated cost allocation tags in this section. b. Select the tags you want to use and choose Activate. Note It takes up to 96 hours for the tags to be activated. The billing data starts being tagged only after the tags are active. Activating billing tags 417 Amazon Monitron User Guide Viewing cost reports After your Amazon Monitron AWS generated tags have been activated and are active, you can view usage and cost reports filtered by these tags using AWS Cost Explorer on the AWS Cost Management console. You can filter usage and cost history by choosing a tag key value pair. For example, if you want to view usage reports a particular project, you would first choose a tag value aws:monitron:project and then select the project id value from the options available. To generate cost and usage reports 1. Open the AWS Cost Management console at https://console.aws.amazon.com/ 2. 3. 4. costmanagement. From the left navigation pane, select Cost Explorer. From the New cost and usage report page, from the right navigation menu, in Filters, choose Amazon Monitron as the Service. From the right navigation menu, for Tags choose the assigned tag key for your project or site from the dropdown options. 5. Then, choose the Amazon Monitron assigned tag value for your project or site. Viewing cost reports 418 Amazon Monitron Note User Guide You can save the report with the filters selected to the report library to easily review it later. You can also adjust and customize your report further, including the date range and granularity of your report. Viewing cost reports 419 Amazon Monitron User Guide App settings This section shows you how to change your Amazon Monitron app and console settings. Topics • Localization settings Localization settings The Amazon Monitron app detects your device’s location from your web |
AmazonMonitronUG-070 | AmazonMonitronUG.pdf | 70 | 5. Then, choose the Amazon Monitron assigned tag value for your project or site. Viewing cost reports 418 Amazon Monitron Note User Guide You can save the report with the filters selected to the report library to easily review it later. You can also adjust and customize your report further, including the date range and granularity of your report. Viewing cost reports 419 Amazon Monitron User Guide App settings This section shows you how to change your Amazon Monitron app and console settings. Topics • Localization settings Localization settings The Amazon Monitron app detects your device’s location from your web browser or phone and uses this information to populate default settings in the app. Default settings for the Amazon Monitron include: language, date/time format, and number format (commas vs. decimals). Languages currently supported by Amazon Monitron include: • English • French • Spanish • Portuguese (BR) Any languages supported in the application are also supported in the console. When a language is not available for a particular area, the Amazon Monitron app will default to English, and US units/number format. The app will detect your location once and then use these defaults until you manually change them. Changing localization settings You can change your Amazon Monitron language settings for both the web and mobile apps, and the console. To change localization settings 1. Update and save your language, measurement, and temperature settings in the Settings menu of the app. Localization settings 420 Amazon Monitron User Guide Important Any changes you make to the language or units setting will be saved locally in the browser and will be applied to any project you open in the same browser. These changes are not shared across devices. Changing localization settings 421 Amazon Monitron User Guide a web app view 2. Choose Save. 3. You will see the following alert banner if you change two or more settings: a mobile app view Changing localization settings 422 Amazon Monitron User Guide a web app view 4. You will see the following alert if you leave the settings menu without saving: a mobile app view Changing localization settings 423 Amazon Monitron User Guide a web app view a mobile app view Changing localization settings 424 Amazon Monitron User Guide Logging Amazon Monitron actions with AWS CloudTrail Amazon Monitron is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amazon Monitron. CloudTrail captures API calls for Amazon Monitron as events. CloudTrail captures calls from both the Amazon Monitron console and the Amazon Monitron mobile app. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket, including events for Amazon Monitron. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the console or mobile app request that was made to Amazon Monitron, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, including how to configure and enable it, see the AWS CloudTrail User Guide. Topics • Amazon Monitron information in CloudTrail • Example: Amazon Monitron log file entries Amazon Monitron information in CloudTrail CloudTrail is enabled for your AWS users when you create your account. When supported event activity occurs in Amazon Monitron, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing Events with CloudTrail Event History. For an ongoing record of events in your AWS account, including events for Amazon Monitron, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for Creating a Trail • CloudTrail Supported Services and Integrations Amazon Monitron information in CloudTrail 425 Amazon Monitron User Guide • Configuring Amazon SNS Notifications for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts Amazon Monitron supports logging a number of actions as events. Although the operations are publicly accessible through the AWS console or the Amazon Monitron mobile app, the APIs themselves are not public and are subject to change. They are meant for |
AmazonMonitronUG-071 | AmazonMonitronUG.pdf | 71 | upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for Creating a Trail • CloudTrail Supported Services and Integrations Amazon Monitron information in CloudTrail 425 Amazon Monitron User Guide • Configuring Amazon SNS Notifications for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts Amazon Monitron supports logging a number of actions as events. Although the operations are publicly accessible through the AWS console or the Amazon Monitron mobile app, the APIs themselves are not public and are subject to change. They are meant for logging purposes only, and applications should not be built with them. Amazon Monitron supports the following actions as events in CloudTrail log files: • CreateProject • UpdateProject • DeleteProject • GetProject • ListProjects • AssociateProjectAdminUser • DisassociateProjectAdminUser • ListProjectAdminUsers • GetProjectAdminUser • TagResource • UntagResource • ListTagsForResource • CreateSensor • UpdateSensor • DeleteSensor • CreateGateway • DeleteGateway • CreateSite • UpdateSite • DeleteSite • CreateAsset Amazon Monitron information in CloudTrail 426 User Guide Amazon Monitron • UpdateAsset • DeleteAsset • CreateAssetStateTransition • CreateUserAccessRoleAssociation • UpdateUserAccessRoleAssociation • DeleteUserAccessRoleAssociation • FinishSensorCommissioning • StartSensorCommissioning Every event or log entry contains information about who generated the request. This contains details about the type of IAM identity that made the request, and which credentials were used. If temporary credentials were used, the element shows how the credentials were obtained. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials • Whether the request was made with temporary security credentials for a role or federated user • Whether the request was made by another AWS service For more information, see the CloudTrail userIdentity Element in the AWS CloudTrail User Guide. Example: Amazon Monitron log file entries A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order. The following examples show CloudTrail log entries that demonstrate the project deletion (DeleteProject) action. Topics • Successful DeleteProject action Example: Amazon Monitron log file entries 427 Amazon Monitron User Guide • Failed DeleteProject action (authorization error) • Failed DeleteProject action (conflict exception error) Successful DeleteProject action The following example show what might appear in the CloudTrail log following a successful DeleteProject action. { "eventVersion": "1.05", "userIdentity": { "type": "AssumedRole", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "accessKeyId": "access key ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "userName": "user name" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "timestamp" } } }, "eventTime": "timestamp", "eventSource": "monitron.amazonaws.com", "eventName": "DeleteProject", "awsRegion": "region", "sourceIPAddress": "source IP address", "userAgent": "user agent", "requestParameters": { "Name": "name" }, "responseElements": { "Name": "name" Successful DeleteProject action 428 Amazon Monitron }, "requestID": "request ID", "eventID": "event ID", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "account ID" } User Guide Failed DeleteProject action (authorization error) The following example shows what might appear in the CloudTrail log following a failed DeleteProject action due to an error occurring. In this case, the error is an authorization error, where the user does not have permission to delete the specified project. { "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "accessKeyId": "access key ID", "userName": "user name", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "timestamp" } } }, "eventTime": "timestamp", "eventSource": "monitron.amazonaws.com", "eventName": "DeleteProject", "awsRegion": "region", "sourceIPAddress": "source IP address", "userAgent": "user agent", "errorCode": "AccessDenied", "requestParameters": { "Name": "name" }, "responseElements": { Failed DeleteProject action (authorization error) 429 Amazon Monitron User Guide "Message": "User: user ARN is not authorized to perform: monitron:DeleteProject on resource: resource ARN" }, "requestID": "request ID", "eventID": "event ID", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "account ID" } Failed DeleteProject action (conflict exception error) The following example shows what might appear in the CloudTrail log following a failed DeleteProject action due to an error occurring. In this case, the error is a conflict exception, where sensors are still present when Amazon Monitron attempts to delete a project. { "eventVersion": "1.05", "userIdentity": { "type": "AssumedRole", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "accessKeyId": "access key ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "userName": "user name" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "timestamp" } } }, "eventTime": "timestamp", "eventSource": "monitron.amazonaws.com", "eventName": "DeleteProject", "awsRegion": "region", Failed DeleteProject action (conflict exception error) 430 |
AmazonMonitronUG-072 | AmazonMonitronUG.pdf | 72 | appear in the CloudTrail log following a failed DeleteProject action due to an error occurring. In this case, the error is a conflict exception, where sensors are still present when Amazon Monitron attempts to delete a project. { "eventVersion": "1.05", "userIdentity": { "type": "AssumedRole", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "accessKeyId": "access key ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "principal ID", "arn": "ARN", "accountId": "account ID", "userName": "user name" }, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "timestamp" } } }, "eventTime": "timestamp", "eventSource": "monitron.amazonaws.com", "eventName": "DeleteProject", "awsRegion": "region", Failed DeleteProject action (conflict exception error) 430 Amazon Monitron User Guide "sourceIPAddress": "source IP address", "userAgent": "user agent", "errorCode": "ConflictException", "requestParameters": { "Name": "name" }, "responseElements": { "message": "This project still has sensors associated to it and cannot be deleted." }, "requestID": "request ID", "eventID": "event ID", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "account ID" } Failed DeleteProject action (conflict exception error) 431 Amazon Monitron User Guide Security in Amazon Monitron Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to Amazon Monitron, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors, including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Amazon Monitron. The following topics show you how to configure Amazon Monitron to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Amazon Monitron resources. Topics • Data protection in Amazon Monitron • Identity and Access Management for Amazon Monitron • Logging and Monitoring in Amazon Monitron • Compliance Validation for Amazon Monitron • Infrastructure Security in Amazon Monitron • Security Best Practices for Amazon Monitron Data protection in Amazon Monitron Amazon Monitron conforms to the AWS shared responsibility model, which includes regulations and guidelines for data protection. AWS is responsible for protecting the global infrastructure that Data Protection 432 Amazon Monitron User Guide runs all the AWS services. AWS maintains control over data hosted on this infrastructure, including the security configuration controls for handling customer content and personal data. AWS customers and APN partners, acting either as data controllers or data processors, are responsible for any personal data that they put in the AWS Cloud. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS Identity and Access Management (IAM), so that each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use TLS (Transport Layer Security) to communicate with AWS resources. • Set up API and user activity logging with AWS CloudTrail. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon S3. We strongly recommend that you never put sensitive identifying information, such as your customers' account numbers, into free-form fields such as a Name field. This includes when you work with Amazon Monitron or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into Amazon Monitron or other services might get picked up for inclusion in diagnostic logs. When you provide a URL to an external server, don't include credentials information in the URL to validate your request to that server. For more information about data protection, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. Topics • Data at rest • Data in transit • AWS KMS and data encryption in Amazon Monitron Data Protection 433 Amazon Monitron Data at rest User Guide Your data is encrypted at rest in the cloud using one of two types of keys through AWS Key Management Service (AWS KMS). The data is encrypted in Amazon Simple Storage Service |
AmazonMonitronUG-073 | AmazonMonitronUG.pdf | 73 | URL to an external server, don't include credentials information in the URL to validate your request to that server. For more information about data protection, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. Topics • Data at rest • Data in transit • AWS KMS and data encryption in Amazon Monitron Data Protection 433 Amazon Monitron Data at rest User Guide Your data is encrypted at rest in the cloud using one of two types of keys through AWS Key Management Service (AWS KMS). The data is encrypted in Amazon Simple Storage Service (Amazon S3) using an AWS owned key. Amazon Monitron also stores data in tables in Amazon DynamoDB. By default, these are encrypted using an AWS owned CMK. However, if a customer chooses Custom encryption settings when setting up a project, Amazon Monitron uses a customer managed CMK. See also ???. Data in transit Amazon Monitron uses TLS (Transport Layer Security) to encrypt data that is transferred between your sensors and Amazon Monitron. AWS KMS and data encryption in Amazon Monitron Amazon Monitron encrypts your data and project information using one of two types of keys through AWS Key Management Service (AWS KMS). You can choose one of the following: • An AWS owned key. This is the default encryption key and is used if you do not choose Custom encryption settings when setting up your project. • A customer managed CMK. You can use an existing key in your AWS account or create a key in the AWS KMS console or using the API. If you're using an existing key, you choose Choose an AWS KMS key and then either choose a key from the list of AWS KMS keys, or enter the Amazon Resource Name (ARN) of another key. If you want to create a new key, you choose Create an AWS KMS key. For more information, see Creating Keys in the AWS Key Management Service Developer Guide. When using AWS KMS to encrypt your data, keep the following in mind: • Your data is encrypted at rest in the Cloud in Amazon S3 and Amazon DynamoDB. • When data is encrypted using an AWS owned CMK, Amazon Monitron uses a separate CMK for each customer. • IAM users must have the required permissions to call the AWS KMS API operations connected with Amazon Monitron. Amazon Monitron includes the following permissions in its managed policy for console use. Data at rest 434 Amazon Monitron User Guide { "Effect": "Allow", "Action": [ "kms:ListKeys", "kms:DescribeKey", "kms:ListAliases", "kms:CreateGrant" ], "Resource": "*" }, For more information, see Using IAM Policies with AWS KMS in the AWS Key Management Service Developer Guide. • If you delete or disable your CMK, you won't be able to access the data. For more information, see Deleting AWS KMS keys in the AWS Key Management Service Developer Guide. Identity and Access Management for Amazon Monitron AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon Monitron resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with Identities • Managing Access Using Policies • How Amazon Monitron Works with IAM • Using service-linked roles for Amazon Monitron Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in Amazon Monitron. Identity and Access Management 435 Amazon Monitron User Guide Service user – If you use the Amazon Monitron service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Amazon Monitron features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Amazon Monitron, see Troubleshooting Amazon Monitron Identity and Access. Service administrator – If you're in charge of Amazon Monitron resources at your company, you probably have full access to Amazon Monitron. It's your job to determine which Amazon Monitron features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon Monitron, see How Amazon Monitron Works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon Monitron. To view example Amazon Monitron identity-based policies that you can use in IAM, see Amazon Monitron Identity-Based Policy |
AmazonMonitronUG-074 | AmazonMonitronUG.pdf | 74 | resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon Monitron, see How Amazon Monitron Works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon Monitron. To view example Amazon Monitron identity-based policies that you can use in IAM, see Amazon Monitron Identity-Based Policy Examples. Authenticating with Identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the Authenticating with Identities 436 Amazon Monitron User Guide recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. Topics • AWS account root user • IAM users and Groups • IAM Roles AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. IAM users and Groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Authenticating with Identities 437 Amazon Monitron User Guide Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM Roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by |
AmazonMonitronUG-075 | AmazonMonitronUG.pdf | 75 | be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM Roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the Authenticating with Identities 438 Amazon Monitron User Guide principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing Access Using Policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines |
AmazonMonitronUG-076 | AmazonMonitronUG.pdf | 76 | instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing Access Using Policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. Managing Access Using Policies 439 Amazon Monitron User Guide IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Topics • Identity-Based Policies • Other Policy Types • Multiple Policy Types Identity-Based Policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Other Policy Types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a Managing Access Using Policies 440 Amazon Monitron User Guide service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary |
AmazonMonitronUG-077 | AmazonMonitronUG.pdf | 77 | the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple Policy Types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon Monitron Works with IAM Before you use IAM to manage access to Amazon Monitron, you should understand what IAM features are available to use with Amazon Monitron. To get a high-level view of how Amazon Monitron and other AWS services work with IAM, see AWS Services That Work with IAM in the IAM User Guide. Topics • Amazon Monitron Identity-Based Policies • Amazon Monitron Resource-Based Policies • Authorization Based on Amazon Monitron Tags • Amazon Monitron IAM Roles How Amazon Monitron Works with IAM 441 Amazon Monitron User Guide • Amazon Monitron Identity-Based Policy Examples • Troubleshooting Amazon Monitron Identity and Access Amazon Monitron Identity-Based Policies To specify allowed or denied actions and resources and the conditions under which actions are allowed or denied, use IAM identity-based policies. Amazon Monitron supports specific actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON Policy Elements Reference in the IAM User Guide. Topics • Actions • Resources • Condition Keys • Examples Actions Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. In Amazon Monitron, policy actions use the following prefix before the action: monitron:. For example, to grant someone permission to create a project with the Amazon Monitron CreateProject operation, you include the monitron:CreateProject action in their policy. Policy statements must include either an Action or NotAction element. Amazon Monitron defines its own set of actions that describe tasks that you can perform with this service. How Amazon Monitron Works with IAM 442 Amazon Monitron Note User Guide With the deleteProject operation, you must have the AWS IAM Identity Center (SSO) permissions for deletion. Without these permissions, the delete functionality will still remove the project. However, it will not remove the resources from SSO and you may end up with dangling references on SSO. To specify multiple actions in a single statement, separate them with commas as follows: "Action": [ "monitron:action1", "monitron:action2" ] You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word List, include the following action: "Action": "monitron:List*" Resources Amazon Monitron does not support specifying resource ARNs in a policy. Condition Keys Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How |
AmazonMonitronUG-078 | AmazonMonitronUG.pdf | 78 | you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How Amazon Monitron Works with IAM 443 Amazon Monitron User Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Amazon Monitron defines its own set of condition keys and also supports using some global condition keys. For a list of all AWS global condition keys, see AWS Global Condition Context Keys in the IAM User Guide. To see a list of Amazon Monitron condition keys, see Actions defined by Amazon Monitron in the IAM User Guide. To learn with which actions and resources you can use a condition key, see Condition keys for Amazon Monitron. Examples To view examples of Amazon Monitron identity-based policies, see Amazon Monitron Identity- Based Policy Examples. Amazon Monitron Resource-Based Policies Amazon Monitron does not support resource-based policies. Authorization Based on Amazon Monitron Tags You can associate tags with certain types of Amazon Monitron resources for authorization. To control access based on tags, provide tag information in the condition element of a policy using the Amazon Monitron:TagResource/${TagKey}, aws:RequestTag/${TagKey}, or aws:TagKeys condition keys. Amazon Monitron IAM Roles An IAM role is an entity within your AWS account that has specific permissions. Using Temporary Credentials with Amazon Monitron You can use temporary credentials to sign in with federation, assume an IAM role, or assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. Amazon Monitron supports using temporary credentials. How Amazon Monitron Works with IAM 444 Amazon Monitron Service-Linked Roles User Guide Service-linked roles allow AWS services to access resources in other services to complete an action on your behalf. Service-linked roles appear in your IAM account and are owned by the service. An IAM administrator can view but not edit the permissions for service-linked roles. Amazon Monitron supports service-linked roles. Service Roles This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service. Amazon Monitron supports service roles. Amazon Monitron Identity-Based Policy Examples By default, IAM users and roles don't have permission to create or modify Amazon Monitron resources. They also can't perform tasks using the AWS Management Console. An IAM administrator must give permissions to the IAM users, groups, or roles that require them. Then these users, groups, or roles can perform the specific operations on the specified resources they need. The administrator must then attach those policies to the IAM users or groups that require those permissions. To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating Policies on the JSON Tab in the IAM User Guide. Topics • Policy Best Practices • Using the Amazon Monitron Console • Example: List All Amazon Monitron Projects • Example: List Amazon Monitron Projects Based on Tags Policy Best Practices Identity-based policies determine whether someone can create, access, or delete Amazon Monitron resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: How Amazon Monitron Works with IAM 445 Amazon Monitron User Guide • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User |
AmazonMonitronUG-079 | AmazonMonitronUG.pdf | 79 | edit identity-based policies, follow these guidelines and recommendations: How Amazon Monitron Works with IAM 445 Amazon Monitron User Guide • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Amazon Monitron Console To set up Amazon Monitron using the console, please complete the initial setup process using a high privilege user (such as one with the AdministratorAccess managed policy attached). To access the Amazon Monitron console for day-to-day operations after the initial setup, you must have a minimum set of permissions. These permissions must allow you to list and view details How Amazon Monitron Works with IAM 446 Amazon Monitron User Guide about the Amazon Monitron resources in your AWS account and include a set of permissions related to IAM Identity Center. If you create an identity-based policy that is more restrictive than these minimum required permissions, the console won't function as intended for entities (IAM users or roles) with that policy. For basic Amazon Monitron Console functionality, you need to attach the AmazonMonitronFullAccess managed policy. Depending on the circumstances, you may also need additional permissions to the Organizations and SSO service. Contact AWS support if you need more information. Example: List All Amazon Monitron Projects This example policy grants an IAM user in your AWS account permission to list all projects in your account. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "monitron:ListProject" "Resource": "*" } ] } Example: List Amazon Monitron Projects Based on Tags You can use conditions in your identity-based policy to control access to Amazon Monitron resources based on tags. This example shows how you might create a policy that allows listing projects. However, permission is granted only if the project tag location has the value of Seattle. This policy also grants the permissions necessary to complete this action on the console. { "Version": "2012-10-17", "Statement": [ { "Sid": "ListProjectsInConsole", "Effect": "Allow", "Action": "monitron:ListProjects", "Resource": "*" "Condition": { How Amazon Monitron Works with IAM 447 Amazon Monitron User Guide "StringEquals": { "aws:ResourceTag/location": "Seattle" } } } ] } For more information, see IAM JSON Policy Elements: Condition in the IAM User Guide. Troubleshooting Amazon Monitron Identity and Access Use the following information to help you diagnose and fix common issues that you might encounter when working with Amazon Monitron and IAM. Topics • I Am Not Authorized to Perform an Action in Amazon Monitron • I Want to Allow People Outside of My AWS Account to Access My Amazon Monitron Resources I Am Not Authorized to Perform an Action in Amazon Monitron If you receive an error that you're not authorized to perform an |
AmazonMonitronUG-080 | AmazonMonitronUG.pdf | 80 | } } ] } For more information, see IAM JSON Policy Elements: Condition in the IAM User Guide. Troubleshooting Amazon Monitron Identity and Access Use the following information to help you diagnose and fix common issues that you might encounter when working with Amazon Monitron and IAM. Topics • I Am Not Authorized to Perform an Action in Amazon Monitron • I Want to Allow People Outside of My AWS Account to Access My Amazon Monitron Resources I Am Not Authorized to Perform an Action in Amazon Monitron If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional monitron:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: monitron:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the monitron:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I Want to Allow People Outside of My AWS Account to Access My Amazon Monitron Resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support How Amazon Monitron Works with IAM 448 Amazon Monitron User Guide resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether Amazon Monitron supports these features, see How Amazon Monitron Works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Using service-linked roles for Amazon Monitron Amazon Monitron uses AWS Identity and Access Management (IAM) service-linked roles. A service- linked role is a unique type of IAM role that is linked directly to Amazon Monitron. Service-linked roles are predefined by Amazon Monitron and include all the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up Amazon Monitron easier because you don’t have to manually add the necessary permissions. Amazon Monitron defines the permissions of its service- linked roles, and unless defined otherwise, only Amazon Monitron can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service. Topics • Service-linked role permissions for Amazon Monitron • Creating a service-linked role for Amazon Monitron • Editing a service-linked role for Amazon Monitron Using service-linked roles 449 Amazon Monitron User Guide • Deleting a service-linked role for Amazon Monitron • Supported regions for Amazon Monitron service-linked roles • AWS managed policies for Amazon Monitron • Amazon Monitron updates to AWS managed policies Service-linked role permissions for Amazon Monitron Amazon Monitron uses the service-linked role named AWSServiceRoleForMonitron[_{SUFFIX}] – Amazon Monitron uses AWSServiceRoleForMonitron to access other AWS services, including Cloudwatch Logs, Kinesis Data Streams, KMS keys, and SSO. For more information about the policy, see AWSServiceRoleForMonitronPolicy in the AWS Managed Policy Reference Guide The AWSServiceRoleForMonitron[_{SUFFIX}] service-linked role trusts the following services to assume the role: • monitron.amazonaws.com or core.monitron.amazonaws.com The role permissions policy named MonitronServiceRolePolicy allows Amazon Monitron to complete the following actions on the specified resources: • Action: Amazon CloudWatch Logs logs:CreateLogGroup, logs:CreateLogStream and logs:PutLogEvents on the CloudWatch log group, log stream, and log events under /aws/ monitron/* path The role permissions policy named MonitronServiceDataExport-KinesisDataStreamAccess allows Amazon Monitron to complete the following actions on the specified resources: • Action: Amazon Kinesis kinesis:PutRecord, kinesis:PutRecords, and kinesis:DescribeStream on the Kinesis data stream specified for live data export. • Action: Amazon AWS KMS kms:GenerateDataKey for the AWS KMS key used |
AmazonMonitronUG-081 | AmazonMonitronUG.pdf | 81 | the following services to assume the role: • monitron.amazonaws.com or core.monitron.amazonaws.com The role permissions policy named MonitronServiceRolePolicy allows Amazon Monitron to complete the following actions on the specified resources: • Action: Amazon CloudWatch Logs logs:CreateLogGroup, logs:CreateLogStream and logs:PutLogEvents on the CloudWatch log group, log stream, and log events under /aws/ monitron/* path The role permissions policy named MonitronServiceDataExport-KinesisDataStreamAccess allows Amazon Monitron to complete the following actions on the specified resources: • Action: Amazon Kinesis kinesis:PutRecord, kinesis:PutRecords, and kinesis:DescribeStream on the Kinesis data stream specified for live data export. • Action: Amazon AWS KMS kms:GenerateDataKey for the AWS KMS key used by the specified Kinesis data stream for live data export • Action: Amazon IAM iam:DeleteRole to delete the service-linked role itself when not used The role permissions policy named AWSServiceRoleForMonitronPolicy allows Amazon Monitron to complete the following actions on the specified resources: Using service-linked roles 450 Amazon Monitron User Guide • Action: IAM Identity Center sso:GetManagedApplicationInstance, sso:GetProfile, sso:ListProfiles, sso:AssociateProfile, sso:ListDirectoryAssociations, sso:ListProfileAssociations, sso-directory:DescribeUsers, sso- directory:SearchUsers, sso:CreateApplicationAssignment, and sso:ListApplicationAssignments to access IAM Identity Center users associated with the project Note Add sso:ListProfileAssociations to allow Amazon Monitron to list associations with the application instance underlying the Amazon Monitron Project. You must configure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. Creating a service-linked role for Amazon Monitron You don't need to manually create a service-linked role. When you enable a feature requiring your permissions to call other AWS services on your behalf in Amazon Monitron in the AWS Management Console, Amazon Monitron creates the service-linked role for you. Editing a service-linked role for Amazon Monitron Amazon Monitron does not allow you to edit the AWSServiceRoleForMonitron[_{SUFFIX}] service- linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide. Deleting a service-linked role for Amazon Monitron You don't need to manually delete the AWSServiceRoleForMonitron[_{SUFFIX}] role. When you delete a Amazon Monitron project that you created through Amazon Monitron in the AWS Management Console, Amazon Monitron cleans up the resources and deletes the service-linked role for you. Using service-linked roles 451 Amazon Monitron User Guide You can also use the IAM console, the AWS CLI or the AWS API to manually delete the service- linked role. To do this, you must first manually clean up the resources for your service-linked role and then you can manually delete it. Note If the Amazon Monitron service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To delete Amazon Monitron resources used by the AWSServiceRoleForMonitron[_{SUFFIX}] • Delete Amazon Monitron projects using this service-linked role. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForMonitron[_{SUFFIX}] service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide. Supported regions for Amazon Monitron service-linked roles Amazon Monitron supports using service-linked roles in all of the regions where the service is available. For more information, see AWS Regions and Endpoints. Amazon Monitron does not support using service-linked roles in every region where the service is available. You can use the AWSServiceRoleForMonitron[_{SUFFIX}] role in the following regions. Region name Region identity Support in Amazon Monitron US East (N. Virginia) US East (Ohio) US West (N. California) US West (Oregon) us-east-1 us-east-2 us-west-1 us-west-2 Yes No No No Using service-linked roles 452 Amazon Monitron Region name Asia Pacific (Mumbai) Asia Pacific (Osaka) Asia Pacific (Seoul) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Canada (Central) Europe (Frankfurt) Europe (Ireland) Europe (London) Europe (Paris) South America (São Paulo) Region identity Support in Amazon Monitron User Guide ap-south-1 ap-northeast-3 ap-northeast-2 ap-southeast-1 ap-southeast-2 ap-northeast-1 ca-central-1 eu-central-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 No No No No Yes No No No Yes No No No No AWS GovCloud (US) us-gov-west-1 AWS managed policies for Amazon Monitron You can attach AmazonMonitronFullAccess to your IAM entities. This policy grants administrative permissions that allow access to all Amazon Monitron resources and operations. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "*", Using service-linked roles 453 Amazon Monitron "Condition": { "StringEquals": { "iam:AWSServiceName": "monitron.amazonaws.com" User Guide } } }, { "Effect": "Allow", "Action": [ "monitron:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "kms:ListKeys", "kms:DescribeKey", "kms:ListAliases" ], "Resource": "*" }, { "Effect": "Allow", "Action": "kms:CreateGrant", "Resource": "*", "Condition": { "StringLike": { "kms:ViaService": [ "monitron.*.amazonaws.com" ] }, "Bool": { "kms:GrantIsForAWSResource": true } } |
AmazonMonitronUG-082 | AmazonMonitronUG.pdf | 82 | policies for Amazon Monitron You can attach AmazonMonitronFullAccess to your IAM entities. This policy grants administrative permissions that allow access to all Amazon Monitron resources and operations. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "*", Using service-linked roles 453 Amazon Monitron "Condition": { "StringEquals": { "iam:AWSServiceName": "monitron.amazonaws.com" User Guide } } }, { "Effect": "Allow", "Action": [ "monitron:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "kms:ListKeys", "kms:DescribeKey", "kms:ListAliases" ], "Resource": "*" }, { "Effect": "Allow", "Action": "kms:CreateGrant", "Resource": "*", "Condition": { "StringLike": { "kms:ViaService": [ "monitron.*.amazonaws.com" ] }, "Bool": { "kms:GrantIsForAWSResource": true } } }, { "Sid": "AWSSSOPermissions", "Effect": "Allow", "Action": [ "organizations:DescribeAccount", "organizations:DescribeOrganization", "ds:DescribeDirectories", Using service-linked roles 454 Amazon Monitron User Guide "ds:DescribeTrusts" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "kinesis:DescribeStream", "kinesis:ListStreams" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:GetLogEvents", "logs:CreateLogGroup" ], "Resource": "arn:aws:logs:*:*:log-group:/aws/monitron/*" }, ] } Amazon Monitron updates to AWS managed policies View details about updates to AWS managed policies for Amazon Monitron since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Amazon Monitron document history page. Change Description Date AWSServiceRoleForM onitronPolicy - Update to an existing policy Added sso:Creat September 30, 2024 eApplicationAssign ment and sso:ListA pplicationAssignme nts to role permissions policy. Using service-linked roles 455 Amazon Monitron Change Description Date User Guide AmazonMonitronFullAccess - Update to an existing policy Amazon Monitron added permissions to describe and June 8, 2022 list Kinesis Data Streams, and describe get, and create CloudWatch log groups, log streams, and log events. You must use these permissio ns to use the Amazon Monitron console to display information about Kinesis Data Streams and CloudWatc h Logs. Logging and Monitoring in Amazon Monitron Monitoring is an important part of maintaining the reliability, availability, and performance of your Amazon Monitron applications. To monitor Amazon Monitron console and mobile app actions, you can use AWS CloudTrail. CloudTrail logs provide a record of actions taken by a user, role, or an AWS service in Amazon Monitron. Using the information collected by CloudTrail, you can determine the request that was made to Amazon Monitron, the IP address from which the request was made, who made the request, when it was made, and additional details. For more information, see Logging Amazon Monitron actions with AWS CloudTrail. Compliance Validation for Amazon Monitron To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Logging and Monitoring 456 Amazon Monitron User Guide Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Infrastructure Security in Amazon Monitron As a managed service, Amazon Monitron is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS |
AmazonMonitronUG-083 | AmazonMonitronUG.pdf | 83 | detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Infrastructure Security in Amazon Monitron As a managed service, Amazon Monitron is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. Infrastructure Security 457 Amazon Monitron User Guide You use AWS published API calls to access Amazon Monitron through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Security Best Practices for Amazon Monitron Amazon Monitron provides a number of security features to consider as you develop and implement your own security policies. The following best practices are general guidelines and don’t represent a complete security solution. Because these best practices might not be appropriate or sufficient for your environment, treat them as helpful considerations rather than prescriptions. The following best practices for Amazon Monitron can help prevent security incidents: • When creating an AWS IAM Identity Center (IAM Identity Center) directory of users for Amazon Monitron enable multi-factor authentication (MFA) for the directory for better directory security. • Be aware that all project and site admins using the Amazon Monitron mobile app will have read access to all users in your organization who are listed in the user directory you choose when setting up your project. We strongly recommend using an isolated directory if you want to limit access to user organization information. • Because of the danger of phishing attacks, in which an attacker sends an email impersonating a Amazon Monitron project invitation email to your users, warn users to make sure that the directory name is visible on the login screen before they enter their sign-in credentials. • Because the Amazon Monitron mobile app runs on a smartphone and has access to your project, have all users enable screen lock to protect access when not in use. Security Best Practices for Amazon Monitron 458 Amazon Monitron User Guide Troubleshooting Amazon Monitron device issues If you have problems with one of your Amazon Monitron devices, use these suggestions to troubleshoot the problem. Then, if you're still having trouble, contact AWS Support. Note We recommend Safari as a default browser for iOS and Chrome as a default browser for Android. Topics • Troubleshooting Issues with Amazon Monitron Sensors • Troubleshooting issues with Amazon Monitron gateways Troubleshooting Issues with Amazon Monitron Sensors As a completely self-contained unit, there aren't many things that are likely to go wrong with a sensor. However, some issues can still occur. Topics • If you can't commission your sensors • If your sensor is offline • If your sensor falls off If you can't commission your sensors Consider the following questions. • Does the mobile phone running the Amazon Monitron App have a stable internet connection? For commissioning a sensor, the mobile phone running the Amazon Monitron App should have internet connectivity. • Are you holding your smartphone close to the sensor? Troubleshooting Issues with Amazon Monitron Sensors 459 Amazon Monitron User Guide At the moment of commissioning, your phone should be within two centimeters of the sensor. Don't move your phone while the sensor is being commissioned. • Does your smartphone have NFC activated? Some iOS devices require that NFC Tag Reader be manually turned on in Control Center. To see if your device is one of them, check the iPhone User Guide. • Are you holding your NFC antenna close to the sensor? On an iPhone, the NFC antenna is close to the top of the device. On an Android device, it could be in a different location. Check the documentation for Samsung, Google Pixel, or your device's manufacturer. • Does the commissioning progress bar show up? (Android only) If you can't commission your sensors 460 Amazon Monitron User Guide If the commissioning progress bar doesn't show up (Android only), or resets to the beginning, then the |
AmazonMonitronUG-084 | AmazonMonitronUG.pdf | 84 | Center. To see if your device is one of them, check the iPhone User Guide. • Are you holding your NFC antenna close to the sensor? On an iPhone, the NFC antenna is close to the top of the device. On an Android device, it could be in a different location. Check the documentation for Samsung, Google Pixel, or your device's manufacturer. • Does the commissioning progress bar show up? (Android only) If you can't commission your sensors 460 Amazon Monitron User Guide If the commissioning progress bar doesn't show up (Android only), or resets to the beginning, then the NFC communication between the sensor and your smartphone is weak or can't be established. Move your smartphone around to try and establish the NFC connection. Smartphones often have different locations for transmitting NFC, depending on the brand. Check the hardware specifications of your smartphone and tap the sensor specifically with that part of your phone. Confirm that NFC is turned on and broadcasting. • Do you get an error saying that the sensor is already in use? Delete the sensor from its previous asset or position, and then retry the commissioning process. If that doesn't work, try and commission another sensor that is not currently in use. If your sensor is offline Once a sensor has been paired to an asset, Amazon Monitron will make two attempts (over the course of 30 seconds) to take the initial measurement. If neither of those attempts is successful, then an alert like the one below will appear in the app. If your sensor is offline 461 Amazon Monitron User Guide If your sensor has stopped sending data, try the following: • Try taking a one-time measurement. If you can do so, then the sensor is working. If you cannot, then the sensor is not working, and may have run out of battery power. Replace it with a new sensor. • Confirm that an available gateway is within range. Amazon Monitron sensors and gateways communicate using Bluetooth Low Energy (BLE), with a typical range of 20 to 30 meters. In a completely open space, a sensor and a gateway may communicate with each other at greater distances. • Check for obstacles. Concrete walls and metal objects attenuate the signals. • Check for signal interference. The Bluetooth signal that sensors and gateways use to communicate occupies the 2.4GHz ISM (industrial, scientific and medical) band. Other devices that may use that band include wireless headsets and mice, wireless cameras, microwave ovens, and garage door openers. • If the measurement action starts (you see a loading bar), but does not complete, try to retake the measurement. If the same thing happens again, try to delete the sensor and recommission it. • If the measurement action fails, or you are not able to commission the sensor, contact customer support. If your sensor falls off Re-mount it. Troubleshooting issues with Amazon Monitron gateways Topics • If your mobile app can't pair with the gateway • If commissioning the gateway fails • If your gateway goes offline If your sensor falls off 462 Amazon Monitron User Guide If your mobile app can't pair with the gateway If you choose Add gateway in your mobile app, but the app can't find the gateway, try the following. Bluetooth pairing with an Ethernet gateway. Bluetooth pairing with a Wi-Fi gateway • Make sure that the gateway is turned on. Check the lights on the front of the gateway. If at least one of them is on, then the gateway has power. If the gateway has no power, check the following: • Is the power cord firmly attached to the back of the gateway and the power outlet? • Is the power outlet functioning properly? • Is the gateway power cable working? To test this, try using the cable with another gateway. • Is the outlet where the cable plugs into the gateway clean, with no debris stuck inside? Be sure to check the outlet in the gateway and the connecting end of the cable. • Make sure that the gateway is in commissioning mode. See Commissioning a Wi-Fi gateway or Commissioning an Ethernet gateway. • Make sure your smartphone's Bluetooth is working. • Try switching it off and on. If that doesn't help, restart your phone and check again. • Are you within your smartphone's Bluetooth range? Bluetooth range is typically less than 10 meters. • Is there anything that might be interfering electronically with the Bluetooth signal? See If your sensor is offline. If none of these actions resolves the issue, try the following: 463 Amazon Monitron User Guide • Log out of the mobile app and restart it. • Reset your Wi-Fi gateway or reset your Ethernet gateway. If commissioning the gateway fails If the Amazon Monitron gateway commissioning process fails, |
AmazonMonitronUG-085 | AmazonMonitronUG.pdf | 85 | Try switching it off and on. If that doesn't help, restart your phone and check again. • Are you within your smartphone's Bluetooth range? Bluetooth range is typically less than 10 meters. • Is there anything that might be interfering electronically with the Bluetooth signal? See If your sensor is offline. If none of these actions resolves the issue, try the following: 463 Amazon Monitron User Guide • Log out of the mobile app and restart it. • Reset your Wi-Fi gateway or reset your Ethernet gateway. If commissioning the gateway fails If the Amazon Monitron gateway commissioning process fails, try the following: • Check that the mobile phone running Amazon Monitron App has internet connectivity. • If commissioning of a Wi-Fi gateway fails, try commissioning it using a mobile hotspot provided by your mobile device. If that succeeds, it suggests a configuration issue with the Wi-Fi network or in firewall settings. If your gateway goes offline Your mobile or web app may tell you that your gateway is offline, or not connected to the network. In such cases, try the following: • If you recently added the gateway to your configuration, wait for its status to update. A newly commissioned gateway may take up to 20 seconds to go online. • Be sure that you aren't trying to configure a Wi-Fi gateway with static IPs. The Wi-Fi gateway does not currently support static IPs. However, you can configure your network to always assign the same IP address to the same device. • Make sure that your firewall is not blocking the gateway. Amazon Monitron gateways use TCP port 8883. You must allow connections to TCP port 8883 for amazonaws.com subdomains in order to provide firewall access to Amazon Monitron gateways. • Confirm that the issue is not network congestion. There are two ways in which Amazon Monitron may notify you that a gateway is offline: • When looking at information about your gateways in the mobile or web app, you may notice that a gateway is listed as offline. If commissioning the gateway fails 464 Amazon Monitron User Guide The timestamp for an offline gateway marks the last time Amazon Monitron recieved a signal from that gateway. In this case, you may not have received a notification about the gateway's offline status. Amazon Monitron will not issue a notification every single time a gateway appears to be offline. A newly commissioned gateway is considered offline until it connects to the internet. A gateway on a congested network is considered offline if Amazon Monitron hasn't heard from that gateway in 15 minutes. • Confirm that you're not dealing with a newly commissioned gateway or a newly paired sensor. If so, wait an hour. Sensors send data once per hour. If you don't want to wait, you can take a one- time measurement. • Confirm that your gateway is connected to a power source. If it is, unplug the gateway and then plug it back in. • If it's a Wi-Fi gateway, check the Wi-Fi connection. If the password for the Wi-Fi network has been changed since the gateway was added, it won't be able to connect. To reconnect, you'll have to delete the gateway and add it again, connecting to the Wi-Fi network using the new password. For more information about how to add a gateway, see Commissioning a Wi-Fi gateway or Commissioning an Ethernet gateway. • If it's an Ethernet gateway, check the network configuration. • Delete the gateway using the Amazon Monitron mobile app, do a factory reset of the gateway, and then install the gateway again. For more information, see Resetting the Wi-Fi gateway to factory settings or Resetting the Ethernet gateway to factory settings. 465 Amazon Monitron User Guide If none of these suggestions helps to get your Amazon Monitron device working again, contact AWS Support. 466 Amazon Monitron User Guide Amazon Monitron devices Amazon Monitron Starter Kits, sensors, and gateways are available for purchase at Amazon.com or Amazon Business. Amazon Monitron devices are available in the US, the UK, and the EU. 467 Amazon Monitron User Guide Quotas in Amazon Monitron You can request an increase for many of the Amazon Monitron quotas if your applications require it. For information about service quotas and to request a quota increase, see AWS Service Quotas. You can also contact your IT Manager for assistance with requesting a quota increase. Supported Regions Amazon Monitron is currently supported in the following regions: • US East (N. Virginia): us-east-1 • Europe (Ireland): eu-west-1 • Asia Pacific (Sydney): ap-southeast-2 Quotas All Amazon Monitron operations have the following quotas. Description Maximum number of sites per project Maximum number of assets per site Maximum number of positions (or sensors) per asset Maximum number of gateways per site Maximum number of users per site |
AmazonMonitronUG-086 | AmazonMonitronUG.pdf | 86 | applications require it. For information about service quotas and to request a quota increase, see AWS Service Quotas. You can also contact your IT Manager for assistance with requesting a quota increase. Supported Regions Amazon Monitron is currently supported in the following regions: • US East (N. Virginia): us-east-1 • Europe (Ireland): eu-west-1 • Asia Pacific (Sydney): ap-southeast-2 Quotas All Amazon Monitron operations have the following quotas. Description Maximum number of sites per project Maximum number of assets per site Maximum number of positions (or sensors) per asset Maximum number of gateways per site Maximum number of users per site Maximum number of custom classes per project Maximum number of positions per custom class Quota 50 100 20 200 20 25 500 Supported Regions 468 Amazon Monitron User Guide Document history for the Amazon Monitron User Guide • Latest documentation update: Oct 31, 2024 The following table describes important changes in each release of Amazon Monitron. For notification about updates to this documentation, you can subscribe to the RSS feed. Change Description Date Amazon Monitron is no longer open to new customers Amazon Monitron is no longer open to new customers October 31, 2024 . Existing customers can continue to use the service . Existing customers can continue to use the service as normal. For capabilities as normal. For capabilities similar to Amazon Monitron, similar to Amazon Monitron, see our blog post. see our blog post. Amazon Monitron will no longer be open to new Amazon Monitron will no longer be open to new customers starting October customers starting October 31, 2024. If you would like 31, 2024. If you would like to use the service, sign up to use the service, sign up prior to that date. Existing prior to that date. Existing customers can continue to customers can continue to use the service as normal. For use the service as normal. For capabilities similar to Amazon capabilities similar to Amazon Monitron, see our blog post. Monitron, see our blog post. October 1, 2024 Updated service-linked role policy Added sso:Creat September 30, 2024 eApplicationAssign ment and sso:ListA pplicationAssignme nts to role permissions policy. 469 Amazon Monitron User management Moving assets between sites Amazon Monitron gateway updates Unmuting ISO alerts Static IP address for gateways You can view and manage user assignments and permissions as an admin across a project. See Managing users for more details. You can move Amazon Monitron assets between sites. See Moving an asset for more details. You can now retrieve Amazon Monitron gateway MAC address details by scanning device QR codes. See Retrieving MAC address details for Ethernet Gateways and Retrieving MAC address details for Wi-Fi Gateways for more details. You can now unmute ISO alerts (alarms and warnings) . See Muting and unmuting alerts for more details. Amazon Monitron now supports new static IP addresses for gateways. See Securing your network for more details. User Guide March 19, 2024 March 19, 2024 February 22, 2024 January 31, 2024 January 25, 2024 470 Amazon Monitron User Guide Amazon Monitron billing monitoring updates December 13, 2023 You can now use Amazon Monitron AWS–generated tags to monitor billing. See Monitoring costs for more details. Amazon Monitron custom machine classes You can now create custom machine classes in Amazon December 7, 2023 Monitron. See Creating custom classes for more information. Amazon Monitron safety updates Updated Amazon Monitron sensor safety information. November 26, 2023 Amazon Monitron IT Manager's Guide deprecated Amazon Monitron IT Manager's Guide has been October 24, 2023 merged into the Amazon Monitron Amazon Monitron User Guide. Amazon Monitron CloudTrail event name updates Amazon Monitron CloudTrai l event names updated. See October 2, 2023 New region supported Amazon Monitron informati on in CloudTrail for more details. Amazon Monitron is now available in the Asia Pacific (Sydney) Region. For all supported Regions, see Supported Regions. August 17, 2023 471 Amazon Monitron User Guide View gateway details in mobile app Switching between projects Edit gateway name Create position from web app You can now view your Amazon Monitron gateway details from the mobile app. See Viewing Ethernet gateway details and Viewing Wi-Fi gateway details. You can now switch between your Amazon Monitron projects in your AWS account. See Switching between projects for more details. You can now edit gateway names for your Amazon Monitron gateways. See Editing ethernet gateway and Editing Wi-Fi gateway for more details. You can now create a position for your Amazon Monitron sensor from the web app. See Adding a sensor position. July 20, 2023 June 15, 2023 June 15, 2023 June 15, 2023 Sensor battery life status Amazon Monitron now displays sensor battery states May 22, 2023 to help you keep track of sensor health. See Sensor battery status for more details. Scatter plot view for sensor measurements You can now view your Amazon |
AmazonMonitronUG-087 | AmazonMonitronUG.pdf | 87 | between projects for more details. You can now edit gateway names for your Amazon Monitron gateways. See Editing ethernet gateway and Editing Wi-Fi gateway for more details. You can now create a position for your Amazon Monitron sensor from the web app. See Adding a sensor position. July 20, 2023 June 15, 2023 June 15, 2023 June 15, 2023 Sensor battery life status Amazon Monitron now displays sensor battery states May 22, 2023 to help you keep track of sensor health. See Sensor battery status for more details. Scatter plot view for sensor measurements You can now view your Amazon Monitron sensor data in scatter plot format. May 22, 2023 472 Amazon Monitron User Guide Editing machine class updates Each Amazon Monitron sensor can now be assigned a May 22, 2023 machine class. Added Kinesis data export schema v2 Added Amazon Monitron Kinesis data export schema v2 April 4, 2023 Vibration ISO image updates and v1 deprecation instructi ons. Updated several images to show new measurement functionality and filtering tools in the mobile and web UI. March 16, 2023 Sensor position info added Overview of how to identify a sensor's position details. January 24, 2023 In-app updates Edit gateway name Device offline Updated Kinesis data export instructions Added a note and updates on the in-app update feature, which users should monitor to be sure they have the latest Amazon Monitron features. Users have the ability to edit a gateway name once it's created. This update explains the behavior of sensors that go offline. Updated Kinesis configura tions and settings instructi ons. December 15, 2022 December 15, 2022 December 15, 2022 December 5, 2022 473 Amazon Monitron User Guide Updated service-linked role policy Added sso:ListP September 30, 2022 rofileAssociations to role permissions policy. Networking information added You can now read details about how Amazon Monitron July 5, 2022 connects to your local network. Web app supported Amazon Monitron now has a web app. November 18, 2021 Ethernet gateways added New region supported September 7, 2021 May 5, 2021 Amazon Monitron Ethernet gateways can now be purchased and integrated with the existing Amazon Monitron system. Amazon Monitron is now available in the Europe (Ireland) Region. For all supported Regions, see Supported Regions . One-off downloads supported New guide and service You can download your data to Amazon S3 using either the CLI or the console. This is the first release of the Amazon Monitron User Guide and service. January 21, 2021 December 1, 2020 474 |
amazonpinpointsmsvoicev2-api-001 | amazonpinpointsmsvoicev2-api.pdf | 1 | API Reference AWS End User Messaging SMS API Version 2022-03-31 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS End User Messaging SMS API Reference AWS End User Messaging SMS: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS End User Messaging SMS Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AssociateOriginationIdentity ...................................................................................................................... 6 Request Syntax ........................................................................................................................................ 6 Request Parameters ................................................................................................................................ 6 Response Syntax ...................................................................................................................................... 8 Response Elements ................................................................................................................................. 8 Errors .......................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 AssociateProtectConfiguration ................................................................................................................ 11 Request Syntax ...................................................................................................................................... 11 Request Parameters .............................................................................................................................. 11 Response Syntax ................................................................................................................................... 12 Response Elements ............................................................................................................................... 12 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 14 CreateConfigurationSet ............................................................................................................................. 15 Request Syntax ...................................................................................................................................... 15 Request Parameters .............................................................................................................................. 15 Response Syntax ................................................................................................................................... 16 Response Elements ............................................................................................................................... 16 Errors ....................................................................................................................................................... 17 See Also .................................................................................................................................................. 18 CreateEventDestination ............................................................................................................................. 20 Request Syntax ...................................................................................................................................... 20 Request Parameters .............................................................................................................................. 20 Response Syntax ................................................................................................................................... 23 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 24 See Also .................................................................................................................................................. 25 CreateOptOutList ....................................................................................................................................... 26 Request Syntax ...................................................................................................................................... 26 Request Parameters .............................................................................................................................. 26 Response Syntax ................................................................................................................................... 27 API Version 2022-03-31 iii AWS End User Messaging SMS API Reference Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 29 CreatePool .................................................................................................................................................... 31 Request Syntax ...................................................................................................................................... 31 Request Parameters .............................................................................................................................. 31 Response Syntax ................................................................................................................................... 33 Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 36 See Also .................................................................................................................................................. 37 CreateProtectConfiguration ..................................................................................................................... 39 Request Syntax ...................................................................................................................................... 39 Request Parameters .............................................................................................................................. 39 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 40 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 42 CreateRegistration ...................................................................................................................................... 44 Request Syntax ...................................................................................................................................... 44 Request Parameters .............................................................................................................................. 44 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 48 CreateRegistrationAssociation ................................................................................................................. 50 Request Syntax ...................................................................................................................................... 50 Request Parameters .............................................................................................................................. 50 Response Syntax ................................................................................................................................... 51 Response Elements ............................................................................................................................... 51 Errors ....................................................................................................................................................... 52 See Also .................................................................................................................................................. 53 CreateRegistrationAttachment ................................................................................................................ 55 Request Syntax ...................................................................................................................................... 55 Request Parameters .............................................................................................................................. 55 Response Syntax ................................................................................................................................... 56 Response Elements ............................................................................................................................... 57 API Version 2022-03-31 iv AWS End User Messaging SMS API Reference Errors ....................................................................................................................................................... 58 See Also .................................................................................................................................................. 59 CreateRegistrationVersion ........................................................................................................................ 60 Request Syntax ...................................................................................................................................... 60 Request Parameters .............................................................................................................................. 60 Response Syntax ................................................................................................................................... 60 Response Elements ............................................................................................................................... 61 Errors ....................................................................................................................................................... 62 See Also .................................................................................................................................................. 63 CreateVerifiedDestinationNumber .......................................................................................................... 64 Request Syntax ...................................................................................................................................... 64 Request Parameters .............................................................................................................................. 64 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 66 See Also .................................................................................................................................................. 67 DeleteAccountDefaultProtectConfiguration ......................................................................................... 69 Response Syntax ................................................................................................................................... 69 Response Elements ............................................................................................................................... 69 Errors ....................................................................................................................................................... 69 See Also .................................................................................................................................................. 70 DeleteConfigurationSet ............................................................................................................................. 72 Request Syntax ...................................................................................................................................... 72 Request Parameters .............................................................................................................................. 72 Response Syntax ................................................................................................................................... 72 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 75 DeleteDefaultMessageType ...................................................................................................................... 77 Request Syntax ...................................................................................................................................... 77 Request Parameters .............................................................................................................................. 77 Response Syntax ................................................................................................................................... 77 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 DeleteDefaultSenderId .............................................................................................................................. 81 API Version 2022-03-31 v AWS End User Messaging SMS API Reference Request Syntax ...................................................................................................................................... 81 Request Parameters .............................................................................................................................. 81 Response Syntax ................................................................................................................................... 81 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 DeleteEventDestination ............................................................................................................................. 85 Request Syntax ...................................................................................................................................... 85 Request Parameters .............................................................................................................................. 85 Response Syntax ................................................................................................................................... 86 Response Elements ............................................................................................................................... 86 Errors ....................................................................................................................................................... 87 See Also .................................................................................................................................................. 88 DeleteKeyword ............................................................................................................................................ 89 Request Syntax ...................................................................................................................................... 89 Request Parameters .............................................................................................................................. 89 Response Syntax ................................................................................................................................... 90 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 91 See Also .................................................................................................................................................. 92 DeleteMediaMessageSpendLimitOverride ............................................................................................. 94 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 94 See Also .................................................................................................................................................. 95 DeleteOptedOutNumber ........................................................................................................................... 96 Request Syntax ...................................................................................................................................... 96 Request Parameters .............................................................................................................................. 96 Response Syntax ................................................................................................................................... 97 Response Elements ............................................................................................................................... 97 Errors ....................................................................................................................................................... 98 See Also .................................................................................................................................................. 99 DeleteOptOutList ..................................................................................................................................... 100 Request Syntax .................................................................................................................................... 100 Request Parameters ........................................................................................................................... 100 Response Syntax ................................................................................................................................. 100 API Version 2022-03-31 vi AWS End User Messaging SMS API Reference Response Elements ............................................................................................................................ 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 DeletePool ................................................................................................................................................. 104 Request Syntax .................................................................................................................................... 104 Request Parameters ........................................................................................................................... 104 Response Syntax ................................................................................................................................. 105 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 108 DeleteProtectConfiguration ................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Syntax ................................................................................................................................. 109 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 112 DeleteProtectConfigurationRuleSetNumberOverride ....................................................................... 113 Request Syntax .................................................................................................................................... 113 Request Parameters ........................................................................................................................... 113 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 DeleteRegistration ................................................................................................................................... 117 Request Syntax .................................................................................................................................... 117 Request Parameters ........................................................................................................................... 117 Response Syntax ................................................................................................................................. |
amazonpinpointsmsvoicev2-api-002 | amazonpinpointsmsvoicev2-api.pdf | 2 | 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 DeletePool ................................................................................................................................................. 104 Request Syntax .................................................................................................................................... 104 Request Parameters ........................................................................................................................... 104 Response Syntax ................................................................................................................................. 105 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 108 DeleteProtectConfiguration ................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Syntax ................................................................................................................................. 109 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 112 DeleteProtectConfigurationRuleSetNumberOverride ....................................................................... 113 Request Syntax .................................................................................................................................... 113 Request Parameters ........................................................................................................................... 113 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 DeleteRegistration ................................................................................................................................... 117 Request Syntax .................................................................................................................................... 117 Request Parameters ........................................................................................................................... 117 Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 118 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 121 DeleteRegistrationAttachment .............................................................................................................. 122 Request Syntax .................................................................................................................................... 122 Request Parameters ........................................................................................................................... 122 Response Syntax ................................................................................................................................. 122 Response Elements ............................................................................................................................ 122 API Version 2022-03-31 vii AWS End User Messaging SMS API Reference Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 124 DeleteRegistrationFieldValue ................................................................................................................. 126 Request Syntax .................................................................................................................................... 126 Request Parameters ........................................................................................................................... 126 Response Syntax ................................................................................................................................. 127 Response Elements ............................................................................................................................ 127 Errors ..................................................................................................................................................... 128 See Also ................................................................................................................................................ 129 DeleteResourcePolicy .............................................................................................................................. 131 Request Syntax .................................................................................................................................... 131 Request Parameters ........................................................................................................................... 131 Response Syntax ................................................................................................................................. 131 Response Elements ............................................................................................................................ 131 Errors ..................................................................................................................................................... 132 See Also ................................................................................................................................................ 133 DeleteTextMessageSpendLimitOverride .............................................................................................. 134 Response Syntax ................................................................................................................................. 134 Response Elements ............................................................................................................................ 134 Errors ..................................................................................................................................................... 134 See Also ................................................................................................................................................ 135 DeleteVerifiedDestinationNumber ........................................................................................................ 136 Request Syntax .................................................................................................................................... 136 Request Parameters ........................................................................................................................... 136 Response Syntax ................................................................................................................................. 136 Response Elements ............................................................................................................................ 136 Errors ..................................................................................................................................................... 137 See Also ................................................................................................................................................ 138 DeleteVoiceMessageSpendLimitOverride ............................................................................................ 140 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 140 See Also ................................................................................................................................................ 141 DescribeAccountAttributes ..................................................................................................................... 142 Request Syntax .................................................................................................................................... 142 Request Parameters ........................................................................................................................... 142 API Version 2022-03-31 viii AWS End User Messaging SMS API Reference Response Syntax ................................................................................................................................. 143 Response Elements ............................................................................................................................ 143 Errors ..................................................................................................................................................... 143 See Also ................................................................................................................................................ 144 DescribeAccountLimits ............................................................................................................................ 146 Request Syntax .................................................................................................................................... 146 Request Parameters ........................................................................................................................... 146 Response Syntax ................................................................................................................................. 147 Response Elements ............................................................................................................................ 147 Errors ..................................................................................................................................................... 147 See Also ................................................................................................................................................ 148 DescribeConfigurationSets ..................................................................................................................... 150 Request Syntax .................................................................................................................................... 150 Request Parameters ........................................................................................................................... 150 Response Syntax ................................................................................................................................. 151 Response Elements ............................................................................................................................ 152 Errors ..................................................................................................................................................... 153 See Also ................................................................................................................................................ 153 DescribeKeywords .................................................................................................................................... 155 Request Syntax .................................................................................................................................... 155 Request Parameters ........................................................................................................................... 155 Response Syntax ................................................................................................................................. 157 Response Elements ............................................................................................................................ 157 Errors ..................................................................................................................................................... 158 See Also ................................................................................................................................................ 159 DescribeOptedOutNumbers ................................................................................................................... 160 Request Syntax .................................................................................................................................... 160 Request Parameters ........................................................................................................................... 160 Response Syntax ................................................................................................................................. 162 Response Elements ............................................................................................................................ 162 Errors ..................................................................................................................................................... 163 See Also ................................................................................................................................................ 164 DescribeOptOutLists ................................................................................................................................ 165 Request Syntax .................................................................................................................................... 165 Request Parameters ........................................................................................................................... 165 Response Syntax ................................................................................................................................. 166 API Version 2022-03-31 ix AWS End User Messaging SMS API Reference Response Elements ............................................................................................................................ 167 Errors ..................................................................................................................................................... 167 See Also ................................................................................................................................................ 168 DescribePhoneNumbers .......................................................................................................................... 170 Request Syntax .................................................................................................................................... 170 Request Parameters ........................................................................................................................... 170 Response Syntax ................................................................................................................................. 172 Response Elements ............................................................................................................................ 172 Errors ..................................................................................................................................................... 173 See Also ................................................................................................................................................ 174 DescribePools ............................................................................................................................................ 175 Request Syntax .................................................................................................................................... 175 Request Parameters ........................................................................................................................... 175 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 177 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 179 DescribeProtectConfigurations .............................................................................................................. 180 Request Syntax .................................................................................................................................... 180 Request Parameters ........................................................................................................................... 180 Response Syntax ................................................................................................................................. 181 Response Elements ............................................................................................................................ 182 Errors ..................................................................................................................................................... 182 See Also ................................................................................................................................................ 183 DescribeRegistrationAttachments ........................................................................................................ 184 Request Syntax .................................................................................................................................... 184 Request Parameters ........................................................................................................................... 184 Response Syntax ................................................................................................................................. 185 Response Elements ............................................................................................................................ 186 Errors ..................................................................................................................................................... 186 See Also ................................................................................................................................................ 187 DescribeRegistrationFieldDefinitions ................................................................................................... 188 Request Syntax .................................................................................................................................... 188 Request Parameters ........................................................................................................................... 188 Response Syntax ................................................................................................................................. 189 Response Elements ............................................................................................................................ 190 API Version 2022-03-31 x AWS End User Messaging SMS API Reference Errors ..................................................................................................................................................... 191 See Also ................................................................................................................................................ 192 DescribeRegistrationFieldValues ........................................................................................................... 193 Request Syntax .................................................................................................................................... 193 Request Parameters ........................................................................................................................... 193 Response Syntax ................................................................................................................................. 195 Response Elements ............................................................................................................................ 195 Errors ..................................................................................................................................................... 196 See Also ................................................................................................................................................ 197 DescribeRegistrations .............................................................................................................................. 198 Request Syntax .................................................................................................................................... 198 Request Parameters ........................................................................................................................... 198 Response Syntax ................................................................................................................................. 199 Response Elements ............................................................................................................................ 200 Errors ..................................................................................................................................................... 200 See Also ................................................................................................................................................ 201 DescribeRegistrationSectionDefinitions ............................................................................................... 202 Request Syntax .................................................................................................................................... 202 Request Parameters ........................................................................................................................... 202 Response Syntax ................................................................................................................................. 203 Response Elements ............................................................................................................................ 204 Errors ..................................................................................................................................................... 204 See Also ................................................................................................................................................ 205 DescribeRegistrationTypeDefinitions ................................................................................................... 207 Request Syntax .................................................................................................................................... 207 Request Parameters ........................................................................................................................... 207 Response Syntax ................................................................................................................................. 208 Response Elements ............................................................................................................................ 209 Errors ..................................................................................................................................................... 209 See Also ................................................................................................................................................ 210 DescribeRegistrationVersions ................................................................................................................. 211 Request Syntax .................................................................................................................................... 211 Request Parameters ........................................................................................................................... 211 Response Syntax ................................................................................................................................. 212 Response Elements ............................................................................................................................ 213 Errors ..................................................................................................................................................... 214 API Version 2022-03-31 xi AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 215 DescribeSenderIds .................................................................................................................................... 216 Request Syntax .................................................................................................................................... 216 Request Parameters ........................................................................................................................... 216 Response Syntax ................................................................................................................................. 218 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 DescribeSpendLimits ............................................................................................................................... 221 Request Syntax .................................................................................................................................... 221 Request Parameters ........................................................................................................................... 221 Response Syntax ................................................................................................................................. 222 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 222 See Also ................................................................................................................................................ 223 DescribeVerifiedDestinationNumbers .................................................................................................. 225 Request Syntax .................................................................................................................................... 225 Request Parameters ........................................................................................................................... 225 Response Syntax ................................................................................................................................. 226 Response Elements ............................................................................................................................ 227 Errors ..................................................................................................................................................... 227 See Also ................................................................................................................................................ |
amazonpinpointsmsvoicev2-api-003 | amazonpinpointsmsvoicev2-api.pdf | 3 | 212 Response Elements ............................................................................................................................ 213 Errors ..................................................................................................................................................... 214 API Version 2022-03-31 xi AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 215 DescribeSenderIds .................................................................................................................................... 216 Request Syntax .................................................................................................................................... 216 Request Parameters ........................................................................................................................... 216 Response Syntax ................................................................................................................................. 218 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 219 See Also ................................................................................................................................................ 219 DescribeSpendLimits ............................................................................................................................... 221 Request Syntax .................................................................................................................................... 221 Request Parameters ........................................................................................................................... 221 Response Syntax ................................................................................................................................. 222 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 222 See Also ................................................................................................................................................ 223 DescribeVerifiedDestinationNumbers .................................................................................................. 225 Request Syntax .................................................................................................................................... 225 Request Parameters ........................................................................................................................... 225 Response Syntax ................................................................................................................................. 226 Response Elements ............................................................................................................................ 227 Errors ..................................................................................................................................................... 227 See Also ................................................................................................................................................ 228 DisassociateOriginationIdentity ............................................................................................................ 230 Request Syntax .................................................................................................................................... 230 Request Parameters ........................................................................................................................... 230 Response Syntax ................................................................................................................................. 232 Response Elements ............................................................................................................................ 232 Errors ..................................................................................................................................................... 233 See Also ................................................................................................................................................ 234 DisassociateProtectConfiguration ......................................................................................................... 235 Request Syntax .................................................................................................................................... 235 Request Parameters ........................................................................................................................... 235 Response Syntax ................................................................................................................................. 236 Response Elements ............................................................................................................................ 236 Errors ..................................................................................................................................................... 237 See Also ................................................................................................................................................ 238 API Version 2022-03-31 xii AWS End User Messaging SMS API Reference DiscardRegistrationVersion .................................................................................................................... 239 Request Syntax .................................................................................................................................... 239 Request Parameters ........................................................................................................................... 239 Response Syntax ................................................................................................................................. 239 Response Elements ............................................................................................................................ 240 Errors ..................................................................................................................................................... 241 See Also ................................................................................................................................................ 242 GetProtectConfigurationCountryRuleSet ............................................................................................ 243 Request Syntax .................................................................................................................................... 243 Request Parameters ........................................................................................................................... 243 Response Syntax ................................................................................................................................. 243 Response Elements ............................................................................................................................ 244 Errors ..................................................................................................................................................... 245 See Also ................................................................................................................................................ 246 GetResourcePolicy .................................................................................................................................... 247 Request Syntax .................................................................................................................................... 247 Request Parameters ........................................................................................................................... 247 Response Syntax ................................................................................................................................. 247 Response Elements ............................................................................................................................ 248 Errors ..................................................................................................................................................... 248 See Also ................................................................................................................................................ 249 ListPoolOriginationIdentities ................................................................................................................. 251 Request Syntax .................................................................................................................................... 251 Request Parameters ........................................................................................................................... 251 Response Syntax ................................................................................................................................. 252 Response Elements ............................................................................................................................ 253 Errors ..................................................................................................................................................... 254 See Also ................................................................................................................................................ 254 ListProtectConfigurationRuleSetNumberOverrides .......................................................................... 256 Request Syntax .................................................................................................................................... 256 Request Parameters ........................................................................................................................... 256 Response Syntax ................................................................................................................................. 257 Response Elements ............................................................................................................................ 258 Errors ..................................................................................................................................................... 259 See Also ................................................................................................................................................ 259 ListRegistrationAssociations ................................................................................................................... 261 API Version 2022-03-31 xiii AWS End User Messaging SMS API Reference Request Syntax .................................................................................................................................... 261 Request Parameters ........................................................................................................................... 261 Response Syntax ................................................................................................................................. 262 Response Elements ............................................................................................................................ 263 Errors ..................................................................................................................................................... 264 See Also ................................................................................................................................................ 264 ListTagsForResource ................................................................................................................................ 266 Request Syntax .................................................................................................................................... 266 Request Parameters ........................................................................................................................... 266 Response Syntax ................................................................................................................................. 266 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... 267 See Also ................................................................................................................................................ 268 PutKeyword ............................................................................................................................................... 269 Request Syntax .................................................................................................................................... 269 Request Parameters ........................................................................................................................... 269 Response Syntax ................................................................................................................................. 271 Response Elements ............................................................................................................................ 271 Errors ..................................................................................................................................................... 272 See Also ................................................................................................................................................ 273 PutMessageFeedback .............................................................................................................................. 274 Request Syntax .................................................................................................................................... 274 Request Parameters ........................................................................................................................... 274 Response Syntax ................................................................................................................................. 275 Response Elements ............................................................................................................................ 275 Errors ..................................................................................................................................................... 275 See Also ................................................................................................................................................ 276 PutOptedOutNumber .............................................................................................................................. 278 Request Syntax .................................................................................................................................... 278 Request Parameters ........................................................................................................................... 278 Response Syntax ................................................................................................................................. 279 Response Elements ............................................................................................................................ 279 Errors ..................................................................................................................................................... 280 See Also ................................................................................................................................................ 281 PutProtectConfigurationRuleSetNumberOverride ............................................................................ 282 Request Syntax .................................................................................................................................... 282 API Version 2022-03-31 xiv AWS End User Messaging SMS API Reference Request Parameters ........................................................................................................................... 282 Response Syntax ................................................................................................................................. 283 Response Elements ............................................................................................................................ 284 Errors ..................................................................................................................................................... 285 See Also ................................................................................................................................................ 286 PutRegistrationFieldValue ...................................................................................................................... 287 Request Syntax .................................................................................................................................... 287 Request Parameters ........................................................................................................................... 287 Response Syntax ................................................................................................................................. 288 Response Elements ............................................................................................................................ 289 Errors ..................................................................................................................................................... 290 See Also ................................................................................................................................................ 291 PutResourcePolicy .................................................................................................................................... 292 Request Syntax .................................................................................................................................... 292 Request Parameters ........................................................................................................................... 292 Response Syntax ................................................................................................................................. 293 Response Elements ............................................................................................................................ 293 Errors ..................................................................................................................................................... 293 See Also ................................................................................................................................................ 294 ReleasePhoneNumber ............................................................................................................................. 296 Request Syntax .................................................................................................................................... 296 Request Parameters ........................................................................................................................... 296 Response Syntax ................................................................................................................................. 297 Response Elements ............................................................................................................................ 297 Errors ..................................................................................................................................................... 300 See Also ................................................................................................................................................ 301 ReleaseSenderId ....................................................................................................................................... 302 Request Syntax .................................................................................................................................... 302 Request Parameters ........................................................................................................................... 302 Response Syntax ................................................................................................................................. 303 Response Elements ............................................................................................................................ 303 Errors ..................................................................................................................................................... 304 See Also ................................................................................................................................................ 305 RequestPhoneNumber ............................................................................................................................ 307 Request Syntax .................................................................................................................................... 307 Request Parameters ........................................................................................................................... 307 API Version 2022-03-31 xv AWS End User Messaging SMS API Reference Response Syntax ................................................................................................................................. 310 Response Elements ............................................................................................................................ 311 Errors ..................................................................................................................................................... 314 See Also ................................................................................................................................................ 315 RequestSenderId ...................................................................................................................................... 317 Request Syntax .................................................................................................................................... 317 Request Parameters ........................................................................................................................... 317 Response Syntax ................................................................................................................................. 319 Response Elements ............................................................................................................................ 319 Errors ..................................................................................................................................................... 321 See Also ................................................................................................................................................ 322 SendDestinationNumberVerificationCode ........................................................................................... 323 Request Syntax .................................................................................................................................... 323 Request Parameters ........................................................................................................................... 323 Response Syntax ................................................................................................................................. 325 Response Elements ............................................................................................................................ 326 Errors ..................................................................................................................................................... 326 See Also ................................................................................................................................................ 327 SendMediaMessage .................................................................................................................................. 328 Request Syntax .................................................................................................................................... 328 Request Parameters ........................................................................................................................... 328 Response Syntax ................................................................................................................................. 331 Response Elements ............................................................................................................................ 332 Errors ..................................................................................................................................................... 332 See Also ................................................................................................................................................ 333 SendTextMessage ..................................................................................................................................... 334 Request Syntax .................................................................................................................................... 334 Request Parameters ........................................................................................................................... 334 Response Syntax ................................................................................................................................. 339 Response Elements ............................................................................................................................ 339 Errors ..................................................................................................................................................... 339 See Also ................................................................................................................................................ 340 SendVoiceMessage ................................................................................................................................... 342 Request Syntax .................................................................................................................................... 342 Request Parameters ........................................................................................................................... 342 Response Syntax ................................................................................................................................. 346 API Version 2022-03-31 xvi AWS End User Messaging SMS API Reference Response Elements ............................................................................................................................ 346 Errors ..................................................................................................................................................... 346 See Also ................................................................................................................................................ 347 SetAccountDefaultProtectConfiguration ............................................................................................. 349 Request Syntax .................................................................................................................................... 349 Request Parameters ........................................................................................................................... 349 Response Syntax ................................................................................................................................. 349 Response Elements ............................................................................................................................ 349 Errors ..................................................................................................................................................... 350 See Also ................................................................................................................................................ 351 SetDefaultMessageFeedbackEnabled ................................................................................................... 352 Request Syntax .................................................................................................................................... 352 Request Parameters ........................................................................................................................... 352 Response Syntax ................................................................................................................................. 352 Response Elements ............................................................................................................................ 353 Errors |
amazonpinpointsmsvoicev2-api-004 | amazonpinpointsmsvoicev2-api.pdf | 4 | ........................................................................................................................... 334 Response Syntax ................................................................................................................................. 339 Response Elements ............................................................................................................................ 339 Errors ..................................................................................................................................................... 339 See Also ................................................................................................................................................ 340 SendVoiceMessage ................................................................................................................................... 342 Request Syntax .................................................................................................................................... 342 Request Parameters ........................................................................................................................... 342 Response Syntax ................................................................................................................................. 346 API Version 2022-03-31 xvi AWS End User Messaging SMS API Reference Response Elements ............................................................................................................................ 346 Errors ..................................................................................................................................................... 346 See Also ................................................................................................................................................ 347 SetAccountDefaultProtectConfiguration ............................................................................................. 349 Request Syntax .................................................................................................................................... 349 Request Parameters ........................................................................................................................... 349 Response Syntax ................................................................................................................................. 349 Response Elements ............................................................................................................................ 349 Errors ..................................................................................................................................................... 350 See Also ................................................................................................................................................ 351 SetDefaultMessageFeedbackEnabled ................................................................................................... 352 Request Syntax .................................................................................................................................... 352 Request Parameters ........................................................................................................................... 352 Response Syntax ................................................................................................................................. 352 Response Elements ............................................................................................................................ 353 Errors ..................................................................................................................................................... 353 See Also ................................................................................................................................................ 354 SetDefaultMessageType .......................................................................................................................... 356 Request Syntax .................................................................................................................................... 356 Request Parameters ........................................................................................................................... 356 Response Syntax ................................................................................................................................. 357 Response Elements ............................................................................................................................ 357 Errors ..................................................................................................................................................... 357 See Also ................................................................................................................................................ 358 SetDefaultSenderId .................................................................................................................................. 360 Request Syntax .................................................................................................................................... 360 Request Parameters ........................................................................................................................... 360 Response Syntax ................................................................................................................................. 361 Response Elements ............................................................................................................................ 361 Errors ..................................................................................................................................................... 362 See Also ................................................................................................................................................ 362 SetMediaMessageSpendLimitOverride ................................................................................................ 364 Request Syntax .................................................................................................................................... 364 Request Parameters ........................................................................................................................... 364 Response Syntax ................................................................................................................................. 364 Response Elements ............................................................................................................................ 364 API Version 2022-03-31 xvii AWS End User Messaging SMS API Reference Errors ..................................................................................................................................................... 365 See Also ................................................................................................................................................ 365 SetTextMessageSpendLimitOverride .................................................................................................... 367 Request Syntax .................................................................................................................................... 367 Request Parameters ........................................................................................................................... 367 Response Syntax ................................................................................................................................. 367 Response Elements ............................................................................................................................ 367 Errors ..................................................................................................................................................... 368 See Also ................................................................................................................................................ 368 SetVoiceMessageSpendLimitOverride .................................................................................................. 370 Request Syntax .................................................................................................................................... 370 Request Parameters ........................................................................................................................... 370 Response Syntax ................................................................................................................................. 370 Response Elements ............................................................................................................................ 370 Errors ..................................................................................................................................................... 371 See Also ................................................................................................................................................ 371 SubmitRegistrationVersion ..................................................................................................................... 373 Request Syntax .................................................................................................................................... 373 Request Parameters ........................................................................................................................... 373 Response Syntax ................................................................................................................................. 373 Response Elements ............................................................................................................................ 374 Errors ..................................................................................................................................................... 375 See Also ................................................................................................................................................ 376 TagResource .............................................................................................................................................. 377 Request Syntax .................................................................................................................................... 377 Request Parameters ........................................................................................................................... 377 Response Elements ............................................................................................................................ 378 Errors ..................................................................................................................................................... 378 See Also ................................................................................................................................................ 379 UntagResource .......................................................................................................................................... 380 Request Syntax .................................................................................................................................... 380 Request Parameters ........................................................................................................................... 380 Response Elements ............................................................................................................................ 381 Errors ..................................................................................................................................................... 381 See Also ................................................................................................................................................ 381 UpdateEventDestination ......................................................................................................................... 383 API Version 2022-03-31 xviii AWS End User Messaging SMS API Reference Request Syntax .................................................................................................................................... 383 Request Parameters ........................................................................................................................... 383 Response Syntax ................................................................................................................................. 385 Response Elements ............................................................................................................................ 386 Errors ..................................................................................................................................................... 386 See Also ................................................................................................................................................ 387 UpdatePhoneNumber .............................................................................................................................. 389 Request Syntax .................................................................................................................................... 389 Request Parameters ........................................................................................................................... 389 Response Syntax ................................................................................................................................. 391 Response Elements ............................................................................................................................ 392 Errors ..................................................................................................................................................... 395 See Also ................................................................................................................................................ 396 UpdatePool ................................................................................................................................................ 397 Request Syntax .................................................................................................................................... 397 Request Parameters ........................................................................................................................... 397 Response Syntax ................................................................................................................................. 399 Response Elements ............................................................................................................................ 400 Errors ..................................................................................................................................................... 402 See Also ................................................................................................................................................ 403 UpdateProtectConfiguration .................................................................................................................. 404 Request Syntax .................................................................................................................................... 404 Request Parameters ........................................................................................................................... 404 Response Syntax ................................................................................................................................. 404 Response Elements ............................................................................................................................ 405 Errors ..................................................................................................................................................... 406 See Also ................................................................................................................................................ 406 UpdateProtectConfigurationCountryRuleSet ..................................................................................... 408 Request Syntax .................................................................................................................................... 408 Request Parameters ........................................................................................................................... 408 Response Syntax ................................................................................................................................. 409 Response Elements ............................................................................................................................ 409 Errors ..................................................................................................................................................... 410 See Also ................................................................................................................................................ 411 UpdateSenderId ........................................................................................................................................ 413 Request Syntax .................................................................................................................................... 413 API Version 2022-03-31 xix AWS End User Messaging SMS API Reference Request Parameters ........................................................................................................................... 413 Response Syntax ................................................................................................................................. 414 Response Elements ............................................................................................................................ 414 Errors ..................................................................................................................................................... 415 See Also ................................................................................................................................................ 416 VerifyDestinationNumber ....................................................................................................................... 418 Request Syntax .................................................................................................................................... 418 Request Parameters ........................................................................................................................... 418 Response Syntax ................................................................................................................................. 419 Response Elements ............................................................................................................................ 419 Errors ..................................................................................................................................................... 420 See Also ................................................................................................................................................ 421 Data Types ................................................................................................................................... 422 AccountAttribute ...................................................................................................................................... 425 Contents ............................................................................................................................................... 425 See Also ................................................................................................................................................ 425 AccountLimit ............................................................................................................................................. 426 Contents ............................................................................................................................................... 426 See Also ................................................................................................................................................ 426 CloudWatchLogsDestination .................................................................................................................. 428 Contents ............................................................................................................................................... 428 See Also ................................................................................................................................................ 428 ConfigurationSetFilter ............................................................................................................................. 429 Contents ............................................................................................................................................... 429 See Also ................................................................................................................................................ 429 ConfigurationSetInformation ................................................................................................................. 430 Contents ............................................................................................................................................... 430 See Also ................................................................................................................................................ 431 EventDestination ...................................................................................................................................... 433 Contents ............................................................................................................................................... 433 See Also ................................................................................................................................................ 434 KeywordFilter ............................................................................................................................................ 436 Contents ............................................................................................................................................... 436 See Also ................................................................................................................................................ 436 KeywordInformation ................................................................................................................................ 437 Contents ............................................................................................................................................... 437 API Version 2022-03-31 xx AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 437 KinesisFirehoseDestination ..................................................................................................................... 439 Contents ............................................................................................................................................... 439 See Also ................................................................................................................................................ 439 OptedOutFilter ......................................................................................................................................... 441 Contents ............................................................................................................................................... 441 See Also ................................................................................................................................................ 441 OptedOutNumberInformation .............................................................................................................. 442 Contents ............................................................................................................................................... 442 See Also ................................................................................................................................................ 442 OptOutListInformation ........................................................................................................................... 444 Contents ............................................................................................................................................... 444 See Also ................................................................................................................................................ 444 OriginationIdentityMetadata ................................................................................................................. 446 Contents ............................................................................................................................................... 446 See Also ................................................................................................................................................ 447 PhoneNumberFilter ................................................................................................................................. 448 Contents ............................................................................................................................................... 448 See Also ................................................................................................................................................ 448 PhoneNumberInformation ..................................................................................................................... 449 Contents ............................................................................................................................................... 449 See Also ................................................................................................................................................ 453 PoolFilter .................................................................................................................................................... 454 Contents ............................................................................................................................................... 454 See Also ................................................................................................................................................ 454 PoolInformation ....................................................................................................................................... 455 Contents ............................................................................................................................................... 455 See Also ................................................................................................................................................ 457 PoolOriginationIdentitiesFilter .............................................................................................................. 459 Contents ............................................................................................................................................... 459 See Also ................................................................................................................................................ 459 ProtectConfigurationCountryRuleSetInformation ............................................................................. 460 Contents ............................................................................................................................................... 460 See Also ................................................................................................................................................ 460 ProtectConfigurationFilter ..................................................................................................................... 461 Contents ............................................................................................................................................... 461 API Version 2022-03-31 xxi AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 461 ProtectConfigurationInformation ......................................................................................................... 462 Contents ............................................................................................................................................... 462 See Also ................................................................................................................................................ 463 ProtectConfigurationRuleSetNumberOverride ................................................................................... 464 Contents ............................................................................................................................................... 464 See Also ................................................................................................................................................ 465 ProtectConfigurationRuleSetNumberOverrideFilterItem ................................................................. 466 Contents ............................................................................................................................................... 466 See Also ................................................................................................................................................ 466 RegistrationAssociationFilter ................................................................................................................. 467 Contents ............................................................................................................................................... 467 See Also ................................................................................................................................................ 467 RegistrationAssociationMetadata ......................................................................................................... 468 Contents ............................................................................................................................................... 468 See Also ................................................................................................................................................ 469 RegistrationAttachmentFilter ................................................................................................................ 470 |
amazonpinpointsmsvoicev2-api-005 | amazonpinpointsmsvoicev2-api.pdf | 5 | ............................................................................................................................................... 455 See Also ................................................................................................................................................ 457 PoolOriginationIdentitiesFilter .............................................................................................................. 459 Contents ............................................................................................................................................... 459 See Also ................................................................................................................................................ 459 ProtectConfigurationCountryRuleSetInformation ............................................................................. 460 Contents ............................................................................................................................................... 460 See Also ................................................................................................................................................ 460 ProtectConfigurationFilter ..................................................................................................................... 461 Contents ............................................................................................................................................... 461 API Version 2022-03-31 xxi AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 461 ProtectConfigurationInformation ......................................................................................................... 462 Contents ............................................................................................................................................... 462 See Also ................................................................................................................................................ 463 ProtectConfigurationRuleSetNumberOverride ................................................................................... 464 Contents ............................................................................................................................................... 464 See Also ................................................................................................................................................ 465 ProtectConfigurationRuleSetNumberOverrideFilterItem ................................................................. 466 Contents ............................................................................................................................................... 466 See Also ................................................................................................................................................ 466 RegistrationAssociationFilter ................................................................................................................. 467 Contents ............................................................................................................................................... 467 See Also ................................................................................................................................................ 467 RegistrationAssociationMetadata ......................................................................................................... 468 Contents ............................................................................................................................................... 468 See Also ................................................................................................................................................ 469 RegistrationAttachmentFilter ................................................................................................................ 470 Contents ............................................................................................................................................... 470 See Also ................................................................................................................................................ 470 RegistrationAttachmentsInformation .................................................................................................. 471 Contents ............................................................................................................................................... 471 See Also ................................................................................................................................................ 472 RegistrationDeniedReasonInformation ................................................................................................ 473 Contents ............................................................................................................................................... 473 See Also ................................................................................................................................................ 474 RegistrationFieldDefinition .................................................................................................................... 475 Contents ............................................................................................................................................... 475 See Also ................................................................................................................................................ 476 RegistrationFieldDisplayHints ................................................................................................................ 477 Contents ............................................................................................................................................... 477 See Also ................................................................................................................................................ 478 RegistrationFieldValueInformation ....................................................................................................... 479 Contents ............................................................................................................................................... 479 See Also ................................................................................................................................................ 480 RegistrationFilter ...................................................................................................................................... 481 Contents ............................................................................................................................................... 481 API Version 2022-03-31 xxii AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 481 RegistrationInformation .......................................................................................................................... 482 Contents ............................................................................................................................................... 482 See Also ................................................................................................................................................ 484 RegistrationSectionDefinition ................................................................................................................ 485 Contents ............................................................................................................................................... 485 See Also ................................................................................................................................................ 485 RegistrationSectionDisplayHints ........................................................................................................... 486 Contents ............................................................................................................................................... 486 See Also ................................................................................................................................................ 487 RegistrationTypeDefinition ..................................................................................................................... 488 Contents ............................................................................................................................................... 488 See Also ................................................................................................................................................ 488 RegistrationTypeDisplayHints ................................................................................................................ 490 Contents ............................................................................................................................................... 490 See Also ................................................................................................................................................ 491 RegistrationTypeFilter ............................................................................................................................. 492 Contents ............................................................................................................................................... 492 See Also ................................................................................................................................................ 492 RegistrationVersionFilter ........................................................................................................................ 493 Contents ............................................................................................................................................... 493 See Also ................................................................................................................................................ 493 RegistrationVersionInformation ............................................................................................................ 494 Contents ............................................................................................................................................... 494 See Also ................................................................................................................................................ 495 RegistrationVersionStatusHistory ......................................................................................................... 496 Contents ............................................................................................................................................... 496 See Also ................................................................................................................................................ 497 SelectOptionDescription ......................................................................................................................... 498 Contents ............................................................................................................................................... 498 See Also ................................................................................................................................................ 498 SelectValidation ........................................................................................................................................ 499 Contents ............................................................................................................................................... 499 See Also ................................................................................................................................................ 499 SenderIdAndCountry ............................................................................................................................... 500 Contents ............................................................................................................................................... 500 API Version 2022-03-31 xxiii AWS End User Messaging SMS API Reference See Also ................................................................................................................................................ 500 SenderIdFilter ............................................................................................................................................ 501 Contents ............................................................................................................................................... 501 See Also ................................................................................................................................................ 501 SenderIdInformation ............................................................................................................................... 502 Contents ............................................................................................................................................... 502 See Also ................................................................................................................................................ 503 SnsDestination .......................................................................................................................................... 505 Contents ............................................................................................................................................... 505 See Also ................................................................................................................................................ 505 SpendLimit ................................................................................................................................................ 506 Contents ............................................................................................................................................... 506 See Also ................................................................................................................................................ 507 SupportedAssociation ............................................................................................................................. 508 Contents ............................................................................................................................................... 508 See Also ................................................................................................................................................ 509 Tag ............................................................................................................................................................... 510 Contents ............................................................................................................................................... 510 See Also ................................................................................................................................................ 510 TextValidation ........................................................................................................................................... 511 Contents ............................................................................................................................................... 511 See Also ................................................................................................................................................ 511 ValidationExceptionField ........................................................................................................................ 512 Contents ............................................................................................................................................... 512 See Also ................................................................................................................................................ 512 VerifiedDestinationNumberFilter .......................................................................................................... 513 Contents ............................................................................................................................................... 513 See Also ................................................................................................................................................ 513 VerifiedDestinationNumberInformation .............................................................................................. 514 Contents ............................................................................................................................................... 514 See Also ................................................................................................................................................ 515 Common Parameters ................................................................................................................... 516 Common Errors ............................................................................................................................ 519 API Version 2022-03-31 xxiv AWS End User Messaging SMS API Reference Welcome Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas. Amazon Pinpoint is an AWS service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API. If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other AWS services, and the quotas that apply to use of the service. Regional availability The AWS End User Messaging SMS and Voice version 2 API Reference is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints and Amazon Pinpoint endpoints and quotas in the AWS General Reference. To learn more about AWS Regions, see Managing AWS Regions in the AWS General Reference. In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure. This document was last published on May 21, 2025. API Version 2022-03-31 1 AWS End User Messaging SMS API Reference Actions The following actions are supported: • |
amazonpinpointsmsvoicev2-api-006 | amazonpinpointsmsvoicev2-api.pdf | 6 | AWS Regions in the AWS General Reference. In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure. This document was last published on May 21, 2025. API Version 2022-03-31 1 AWS End User Messaging SMS API Reference Actions The following actions are supported: • AssociateOriginationIdentity • AssociateProtectConfiguration • CreateConfigurationSet • CreateEventDestination • CreateOptOutList • CreatePool • CreateProtectConfiguration • CreateRegistration • CreateRegistrationAssociation • CreateRegistrationAttachment • CreateRegistrationVersion • CreateVerifiedDestinationNumber • DeleteAccountDefaultProtectConfiguration • DeleteConfigurationSet • DeleteDefaultMessageType • DeleteDefaultSenderId • DeleteEventDestination • DeleteKeyword • DeleteMediaMessageSpendLimitOverride • DeleteOptedOutNumber • DeleteOptOutList • DeletePool • DeleteProtectConfiguration • DeleteProtectConfigurationRuleSetNumberOverride • DeleteRegistration • DeleteRegistrationAttachment • DeleteRegistrationFieldValue API Version 2022-03-31 2 API Reference AWS End User Messaging SMS • DeleteResourcePolicy • DeleteTextMessageSpendLimitOverride • DeleteVerifiedDestinationNumber • DeleteVoiceMessageSpendLimitOverride • DescribeAccountAttributes • DescribeAccountLimits • DescribeConfigurationSets • DescribeKeywords • DescribeOptedOutNumbers • DescribeOptOutLists • DescribePhoneNumbers • DescribePools • DescribeProtectConfigurations • DescribeRegistrationAttachments • DescribeRegistrationFieldDefinitions • DescribeRegistrationFieldValues • DescribeRegistrations • DescribeRegistrationSectionDefinitions • DescribeRegistrationTypeDefinitions • DescribeRegistrationVersions • DescribeSenderIds • DescribeSpendLimits • DescribeVerifiedDestinationNumbers • DisassociateOriginationIdentity • DisassociateProtectConfiguration • DiscardRegistrationVersion • GetProtectConfigurationCountryRuleSet • GetResourcePolicy • ListPoolOriginationIdentities • ListProtectConfigurationRuleSetNumberOverrides API Version 2022-03-31 3 AWS End User Messaging SMS • ListRegistrationAssociations • ListTagsForResource • PutKeyword • PutMessageFeedback • PutOptedOutNumber • PutProtectConfigurationRuleSetNumberOverride • PutRegistrationFieldValue • PutResourcePolicy • ReleasePhoneNumber • ReleaseSenderId • RequestPhoneNumber • RequestSenderId • SendDestinationNumberVerificationCode • SendMediaMessage • SendTextMessage • SendVoiceMessage • SetAccountDefaultProtectConfiguration • SetDefaultMessageFeedbackEnabled • SetDefaultMessageType • SetDefaultSenderId • SetMediaMessageSpendLimitOverride • SetTextMessageSpendLimitOverride • SetVoiceMessageSpendLimitOverride • SubmitRegistrationVersion • TagResource • UntagResource • UpdateEventDestination • UpdatePhoneNumber • UpdatePool • UpdateProtectConfiguration API Reference API Version 2022-03-31 4 AWS End User Messaging SMS API Reference • UpdateProtectConfigurationCountryRuleSet • UpdateSenderId • VerifyDestinationNumber API Version 2022-03-31 5 AWS End User Messaging SMS API Reference AssociateOriginationIdentity Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an error is returned. Request Syntax { "ClientToken": "string", "IsoCountryCode": "string", "OriginationIdentity": "string", "PoolId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No IsoCountryCode The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity. AssociateOriginationIdentity API Version 2022-03-31 6 AWS End User Messaging SMS Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes OriginationIdentity API Reference The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or 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. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes PoolId 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. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Request Parameters API Version 2022-03-31 7 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "IsoCountryCode": "string", "OriginationIdentity": "string", "OriginationIdentityArn": "string", "PoolArn": "string", "PoolId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} OriginationIdentity The PhoneNumberId or SenderId of the origination identity. Type: String OriginationIdentityArn The PhoneNumberArn or SenderIdArn of the origination identity. Type: String Response Syntax API Version 2022-03-31 8 AWS End User Messaging SMS PoolArn API Reference The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity. Type: String PoolId The PoolId of the pool that is now associated with the origination identity. Type: String Errors For information about the errors |
amazonpinpointsmsvoicev2-api-007 | amazonpinpointsmsvoicev2-api.pdf | 7 | IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} OriginationIdentity The PhoneNumberId or SenderId of the origination identity. Type: String OriginationIdentityArn The PhoneNumberArn or SenderIdArn of the origination identity. Type: String Response Syntax API Version 2022-03-31 8 AWS End User Messaging SMS PoolArn API Reference The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity. Type: String PoolId The PoolId of the pool that is now associated with the origination identity. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Errors API Version 2022-03-31 9 AWS End User Messaging SMS API Reference ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 10 AWS End User Messaging SMS API Reference AssociateProtectConfiguration Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets. Request Syntax { "ConfigurationSetName": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the ConfigurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes AssociateProtectConfiguration API Version 2022-03-31 11 API Reference AWS End User Messaging SMS Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the ConfigurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Response Syntax API Version 2022-03-31 12 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. Errors API Version 2022-03-31 13 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API |
amazonpinpointsmsvoicev2-api-008 | amazonpinpointsmsvoicev2-api.pdf | 8 | of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. Errors API Version 2022-03-31 13 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 14 AWS End User Messaging SMS API Reference CreateConfigurationSet Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set. Request Syntax { "ClientToken": "string", "ConfigurationSetName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No CreateConfigurationSet API Version 2022-03-31 15 AWS End User Messaging SMS ConfigurationSetName The name to use for the new configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Pattern: [A-Za-z0-9_-]+ Required: Yes Tags An array of key and value pair tags that's associated with the new configuration set. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "CreatedTimestamp": number, "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2022-03-31 16 AWS End User Messaging SMS ConfigurationSetArn API Reference The Amazon Resource Name (ARN) of the newly created configuration set. Type: String ConfigurationSetName The name of the new configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ CreatedTimestamp The time when the configuration set was created, in UNIX epoch time format. Type: Timestamp Tags An array of key and value pair tags that's associated with the configuration set. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 17 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 18 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API |
amazonpinpointsmsvoicev2-api-009 | amazonpinpointsmsvoicev2-api.pdf | 9 | A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 18 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 19 AWS End User Messaging SMS API Reference CreateEventDestination Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination. Request Syntax { "ClientToken": "string", "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "ConfigurationSetName": "string", "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateEventDestination API Version 2022-03-31 20 AWS End User Messaging SMS ClientToken API Reference Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No CloudWatchLogsDestination An object that contains information about an event destination for logging to Amazon CloudWatch Logs. Type: CloudWatchLogsDestination object Required: No ConfigurationSetName Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes EventDestinationName The name that identifies the event destination. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Request Parameters API Version 2022-03-31 21 AWS End User Messaging SMS Pattern: [A-Za-z0-9_-]+ Required: Yes KinesisFirehoseDestination API Reference An object that contains information about an event destination for logging to Amazon Data Firehose. Type: KinesisFirehoseDestination object Required: No MatchingEventTypes An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type. Note The TEXT_SENT event type is not supported. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 43 items. Valid Values: ALL | TEXT_ALL | TEXT_SENT | TEXT_PENDING | TEXT_QUEUED | TEXT_SUCCESSFUL | TEXT_DELIVERED | TEXT_INVALID | TEXT_INVALID_MESSAGE | TEXT_UNREACHABLE | TEXT_CARRIER_UNREACHABLE | TEXT_BLOCKED | TEXT_CARRIER_BLOCKED | TEXT_SPAM | TEXT_UNKNOWN | TEXT_TTL_EXPIRED | TEXT_PROTECT_BLOCKED | VOICE_ALL | VOICE_INITIATED | VOICE_RINGING | VOICE_ANSWERED | VOICE_COMPLETED | VOICE_BUSY | VOICE_NO_ANSWER | VOICE_FAILED | VOICE_TTL_EXPIRED | MEDIA_ALL | MEDIA_PENDING | MEDIA_QUEUED | MEDIA_SUCCESSFUL | MEDIA_DELIVERED | MEDIA_INVALID | MEDIA_INVALID_MESSAGE | MEDIA_UNREACHABLE | MEDIA_CARRIER_UNREACHABLE | MEDIA_BLOCKED | MEDIA_CARRIER_BLOCKED | MEDIA_SPAM | MEDIA_UNKNOWN | MEDIA_TTL_EXPIRED | MEDIA_FILE_INACCESSIBLE | MEDIA_FILE_TYPE_UNSUPPORTED | MEDIA_FILE_SIZE_EXCEEDED Required: Yes Request Parameters API Version 2022-03-31 22 AWS End User Messaging SMS SnsDestination API Reference An object that contains information about an event destination for logging to Amazon SNS. Type: SnsDestination object Required: No Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "EventDestination": { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The ARN of the configuration set. Type: String Response Syntax API Version 2022-03-31 23 API Reference AWS End User Messaging SMS ConfigurationSetName The name of the configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ EventDestination The details of the destination where events are logged. Type: EventDestination object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you |
amazonpinpointsmsvoicev2-api-010 | amazonpinpointsmsvoicev2-api.pdf | 10 | action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The ARN of the configuration set. Type: String Response Syntax API Version 2022-03-31 23 API Reference AWS End User Messaging SMS ConfigurationSetName The name of the configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ EventDestination The details of the destination where events are logged. Type: EventDestination object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Errors API Version 2022-03-31 24 AWS End User Messaging SMS HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 25 AWS End User Messaging SMS CreateOptOutList Creates a new opt-out list. API Reference If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide. Request Syntax { "ClientToken": "string", "OptOutListName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ CreateOptOutList API Version 2022-03-31 26 API Reference AWS End User Messaging SMS Required: No OptOutListName The name of the new OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes Tags An array of tags (key and value pairs) to associate with the new OptOutList. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "CreatedTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2022-03-31 27 AWS End User Messaging SMS CreatedTimestamp API Reference The time when the pool was created, in UNIX epoch time format. Type: Timestamp OptOutListArn The Amazon Resource Name (ARN) for the OptOutList. Type: String OptOutListName The name of the new OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Tags An array of tags (key and value pairs) associated with the new OptOutList. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time |
amazonpinpointsmsvoicev2-api-011 | amazonpinpointsmsvoicev2-api.pdf | 11 | length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Tags An array of tags (key and value pairs) associated with the new OptOutList. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 28 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 29 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 30 AWS End User Messaging SMS CreatePool API Reference Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your AWS account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. Request Syntax { "ClientToken": "string", "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "OriginationIdentity": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String CreatePool API Version 2022-03-31 31 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No DeletionProtectionEnabled By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action. Type: Boolean Required: No IsoCountryCode The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Required: Yes OriginationIdentity The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and Request Parameters API Version 2022-03-31 32 AWS End User Messaging SMS API Reference PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn. After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Tags An array of tags (key and value pairs) associated with the pool. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "MessageType": "string", "OptOutListName": "string", "PoolArn": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "SharedRoutesEnabled": boolean, "Status": "string", Response Syntax API Version 2022-03-31 33 AWS End User Messaging SMS API Reference "Tags": [ { |
amazonpinpointsmsvoicev2-api-012 | amazonpinpointsmsvoicev2-api.pdf | 12 | User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Tags An array of tags (key and value pairs) associated with the pool. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "MessageType": "string", "OptOutListName": "string", "PoolArn": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "SharedRoutesEnabled": boolean, "Status": "string", Response Syntax API Version 2022-03-31 33 AWS End User Messaging SMS API Reference "Tags": [ { "Key": "string", "Value": "string" } ], "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the pool was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled When set to true deletion protection is enabled. By default this is set to false. Type: Boolean MessageType The type of message for the pool to use. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL OptOutListName The name of the OptOutList associated with the pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Response Elements API Version 2022-03-31 34 API Reference AWS End User Messaging SMS PoolArn The Amazon Resource Name (ARN) for the pool. Type: String PoolId The unique identifier for the pool. Type: String SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean SharedRoutesEnabled Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages. Type: Boolean Status The current status of the pool. • CREATING: The pool is currently being created and isn't yet available for use. • ACTIVE: The pool is active and available for use. • DELETING: The pool is being deleted. Type: String Valid Values: CREATING | ACTIVE | DELETING Tags An array of tags (key and value pairs) associated with the pool. Type: Array of Tag objects Response Elements API Version 2022-03-31 35 AWS End User Messaging SMS API Reference Array Members: Minimum number of 0 items. Maximum number of 200 items. TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 36 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2022-03-31 37 AWS End User Messaging SMS • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 38 AWS End User Messaging SMS API Reference CreateProtectConfiguration |
amazonpinpointsmsvoicev2-api-013 | amazonpinpointsmsvoicev2-api.pdf | 13 | Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2022-03-31 37 AWS End User Messaging SMS • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 38 AWS End User Messaging SMS API Reference CreateProtectConfiguration Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration. Request Syntax { "ClientToken": "string", "DeletionProtectionEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No DeletionProtectionEnabled When set to true deletion protection is enabled. By default this is set to false. CreateProtectConfiguration API Version 2022-03-31 39 AWS End User Messaging SMS Type: Boolean Required: No Tags API Reference An array of key and value pair tags that are associated with the resource. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "AccountDefault": boolean, "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountDefault This is true if the protect configuration is set as your account default protect configuration. Type: Boolean Response Syntax API Version 2022-03-31 40 AWS End User Messaging SMS CreatedTimestamp API Reference The time when the protect configuration was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled When set to true deletion protection is enabled. By default this is set to false. Type: Boolean ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Tags An array of key and value pair tags that are associated with the resource. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. Errors API Version 2022-03-31 41 AWS End User Messaging SMS HTTP Status Code: 400 ConflictException API Reference Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2022-03-31 42 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 43 AWS End User Messaging SMS CreateRegistration Creates a new registration based on the RegistrationType field. API Reference Request Syntax { "ClientToken": "string", "RegistrationType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information |
amazonpinpointsmsvoicev2-api-014 | amazonpinpointsmsvoicev2-api.pdf | 14 | SDK for C++ • AWS SDK for Go v2 See Also API Version 2022-03-31 42 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 43 AWS End User Messaging SMS CreateRegistration Creates a new registration based on the RegistrationType field. API Reference Request Syntax { "ClientToken": "string", "RegistrationType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No RegistrationType The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. CreateRegistration API Version 2022-03-31 44 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes Tags An array of tags (key and value pairs) to associate with the registration. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "AdditionalAttributes": { "string" : "string" }, "CreatedTimestamp": number, "CurrentVersionNumber": number, "RegistrationArn": "string", "RegistrationId": "string", "RegistrationStatus": "string", "RegistrationType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2022-03-31 45 AWS End User Messaging SMS AdditionalAttributes API Reference Metadata about a given registration which is specific to that registration type. Type: String to string map CreatedTimestamp The time when the registration was created, in UNIX epoch time format. Type: Timestamp CurrentVersionNumber The current version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationStatus The status of the registration. • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. • CREATED: Your registration is created but not submitted. • COMPLETE: Your registration has been approved and your origination identity has been created. • DELETED: The registration has been deleted. • PROVISIONING: Your registration has been approved and your origination identity is being created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. Response Elements API Version 2022-03-31 46 AWS End User Messaging SMS API Reference • REQUIRES_UPDATES: You must fix your registration and resubmit it. • REVIEWING: Your registration has been accepted and is being reviewed. • SUBMITTED: Your registration has been submitted and is awaiting review. Type: String Valid Values: CREATED | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | PROVISIONING | COMPLETE | REQUIRES_UPDATES | CLOSED | DELETED RegistrationType The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Tags An array of tags (key and value pairs) to associate with the registration. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 47 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK |
amazonpinpointsmsvoicev2-api-015 | amazonpinpointsmsvoicev2-api.pdf | 15 | encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 48 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 49 AWS End User Messaging SMS API Reference CreateRegistrationAssociation Associate the registration with an origination identity such as a phone number or sender ID. Request Syntax { "RegistrationId": "string", "ResourceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ResourceId The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes CreateRegistrationAssociation API Version 2022-03-31 50 API Reference AWS End User Messaging SMS Response Syntax { "IsoCountryCode": "string", "PhoneNumber": "string", "RegistrationArn": "string", "RegistrationId": "string", "RegistrationType": "string", "ResourceArn": "string", "ResourceId": "string", "ResourceType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} PhoneNumber The phone number associated with the registration in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String Response Syntax API Version 2022-03-31 51 AWS End User Messaging SMS RegistrationId The unique identifier for the registration. Type: String RegistrationType API Reference The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ ResourceArn The Amazon Resource Name (ARN) of the origination identity that is associated with the registration. Type: String ResourceId The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId. Type: String ResourceType The registration type or origination identity type. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. Errors API Version 2022-03-31 52 AWS End User Messaging SMS HTTP Status Code: 400 ConflictException API Reference Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2022-03-31 53 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 54 AWS End User Messaging SMS API Reference CreateRegistrationAttachment Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size |
amazonpinpointsmsvoicev2-api-016 | amazonpinpointsmsvoicev2-api.pdf | 16 | Version 2022-03-31 53 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 54 AWS End User Messaging SMS API Reference CreateRegistrationAttachment Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted. Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned. Request Syntax { "AttachmentBody": blob, "AttachmentUrl": "string", "ClientToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AttachmentBody The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1572864. Required: No CreateRegistrationAttachment API Version 2022-03-31 55 AWS End User Messaging SMS AttachmentUrl API Reference Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format s3://BucketName/FileName. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: \S+ Required: No ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No Tags An array of tags (key and value pairs) to associate with the registration attachment. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "AttachmentStatus": "string", "CreatedTimestamp": number, "RegistrationAttachmentArn": "string", "RegistrationAttachmentId": "string", Response Syntax API Version 2022-03-31 56 AWS End User Messaging SMS API Reference "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AttachmentStatus The status of the registration attachment. • UPLOAD_IN_PROGRESS The attachment is being uploaded. • UPLOAD_COMPLETE The attachment has been uploaded. • UPLOAD_FAILED The attachment failed to uploaded. • DELETED The attachment has been deleted.. Type: String Valid Values: UPLOAD_IN_PROGRESS | UPLOAD_COMPLETE | UPLOAD_FAILED | DELETED CreatedTimestamp The time when the registration attachment was created, in UNIX epoch time format. Type: Timestamp RegistrationAttachmentArn The Amazon Resource Name (ARN) for the registration attachment. Type: String RegistrationAttachmentId The unique identifier for the registration attachment. Type: String Response Elements API Version 2022-03-31 57 AWS End User Messaging SMS Tags API Reference An array of tags (key and value pairs) to associate with the registration attachment. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 Errors API Version 2022-03-31 58 AWS End User Messaging SMS ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 |
amazonpinpointsmsvoicev2-api-017 | amazonpinpointsmsvoicev2-api.pdf | 17 | Version 2022-03-31 58 AWS End User Messaging SMS ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 59 AWS End User Messaging SMS API Reference CreateRegistrationVersion Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only. Request Syntax { "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "RegistrationArn": "string", "RegistrationId": "string", "RegistrationVersionStatus": "string", "RegistrationVersionStatusHistory": { "ApprovedTimestamp": number, "ArchivedTimestamp": number, "DeniedTimestamp": number, "DiscardedTimestamp": number, CreateRegistrationVersion API Version 2022-03-31 60 AWS End User Messaging SMS API Reference "DraftTimestamp": number, "RequiresAuthenticationTimestamp": number, "ReviewingTimestamp": number, "RevokedTimestamp": number, "SubmittedTimestamp": number }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationVersionStatus The status of the registration. • APPROVED: Your registration has been approved. • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved. • DENIED: You must fix your registration and resubmit it. • DISCARDED: You've abandon this version of their registration to start over with a new version. • DRAFT: The initial status of a registration version after it’s created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REVIEWING: Your registration has been accepted and is being reviewed. • REVOKED: Your previously approved registration has been revoked. • SUBMITTED: Your registration has been submitted. Response Elements API Version 2022-03-31 61 AWS End User Messaging SMS Type: String API Reference Valid Values: DRAFT | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | APPROVED | DISCARDED | DENIED | REVOKED | ARCHIVED RegistrationVersionStatusHistory A RegistrationVersionStatusHistory object that contains timestamps for the registration. Type: RegistrationVersionStatusHistory object VersionNumber The new version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 62 API Reference AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 63 AWS End User Messaging SMS API Reference CreateVerifiedDestinationNumber You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers. Request Syntax { "ClientToken": "string", "DestinationPhoneNumber": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify |
amazonpinpointsmsvoicev2-api-018 | amazonpinpointsmsvoicev2-api.pdf | 18 | V3 See Also API Version 2022-03-31 63 AWS End User Messaging SMS API Reference CreateVerifiedDestinationNumber You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers. Request Syntax { "ClientToken": "string", "DestinationPhoneNumber": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No DestinationPhoneNumber The verified destination phone number, in E.164 format. CreateVerifiedDestinationNumber API Version 2022-03-31 64 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes Tags An array of tags (key and value pairs) to associate with the destination number. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VerifiedDestinationNumberArn": "string", "VerifiedDestinationNumberId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the verified phone number was created, in UNIX epoch time format. Response Syntax API Version 2022-03-31 65 API Reference AWS End User Messaging SMS Type: Timestamp DestinationPhoneNumber The verified destination phone number, in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Status The status of the verified destination phone number. • PENDING: The phone number hasn't been verified yet. • VERIFIED: The phone number is verified and can receive messages. Type: String Valid Values: PENDING | VERIFIED Tags An array of tags (key and value pairs) to associate with the destination number. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. VerifiedDestinationNumberArn The Amazon Resource Name (ARN) for the verified destination phone number. Type: String VerifiedDestinationNumberId The unique identifier for the verified destination phone number. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2022-03-31 66 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2022-03-31 67 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 68 AWS End User Messaging SMS API Reference DeleteAccountDefaultProtectConfiguration Removes the current account default protect configuration. Response Syntax { "DefaultProtectConfigurationArn": "string", "DefaultProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DefaultProtectConfigurationArn The Amazon Resource Name (ARN) of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ DefaultProtectConfigurationId The unique identifier of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. DeleteAccountDefaultProtectConfiguration API Version 2022-03-31 69 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to |
amazonpinpointsmsvoicev2-api-019 | amazonpinpointsmsvoicev2-api.pdf | 19 | The following data is returned in JSON format by the service. DefaultProtectConfigurationArn The Amazon Resource Name (ARN) of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ DefaultProtectConfigurationId The unique identifier of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. DeleteAccountDefaultProtectConfiguration API Version 2022-03-31 69 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-03-31 70 AWS End User Messaging SMS • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 71 AWS End User Messaging SMS API Reference DeleteConfigurationSet Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages. Request Syntax { "ConfigurationSetName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "CreatedTimestamp": number, DeleteConfigurationSet API Version 2022-03-31 72 AWS End User Messaging SMS API Reference "DefaultMessageFeedbackEnabled": boolean, "DefaultMessageType": "string", "DefaultSenderId": "string", "EventDestinations": [ { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the deleted configuration set. Type: String ConfigurationSetName The name of the deleted configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Response Elements API Version 2022-03-31 73 AWS End User Messaging SMS CreatedTimestamp API Reference The time that the deleted configuration set was created in UNIX epoch time format. Type: Timestamp DefaultMessageFeedbackEnabled True if the configuration set has message feedback enabled. By default this is set to false. Type: Boolean DefaultMessageType The default message type of the configuration set that was deleted. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL DefaultSenderId The default Sender ID of the configuration set that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ EventDestinations An array of any EventDestination objects that were associated with the deleted configuration set. Type: Array of EventDestination objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. Errors API Version 2022-03-31 74 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS |
amazonpinpointsmsvoicev2-api-020 | amazonpinpointsmsvoicev2-api.pdf | 20 | request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 75 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 76 AWS End User Messaging SMS API Reference DeleteDefaultMessageType Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire AWS account. Request Syntax { "ConfigurationSetName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", DeleteDefaultMessageType API Version 2022-03-31 77 AWS End User Messaging SMS API Reference "ConfigurationSetName": "string", "MessageType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ MessageType The current message type for the configuration set. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 78 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 79 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 80 AWS End User Messaging SMS API Reference DeleteDefaultSenderId Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region. Request Syntax { "ConfigurationSetName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "SenderId": "string" DeleteDefaultSenderId API Version 2022-03-31 81 API Reference AWS End User Messaging SMS } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the configuration set. Type: String Length Constraints: Minimum |
amazonpinpointsmsvoicev2-api-021 | amazonpinpointsmsvoicev2-api.pdf | 21 | from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "SenderId": "string" DeleteDefaultSenderId API Version 2022-03-31 81 API Reference AWS End User Messaging SMS } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ SenderId The current sender ID for the configuration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 82 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 83 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 84 AWS End User Messaging SMS API Reference DeleteEventDestination Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. Request Syntax { "ConfigurationSetName": "string", "EventDestinationName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes EventDestinationName The name of the event destination to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. DeleteEventDestination API Version 2022-03-31 85 API Reference AWS End User Messaging SMS Pattern: [A-Za-z0-9_-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "EventDestination": { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the configuration set the event destination was deleted from. Response Syntax API Version 2022-03-31 86 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ EventDestination The event destination object that was deleted. Type: EventDestination object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 87 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • |
amazonpinpointsmsvoicev2-api-022 | amazonpinpointsmsvoicev2-api.pdf | 22 | be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 87 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 88 AWS End User Messaging SMS DeleteKeyword API Reference Deletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified. Request Syntax { "Keyword": "string", "OriginationIdentity": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Keyword The keyword to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ Required: Yes OriginationIdentity The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn. DeleteKeyword API Version 2022-03-31 89 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "Keyword": "string", "KeywordAction": "string", "KeywordMessage": "string", "OriginationIdentity": "string", "OriginationIdentityArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Keyword The keyword that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ Response Syntax API Version 2022-03-31 90 AWS End User Messaging SMS KeywordAction API Reference The action that was associated with the deleted keyword. Type: String Valid Values: AUTOMATIC_RESPONSE | OPT_OUT | OPT_IN KeywordMessage The message that was associated with the deleted keyword. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ OriginationIdentity The PhoneNumberId or PoolId that the keyword was associated with. Type: String OriginationIdentityArn The PhoneNumberArn or PoolArn that the keyword was associated with. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 91 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 92 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 93 AWS End User Messaging SMS API |
amazonpinpointsmsvoicev2-api-023 | amazonpinpointsmsvoicev2-api.pdf | 23 | 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 92 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 93 AWS End User Messaging SMS API Reference DeleteMediaMessageSpendLimitOverride Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by AWS. For more information on spend limits (quotas) see Quotas for AWS SMS in the AWS SMS User Guide. Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MonthlyLimit The current monthly limit, in US dollars. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. DeleteMediaMessageSpendLimitOverride API Version 2022-03-31 94 AWS End User Messaging SMS HTTP Status Code: 500 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 95 AWS End User Messaging SMS API Reference DeleteOptedOutNumber Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned. Request Syntax { "OptedOutNumber": "string", "OptOutListName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OptedOutNumber The phone number, in E.164 format, to remove from the OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes OptOutListName The OptOutListName or OptOutListArn to remove the phone number from. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). DeleteOptedOutNumber API Version 2022-03-31 96 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "EndUserOptedOut": boolean, "OptedOutNumber": "string", "OptedOutTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndUserOptedOut This is true if it was the end user who requested their phone number be removed. Type: Boolean OptedOutNumber The phone number that was removed from the OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} OptedOutTimestamp The time that the number was removed at, in UNIX epoch time format. Response Syntax API Version 2022-03-31 97 API Reference AWS End User Messaging SMS Type: Timestamp OptOutListArn The OptOutListArn that the phone number was removed from. Type: String OptOutListName The OptOutListName that the phone number was removed from. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException The API encountered |
amazonpinpointsmsvoicev2-api-024 | amazonpinpointsmsvoicev2-api.pdf | 24 | String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Errors API Version 2022-03-31 98 AWS End User Messaging SMS HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 99 AWS End User Messaging SMS DeleteOptOutList API Reference Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned. Request Syntax { "OptOutListName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OptOutListName The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { DeleteOptOutList API Version 2022-03-31 100 AWS End User Messaging SMS API Reference "CreatedTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the OptOutList was created, in UNIX epoch time format. Type: Timestamp OptOutListArn The Amazon Resource Name (ARN) of the OptOutList that was removed. Type: String OptOutListName The name of the OptOutList that was removed. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 101 AWS End User Messaging SMS ConflictException API Reference Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2022-03-31 102 AWS End User Messaging SMS • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 103 AWS End User Messaging SMS DeletePool API Reference Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool |
amazonpinpointsmsvoicev2-api-025 | amazonpinpointsmsvoicev2-api.pdf | 25 | C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2022-03-31 102 AWS End User Messaging SMS • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 103 AWS End User Messaging SMS DeletePool API Reference Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your AWS account. Request Syntax { "PoolId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PoolId The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn . Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes DeletePool API Version 2022-03-31 104 API Reference AWS End User Messaging SMS Response Syntax { "CreatedTimestamp": number, "MessageType": "string", "OptOutListName": "string", "PoolArn": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "SharedRoutesEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the pool was created, in UNIX epoch time format. Type: Timestamp MessageType The message type that was associated with the deleted pool. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL OptOutListName The name of the OptOutList that was associated with the deleted pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Response Syntax API Version 2022-03-31 105 AWS End User Messaging SMS Pattern: [A-Za-z0-9_-]+ PoolArn The Amazon Resource Name (ARN) of the pool that was deleted. API Reference Type: String PoolId The PoolId of the pool that was deleted. Type: String SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean SharedRoutesEnabled Indicates whether shared routes are enabled for the pool. Type: Boolean Status The current status of the pool. • CREATING: The pool is currently being created and isn't yet available for use. • ACTIVE: The pool is active and available for use. • DELETING: The pool is being deleted. Type: String Valid Values: CREATING | ACTIVE | DELETING TwoWayChannelArn The Amazon Resource Name (ARN) of the TwoWayChannel. Type: String Response Elements API Version 2022-03-31 106 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 107 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK |
amazonpinpointsmsvoicev2-api-026 | amazonpinpointsmsvoicev2-api.pdf | 26 | request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 Errors API Version 2022-03-31 107 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 108 AWS End User Messaging SMS API Reference DeleteProtectConfiguration Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set. Request Syntax { "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "AccountDefault": boolean, "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } DeleteProtectConfiguration API Version 2022-03-31 109 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountDefault This is true if the protect configuration is set as your account default protect configuration. Type: Boolean CreatedTimestamp The time when the protect configuration was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false. Type: Boolean ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Response Elements API Version 2022-03-31 110 AWS End User Messaging SMS Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 111 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 112 AWS End User Messaging SMS API Reference DeleteProtectConfigurationRuleSetNumberOverride Permanently delete the protect configuration rule set number override. Request Syntax { "DestinationPhoneNumber": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes DeleteProtectConfigurationRuleSetNumberOverride API Version 2022-03-31 113 API Reference AWS End User Messaging SMS Response Syntax { "Action": "string", "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "ExpirationTimestamp": number, "IsoCountryCode": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, |
amazonpinpointsmsvoicev2-api-027 | amazonpinpointsmsvoicev2-api.pdf | 27 | to all actions, see Common Parameters. The request accepts the following data in JSON format. DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes DeleteProtectConfigurationRuleSetNumberOverride API Version 2022-03-31 113 API Reference AWS End User Messaging SMS Response Syntax { "Action": "string", "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "ExpirationTimestamp": number, "IsoCountryCode": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Action The action associated with the rule. Type: String Valid Values: ALLOW | BLOCK CreatedTimestamp The time when the rule was created, in UNIX epoch time format. Type: Timestamp DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} ExpirationTimestamp The time when the resource-based policy was created, in UNIX epoch time format. Response Syntax API Version 2022-03-31 114 AWS End User Messaging SMS Type: Timestamp IsoCountryCode API Reference The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. Errors API Version 2022-03-31 115 AWS End User Messaging SMS HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 116 AWS End User Messaging SMS DeleteRegistration Permanently delete an existing registration from your account. API Reference Request Syntax { "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "AdditionalAttributes": { "string" : "string" }, "ApprovedVersionNumber": number, "CreatedTimestamp": number, "CurrentVersionNumber": number, "LatestDeniedVersionNumber": number, "RegistrationArn": "string", "RegistrationId": "string", DeleteRegistration API Version 2022-03-31 117 AWS End User Messaging SMS API Reference "RegistrationStatus": "string", "RegistrationType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AdditionalAttributes Metadata about a given registration which is specific to that registration type. Type: String to string map ApprovedVersionNumber The version number of the registration that was approved. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. CreatedTimestamp The time when the registration was created, in UNIX epoch time format. Type: Timestamp CurrentVersionNumber The current version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. LatestDeniedVersionNumber The latest version number of the registration that was denied. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Response Elements API Version 2022-03-31 118 AWS End User Messaging SMS RegistrationArn The Amazon Resource Name (ARN) for the registration. API Reference Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationStatus The status of the registration. • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. • CREATED: Your registration is created but not submitted. • COMPLETE: Your registration has been approved and your origination identity has been created. • DELETED: The registration has been deleted. • PROVISIONING: Your registration has been approved and your origination identity |
amazonpinpointsmsvoicev2-api-028 | amazonpinpointsmsvoicev2-api.pdf | 28 | Elements API Version 2022-03-31 118 AWS End User Messaging SMS RegistrationArn The Amazon Resource Name (ARN) for the registration. API Reference Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationStatus The status of the registration. • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. • CREATED: Your registration is created but not submitted. • COMPLETE: Your registration has been approved and your origination identity has been created. • DELETED: The registration has been deleted. • PROVISIONING: Your registration has been approved and your origination identity is being created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REQUIRES_UPDATES: You must fix your registration and resubmit it. • REVIEWING: Your registration has been accepted and is being reviewed. • SUBMITTED: Your registration has been submitted and is awaiting review. Type: String Valid Values: CREATED | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | PROVISIONING | COMPLETE | REQUIRES_UPDATES | CLOSED | DELETED RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Response Elements API Version 2022-03-31 119 AWS End User Messaging SMS Pattern: [A-Za-z0-9_]+ Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 120 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 121 AWS End User Messaging SMS API Reference DeleteRegistrationAttachment Permanently delete the specified registration attachment. Request Syntax { "RegistrationAttachmentId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationAttachmentId The unique identifier for the registration attachment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "AttachmentStatus": "string", "AttachmentUploadErrorReason": "string", "CreatedTimestamp": number, "RegistrationAttachmentArn": "string", "RegistrationAttachmentId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DeleteRegistrationAttachment API Version 2022-03-31 122 AWS End User Messaging SMS API Reference The following data is returned in JSON format by the service. AttachmentStatus The status of the registration attachment. • UPLOAD_IN_PROGRESS The attachment is being uploaded. • UPLOAD_COMPLETE The attachment has been uploaded. • UPLOAD_FAILED The attachment failed to uploaded. • DELETED The attachment has been deleted.. Type: String Valid Values: UPLOAD_IN_PROGRESS | UPLOAD_COMPLETE | UPLOAD_FAILED | DELETED AttachmentUploadErrorReason The error message if the upload failed. Type: String Valid Values: INTERNAL_ERROR CreatedTimestamp The time when the registration attachment was created, in UNIX epoch time format. Type: Timestamp RegistrationAttachmentArn The Amazon Resource Name (ARN) for the registration attachment. Type: String RegistrationAttachmentId The unique identifier for the registration attachment. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2022-03-31 123 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested |
amazonpinpointsmsvoicev2-api-029 | amazonpinpointsmsvoicev2-api.pdf | 29 | Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2022-03-31 124 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 125 AWS End User Messaging SMS API Reference DeleteRegistrationFieldValue Delete the value in a registration form field. Request Syntax { "FieldPath": "string", "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FieldPath The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: Yes RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes DeleteRegistrationFieldValue API Version 2022-03-31 126 AWS End User Messaging SMS Response Syntax { "FieldPath": "string", "RegistrationArn": "string", "RegistrationAttachmentId": "string", "RegistrationId": "string", "SelectChoices": [ "string" ], "TextValue": "string", "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FieldPath The path to the registration form field. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationAttachmentId The unique identifier for the registration attachment. Type: String RegistrationId The unique identifier for the registration. Type: String Response Syntax API Reference API Version 2022-03-31 127 API Reference AWS End User Messaging SMS SelectChoices An array of values for the form field. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 256. TextValue The text data for a free form field. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. VersionNumber The version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 Errors API Version 2022-03-31 128 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 129 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 130 AWS End User Messaging |
amazonpinpointsmsvoicev2-api-030 | amazonpinpointsmsvoicev2-api.pdf | 30 | Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 129 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 130 AWS End User Messaging SMS API Reference DeleteResourcePolicy 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. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "CreatedTimestamp": number, "Policy": "string", "ResourceArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DeleteResourcePolicy API Version 2022-03-31 131 AWS End User Messaging SMS API Reference The following data is returned in JSON format by the service. CreatedTimestamp The time when the resource-based policy was created, in UNIX epoch time format. Type: Timestamp Policy The JSON formatted resource-based policy that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 132 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 133 AWS End User Messaging SMS API Reference DeleteTextMessageSpendLimitOverride Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by AWS. For more information on spend limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide. Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MonthlyLimit The current monthly limit, in US dollars. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. DeleteTextMessageSpendLimitOverride API Version 2022-03-31 134 AWS End User Messaging SMS HTTP Status Code: 500 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 |
amazonpinpointsmsvoicev2-api-031 | amazonpinpointsmsvoicev2-api.pdf | 31 | Status Code: 500 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 135 AWS End User Messaging SMS API Reference DeleteVerifiedDestinationNumber Delete a verified destination phone number. Request Syntax { "VerifiedDestinationNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VerifiedDestinationNumberId The unique identifier for the verified destination phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "VerifiedDestinationNumberArn": "string", "VerifiedDestinationNumberId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DeleteVerifiedDestinationNumber API Version 2022-03-31 136 AWS End User Messaging SMS API Reference The following data is returned in JSON format by the service. CreatedTimestamp The time when the destination phone number was created, in UNIX epoch time format. Type: Timestamp DestinationPhoneNumber The verified destination phone number, in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} VerifiedDestinationNumberArn The Amazon Resource Name (ARN) for the verified destination phone number. Type: String VerifiedDestinationNumberId The unique identifier for the verified destination phone number. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. Errors API Version 2022-03-31 137 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 138 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 139 AWS End User Messaging SMS API Reference DeleteVoiceMessageSpendLimitOverride Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by AWS. For more information on spending limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide. Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MonthlyLimit The current monthly limit, in US dollars. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. DeleteVoiceMessageSpendLimitOverride API Version 2022-03-31 140 AWS End User Messaging SMS HTTP Status Code: 500 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command |
amazonpinpointsmsvoicev2-api-032 | amazonpinpointsmsvoicev2-api.pdf | 32 | resource. HTTP Status Code: 400 InternalServerException 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. DeleteVoiceMessageSpendLimitOverride API Version 2022-03-31 140 AWS End User Messaging SMS HTTP Status Code: 500 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 141 AWS End User Messaging SMS API Reference DescribeAccountAttributes Describes attributes of your AWS account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an AWS Support case for a service limit increase request. New accounts are placed into an SMS or voice sandbox. The sandbox protects both AWS end recipients and SMS or voice recipients from fraud and abuse. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. DescribeAccountAttributes API Version 2022-03-31 142 AWS End User Messaging SMS API Reference Pattern: .+ Required: No Response Syntax { "AccountAttributes": [ { "Name": "string", "Value": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountAttributes An array of AccountAttributes objects. Type: Array of AccountAttribute objects NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2022-03-31 143 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 144 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 145 AWS End User Messaging SMS API Reference DescribeAccountLimits Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. When you establish an AWS account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the |
amazonpinpointsmsvoicev2-api-033 | amazonpinpointsmsvoicev2-api.pdf | 33 | the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ DescribeAccountLimits API Version 2022-03-31 146 API Reference AWS End User Messaging SMS Required: No Response Syntax { "AccountLimits": [ { "Max": number, "Name": "string", "Used": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountLimits An array of AccountLimit objects that show the current spend limits. Type: Array of AccountLimit objects NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2022-03-31 147 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 148 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 149 AWS End User Messaging SMS API Reference DescribeConfigurationSets Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned. Request Syntax { "ConfigurationSetNames": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetNames An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. DescribeConfigurationSets API Version 2022-03-31 150 AWS End User Messaging SMS API Reference Pattern: [A-Za-z0-9_:/-]+ Required: No Filters An array of filters to apply to the results that are returned. Type: Array of ConfigurationSetFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No Response Syntax { "ConfigurationSets": [ { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", Response Syntax API Version 2022-03-31 151 AWS End User Messaging SMS API Reference "CreatedTimestamp": number, "DefaultMessageFeedbackEnabled": boolean, "DefaultMessageType": "string", "DefaultSenderId": "string", "EventDestinations": [ { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } ], "ProtectConfigurationId": "string" } ], |
amazonpinpointsmsvoicev2-api-034 | amazonpinpointsmsvoicev2-api.pdf | 34 | of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No Response Syntax { "ConfigurationSets": [ { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", Response Syntax API Version 2022-03-31 151 AWS End User Messaging SMS API Reference "CreatedTimestamp": number, "DefaultMessageFeedbackEnabled": boolean, "DefaultMessageType": "string", "DefaultSenderId": "string", "EventDestinations": [ { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } ], "ProtectConfigurationId": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSets An array of ConfigurationSets objects. Type: Array of ConfigurationSetInformation objects NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Response Elements API Version 2022-03-31 152 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2022-03-31 153 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 154 AWS End User Messaging SMS DescribeKeywords API Reference Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. If you specify a keyword that isn't valid, an error is returned. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "Keywords": [ "string" ], "MaxResults": number, "NextToken": "string", "OriginationIdentity": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of keyword filters to filter the results. Type: Array of KeywordFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No DescribeKeywords API Version 2022-03-31 155 API Reference AWS End User Messaging SMS Keywords An array of keywords to search for. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No OriginationIdentity The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or 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. Request Parameters API Version 2022-03-31 156 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "Keywords": [ { "Keyword": "string", "KeywordAction": "string", "KeywordMessage": "string" } ], "NextToken": "string", "OriginationIdentity": |
amazonpinpointsmsvoicev2-api-035 | amazonpinpointsmsvoicev2-api.pdf | 35 | PhoneNumberId, PhoneNumberArn, SenderId or 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. Request Parameters API Version 2022-03-31 156 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "Keywords": [ { "Keyword": "string", "KeywordAction": "string", "KeywordMessage": "string" } ], "NextToken": "string", "OriginationIdentity": "string", "OriginationIdentityArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Keywords An array of KeywordInformation objects that contain the results. Type: Array of KeywordInformation objects Response Syntax API Version 2022-03-31 157 AWS End User Messaging SMS NextToken API Reference The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ OriginationIdentity The PhoneNumberId or PoolId that is associated with the OriginationIdentity. Type: String OriginationIdentityArn The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Errors API Version 2022-03-31 158 AWS End User Messaging SMS ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 159 AWS End User Messaging SMS API Reference DescribeOptedOutNumbers Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an exception is returned. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "OptedOutNumbers": [ "string" ], "OptOutListName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of OptedOutFilter objects to filter the results on. Type: Array of OptedOutFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. DescribeOptedOutNumbers API Version 2022-03-31 160 API Reference AWS End User Messaging SMS Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No OptedOutNumbers An array of phone numbers to search for in the OptOutList. If you specify an opted out number that isn't valid, an exception is returned. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No OptOutListName The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn. Request Parameters API Version 2022-03-31 161 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum |
amazonpinpointsmsvoicev2-api-036 | amazonpinpointsmsvoicev2-api.pdf | 36 | an exception is returned. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No OptOutListName The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn. Request Parameters API Version 2022-03-31 161 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "NextToken": "string", "OptedOutNumbers": [ { "EndUserOptedOut": boolean, "OptedOutNumber": "string", "OptedOutTimestamp": number } ], "OptOutListArn": "string", "OptOutListName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Response Syntax API Version 2022-03-31 162 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ OptedOutNumbers An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers. Type: Array of OptedOutNumberInformation objects OptOutListArn The Amazon Resource Name (ARN) of the OptOutList. Type: String OptOutListName The name of the OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 163 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 164 AWS End User Messaging SMS API Reference DescribeOptOutLists Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an error is returned. Request Syntax { "MaxResults": number, "NextToken": "string", "OptOutListNames": [ "string" ], "Owner": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String DescribeOptOutLists API Version 2022-03-31 165 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No OptOutListNames The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Owner 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. Type: String Valid Values: SELF | SHARED Required: No Response Syntax { Response Syntax API Version 2022-03-31 166 AWS End User Messaging SMS API Reference "NextToken": "string", "OptOutLists": [ { "CreatedTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" } |
amazonpinpointsmsvoicev2-api-037 | amazonpinpointsmsvoicev2-api.pdf | 37 | Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Owner 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. Type: String Valid Values: SELF | SHARED Required: No Response Syntax { Response Syntax API Version 2022-03-31 166 AWS End User Messaging SMS API Reference "NextToken": "string", "OptOutLists": [ { "CreatedTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ OptOutLists An array of OptOutListInformation objects that contain the details for the requested OptOutLists. Type: Array of OptOutListInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 167 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 168 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 169 AWS End User Messaging SMS API Reference DescribePhoneNumbers Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an error is returned. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "Owner": "string", "PhoneNumberIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of PhoneNumberFilter objects to filter the results. Type: Array of PhoneNumberFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No DescribePhoneNumbers API Version 2022-03-31 170 AWS End User Messaging SMS MaxResults API Reference The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No Owner 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. Type: String Valid Values: SELF | SHARED Required: No PhoneNumberIds The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 171 AWS End User Messaging SMS Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "PhoneNumbers": [ { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": |
amazonpinpointsmsvoicev2-api-038 | amazonpinpointsmsvoicev2-api.pdf | 38 | information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 171 AWS End User Messaging SMS Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "PhoneNumbers": [ { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PhoneNumber": "string", "PhoneNumberArn": "string", "PhoneNumberId": "string", "PoolId": "string", "RegistrationId": "string", "SelfManagedOptOutsEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2022-03-31 172 AWS End User Messaging SMS API Reference The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ PhoneNumbers An array of PhoneNumberInformation objects that contain the details for the requested phone numbers. Type: Array of PhoneNumberInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. Errors API Version 2022-03-31 173 AWS End User Messaging SMS HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 174 AWS End User Messaging SMS DescribePools API Reference Retrieves the specified pools or all pools associated with your AWS account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your AWS account. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "Owner": "string", "PoolIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of PoolFilter objects to filter the results. Type: Array of PoolFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. DescribePools API Version 2022-03-31 175 API Reference AWS End User Messaging SMS Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No Owner 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. Type: String Valid Values: SELF | SHARED Required: No PoolIds The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 176 AWS End User Messaging SMS Type: Array of strings |
amazonpinpointsmsvoicev2-api-039 | amazonpinpointsmsvoicev2-api.pdf | 39 | 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. Type: String Valid Values: SELF | SHARED Required: No PoolIds The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 176 AWS End User Messaging SMS Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "Pools": [ { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "MessageType": "string", "OptOutListName": "string", "PoolArn": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "SharedRoutesEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Response Syntax API Version 2022-03-31 177 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Pools An array of PoolInformation objects that contain the details for the requested pools. Type: Array of PoolInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 178 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 179 AWS End User Messaging SMS API Reference DescribeProtectConfigurations Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ProtectConfigurationIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of ProtectConfigurationFilter objects to filter the results. Type: Array of ProtectConfigurationFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeProtectConfigurations API Version 2022-03-31 180 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No ProtectConfigurationIds An array of protect configuration identifiers to search for. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "ProtectConfigurations": [ { "AccountDefault": boolean, "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } ] } Response Syntax API Version 2022-03-31 181 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ ProtectConfigurations An array of ProtectConfigurationInformation objects that contain the details for the request. Type: Array of ProtectConfigurationInformation |
amazonpinpointsmsvoicev2-api-040 | amazonpinpointsmsvoicev2-api.pdf | 40 | } ] } Response Syntax API Version 2022-03-31 181 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ ProtectConfigurations An array of ProtectConfigurationInformation objects that contain the details for the request. Type: Array of ProtectConfigurationInformation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Response Elements API Version 2022-03-31 182 AWS End User Messaging SMS HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 183 AWS End User Messaging SMS API Reference DescribeRegistrationAttachments Retrieves the specified registration attachments or all registration attachments associated with your AWS account. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationAttachmentIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationAttachmentFilter objects to filter the results. Type: Array of RegistrationAttachmentFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeRegistrationAttachments API Version 2022-03-31 184 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationAttachmentIds The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "RegistrationAttachments": [ { "AttachmentStatus": "string", "AttachmentUploadErrorReason": "string", "CreatedTimestamp": number, "RegistrationAttachmentArn": "string", "RegistrationAttachmentId": "string" } ] Response Syntax API Version 2022-03-31 185 AWS End User Messaging SMS } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationAttachments An array of RegistrationAttachments objects that contain the details for the requested registration attachments. Type: Array of RegistrationAttachmentsInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Response Elements API Version 2022-03-31 186 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface |
amazonpinpointsmsvoicev2-api-041 | amazonpinpointsmsvoicev2-api.pdf | 41 | complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 Response Elements API Version 2022-03-31 186 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 187 AWS End User Messaging SMS API Reference DescribeRegistrationFieldDefinitions Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type. Request Syntax { "FieldPaths": [ "string" ], "MaxResults": number, "NextToken": "string", "RegistrationType": "string", "SectionPath": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FieldPaths An array of paths to the registration form field. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeRegistrationFieldDefinitions API Version 2022-03-31 188 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes SectionPath The path to the section of the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_]+ Required: No Response Syntax { Response Syntax API Version 2022-03-31 189 AWS End User Messaging SMS API Reference "NextToken": "string", "RegistrationFieldDefinitions": [ { "DisplayHints": { "DocumentationLink": "string", "DocumentationTitle": "string", "ExampleTextValue": "string", "LongDescription": "string", "SelectOptionDescriptions": [ { "Description": "string", "Option": "string", "Title": "string" } ], "ShortDescription": "string", "TextValidationDescription": "string", "Title": "string" }, "FieldPath": "string", "FieldRequirement": "string", "FieldType": "string", "SectionPath": "string", "SelectValidation": { "MaxChoices": number, "MinChoices": number, "Options": [ "string" ] }, "TextValidation": { "MaxLength": number, "MinLength": number, "Pattern": "string" } } ], "RegistrationType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2022-03-31 190 AWS End User Messaging SMS NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationFieldDefinitions An array of RegistrationFieldDefinitions objects that contain the details for the requested fields. Type: Array of RegistrationFieldDefinition objects RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 191 AWS End User Messaging SMS ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 |
amazonpinpointsmsvoicev2-api-042 | amazonpinpointsmsvoicev2-api.pdf | 42 | too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 192 AWS End User Messaging SMS API Reference DescribeRegistrationFieldValues Retrieves the specified registration field values. Request Syntax { "FieldPaths": [ "string" ], "MaxResults": number, "NextToken": "string", "RegistrationId": "string", "SectionPath": "string", "VersionNumber": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FieldPaths An array of paths to the registration form field. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeRegistrationFieldValues API Version 2022-03-31 193 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes SectionPath The path to the section of the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_]+ Required: No VersionNumber The version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Request Parameters API Version 2022-03-31 194 API Reference AWS End User Messaging SMS Required: No Response Syntax { "NextToken": "string", "RegistrationArn": "string", "RegistrationFieldValues": [ { "DeniedReason": "string", "FieldPath": "string", "RegistrationAttachmentId": "string", "SelectChoices": [ "string" ], "TextValue": "string" } ], "RegistrationId": "string", "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String Response Syntax API Version 2022-03-31 195 AWS End User Messaging SMS RegistrationFieldValues API Reference An array of RegistrationFieldValues objects that contain the values for the requested registration. Type: Array of RegistrationFieldValueInformation objects RegistrationId The unique identifier for the registration. Type: String VersionNumber The current version of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Errors API Version 2022-03-31 196 AWS End User Messaging SMS ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 197 AWS End User Messaging SMS API Reference DescribeRegistrations Retrieves the specified registrations. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationFilter objects to filter the results. |
amazonpinpointsmsvoicev2-api-043 | amazonpinpointsmsvoicev2-api.pdf | 43 | JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 197 AWS End User Messaging SMS API Reference DescribeRegistrations Retrieves the specified registrations. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationFilter objects to filter the results. Type: Array of RegistrationFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No DescribeRegistrations API Version 2022-03-31 198 AWS End User Messaging SMS NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationIds An array of unique identifiers for each registration. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { "NextToken": "string", "Registrations": [ { "AdditionalAttributes": { "string" : "string" }, "ApprovedVersionNumber": number, "CreatedTimestamp": number, "CurrentVersionNumber": number, "LatestDeniedVersionNumber": number, "RegistrationArn": "string", "RegistrationId": "string", "RegistrationStatus": "string", Response Syntax API Version 2022-03-31 199 AWS End User Messaging SMS API Reference "RegistrationType": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Registrations An array of RegistrationInformation objects. Type: Array of RegistrationInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. Response Elements API Version 2022-03-31 200 AWS End User Messaging SMS HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 201 AWS End User Messaging SMS API Reference DescribeRegistrationSectionDefinitions Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type. Request Syntax { "MaxResults": number, "NextToken": "string", "RegistrationType": "string", "SectionPaths": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ DescribeRegistrationSectionDefinitions API Version 2022-03-31 202 AWS End User Messaging SMS Required: No RegistrationType API Reference The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes SectionPaths An array of paths for the registration form section. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_]+ Required: No Response Syntax { "NextToken": "string", "RegistrationSectionDefinitions": [ { "DisplayHints": { "DocumentationLink": "string", "DocumentationTitle": "string", "LongDescription": "string", |
amazonpinpointsmsvoicev2-api-044 | amazonpinpointsmsvoicev2-api.pdf | 44 | 2022-03-31 202 AWS End User Messaging SMS Required: No RegistrationType API Reference The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes SectionPaths An array of paths for the registration form section. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_]+ Required: No Response Syntax { "NextToken": "string", "RegistrationSectionDefinitions": [ { "DisplayHints": { "DocumentationLink": "string", "DocumentationTitle": "string", "LongDescription": "string", "ShortDescription": "string", "Title": "string" }, "SectionPath": "string" Response Syntax API Version 2022-03-31 203 AWS End User Messaging SMS } ], "RegistrationType": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationSectionDefinitions An array of RegistrationSectionDefinition objects. Type: Array of RegistrationSectionDefinition objects RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2022-03-31 204 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 205 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 206 AWS End User Messaging SMS API Reference DescribeRegistrationTypeDefinitions Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationTypes": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationFilter objects to filter the results. Type: Array of RegistrationTypeFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeRegistrationTypeDefinitions API Version 2022-03-31 207 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationTypes The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: No Response Syntax { "NextToken": "string", "RegistrationTypeDefinitions": [ { "DisplayHints": { "DocumentationLink": "string", "DocumentationTitle": "string", "LongDescription": "string", "ShortDescription": "string", "Title": "string" }, "RegistrationType": "string", Response Syntax API Version 2022-03-31 208 AWS End User Messaging SMS API Reference "SupportedAssociations": [ { "AssociationBehavior": "string", "DisassociationBehavior": "string", "IsoCountryCode": "string", "ResourceType": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationTypeDefinitions The type of registration form. The list of RegistrationTypes can |
amazonpinpointsmsvoicev2-api-045 | amazonpinpointsmsvoicev2-api.pdf | 45 | End User Messaging SMS API Reference "SupportedAssociations": [ { "AssociationBehavior": "string", "DisassociationBehavior": "string", "IsoCountryCode": "string", "ResourceType": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationTypeDefinitions The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: Array of RegistrationTypeDefinition objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. Response Elements API Version 2022-03-31 209 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 210 AWS End User Messaging SMS API Reference DescribeRegistrationVersions Retrieves the specified registration version. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationId": "string", "VersionNumbers": [ number ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationVersionFilter objects to filter the results. Type: Array of RegistrationVersionFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeRegistrationVersions API Version 2022-03-31 211 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes VersionNumbers An array of registration version numbers. Type: Array of longs Array Members: Minimum number of 0 items. Maximum number of 5 items. Valid Range: Minimum value of 1. Maximum value of 100000. Required: No Response Syntax { "NextToken": "string", "RegistrationArn": "string", Response Syntax API Version 2022-03-31 212 AWS End User Messaging SMS API Reference "RegistrationId": "string", "RegistrationVersions": [ { "DeniedReasons": [ { "DocumentationLink": "string", "DocumentationTitle": "string", "LongDescription": "string", "Reason": "string", "ShortDescription": "string" } ], "RegistrationVersionStatus": "string", "RegistrationVersionStatusHistory": { "ApprovedTimestamp": number, "ArchivedTimestamp": number, "DeniedTimestamp": number, "DiscardedTimestamp": number, "DraftTimestamp": number, "RequiresAuthenticationTimestamp": number, "ReviewingTimestamp": number, "RevokedTimestamp": number, "SubmittedTimestamp": number }, "VersionNumber": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Response Elements API Version 2022-03-31 213 API Reference AWS End User Messaging SMS Pattern: .+ RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationVersions An array of RegistrationVersions objects. Type: Array of RegistrationVersionInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. Errors |
amazonpinpointsmsvoicev2-api-046 | amazonpinpointsmsvoicev2-api.pdf | 46 | of RegistrationVersions objects. Type: Array of RegistrationVersionInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. Errors API Version 2022-03-31 214 AWS End User Messaging SMS HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 215 AWS End User Messaging SMS DescribeSenderIds API Reference Describes the specified SenderIds or all SenderIds associated with your AWS account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "Owner": "string", "SenderIds": [ { "IsoCountryCode": "string", "SenderId": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of SenderIdFilter objects to filter the results. Type: Array of SenderIdFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. DescribeSenderIds API Version 2022-03-31 216 API Reference AWS End User Messaging SMS Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No Owner 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. Type: String Valid Values: SELF | SHARED Required: No SenderIds An array of SenderIdAndCountry objects to search for. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 217 AWS End User Messaging SMS API Reference Type: Array of SenderIdAndCountry objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Response Syntax { "NextToken": "string", "SenderIds": [ { "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageTypes": [ "string" ], "MonthlyLeasingPrice": "string", "Registered": boolean, "RegistrationId": "string", "SenderId": "string", "SenderIdArn": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Response Syntax API Version 2022-03-31 218 AWS End User Messaging SMS SenderIds API Reference An array of SernderIdInformation objects that contain the details for the requested SenderIds. Type: Array of SenderIdInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API |
amazonpinpointsmsvoicev2-api-047 | amazonpinpointsmsvoicev2-api.pdf | 47 | AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2022-03-31 219 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 220 AWS End User Messaging SMS API Reference DescribeSpendLimits Describes the current monthly spend limits for sending voice and text messages. When you establish an AWS account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ DescribeSpendLimits API Version 2022-03-31 221 API Reference AWS End User Messaging SMS Required: No Response Syntax { "NextToken": "string", "SpendLimits": [ { "EnforcedLimit": number, "MaxLimit": number, "Name": "string", "Overridden": boolean } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ SpendLimits An array of SpendLimit objects that contain the details for the requested spend limits. Type: Array of SpendLimit objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2022-03-31 222 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 223 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 224 AWS End User Messaging SMS API Reference DescribeVerifiedDestinationNumbers Retrieves the specified verified destination numbers. Request Syntax { "DestinationPhoneNumbers": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "VerifiedDestinationNumberIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DestinationPhoneNumbers An array of verified destination phone number, in E.164 format. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No Filters An array of VerifiedDestinationNumberFilter objects to filter the results. DescribeVerifiedDestinationNumbers API Version 2022-03-31 225 AWS End User Messaging SMS API Reference Type: Array of VerifiedDestinationNumberFilter |
amazonpinpointsmsvoicev2-api-048 | amazonpinpointsmsvoicev2-api.pdf | 48 | number, "NextToken": "string", "VerifiedDestinationNumberIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DestinationPhoneNumbers An array of verified destination phone number, in E.164 format. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No Filters An array of VerifiedDestinationNumberFilter objects to filter the results. DescribeVerifiedDestinationNumbers API Version 2022-03-31 225 AWS End User Messaging SMS API Reference Type: Array of VerifiedDestinationNumberFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No VerifiedDestinationNumberIds An array of VerifiedDestinationNumberid to retrieve. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Response Syntax { Response Syntax API Version 2022-03-31 226 AWS End User Messaging SMS API Reference "NextToken": "string", "VerifiedDestinationNumbers": [ { "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "Status": "string", "VerifiedDestinationNumberArn": "string", "VerifiedDestinationNumberId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ VerifiedDestinationNumbers An array of VerifiedDestinationNumberInformation objects Type: Array of VerifiedDestinationNumberInformation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. Response Elements API Version 2022-03-31 227 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 228 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 229 AWS End User Messaging SMS API Reference DisassociateOriginationIdentity Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned. Request Syntax { "ClientToken": "string", "IsoCountryCode": "string", "OriginationIdentity": "string", "PoolId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. DisassociateOriginationIdentity API Version 2022-03-31 230 AWS End User Messaging SMS Pattern: [A-Z]{2} Required: Yes OriginationIdentity API Reference The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes PoolId The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn. Important If you are |
amazonpinpointsmsvoicev2-api-049 | amazonpinpointsmsvoicev2-api.pdf | 49 | origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes PoolId The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Request Parameters API Version 2022-03-31 231 API Reference AWS End User Messaging SMS Response Syntax { "IsoCountryCode": "string", "OriginationIdentity": "string", "OriginationIdentityArn": "string", "PoolArn": "string", "PoolId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} OriginationIdentity The PhoneNumberId or SenderId of the origination identity. Type: String OriginationIdentityArn The PhoneNumberArn or SenderIdArn of the origination identity. Type: String PoolArn The Amazon Resource Name (ARN) of the pool. Type: String Response Syntax API Version 2022-03-31 232 AWS End User Messaging SMS PoolId API Reference The PoolId of the pool no longer associated with the origination identity. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. Errors API Version 2022-03-31 233 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 234 AWS End User Messaging SMS API Reference DisassociateProtectConfiguration Disassociate a protect configuration from a configuration set. Request Syntax { "ConfigurationSetName": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the ConfigurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes DisassociateProtectConfiguration API Version 2022-03-31 235 API Reference AWS End User Messaging SMS Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the configuration set. Type: String ConfigurationSetName The name of the ConfigurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Response Syntax API Version 2022-03-31 236 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur |
amazonpinpointsmsvoicev2-api-050 | amazonpinpointsmsvoicev2-api.pdf | 50 | Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Response Syntax API Version 2022-03-31 236 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. Errors API Version 2022-03-31 237 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 238 AWS End User Messaging SMS API Reference DiscardRegistrationVersion Discard the current version of the registration. Request Syntax { "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "RegistrationArn": "string", "RegistrationId": "string", "RegistrationVersionStatus": "string", "RegistrationVersionStatusHistory": { "ApprovedTimestamp": number, "ArchivedTimestamp": number, "DeniedTimestamp": number, "DiscardedTimestamp": number, "DraftTimestamp": number, DiscardRegistrationVersion API Version 2022-03-31 239 AWS End User Messaging SMS API Reference "RequiresAuthenticationTimestamp": number, "ReviewingTimestamp": number, "RevokedTimestamp": number, "SubmittedTimestamp": number }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationVersionStatus The status of the registration version. • APPROVED: Your registration has been approved. • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved. • DENIED: You must fix your registration and resubmit it. • DISCARDED: You've abandon this version of their registration to start over with a new version. • DRAFT: The initial status of a registration version after it’s created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REVIEWING: Your registration has been accepted and is being reviewed. • REVOKED: Your previously approved registration has been revoked. • SUBMITTED: Your registration has been submitted. Response Elements API Version 2022-03-31 240 AWS End User Messaging SMS Type: String API Reference Valid Values: DRAFT | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | APPROVED | DISCARDED | DENIED | REVOKED | ARCHIVED RegistrationVersionStatusHistory The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. Type: RegistrationVersionStatusHistory object VersionNumber The version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 241 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception |
amazonpinpointsmsvoicev2-api-051 | amazonpinpointsmsvoicev2-api.pdf | 51 | or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 241 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 242 AWS End User Messaging SMS API Reference GetProtectConfigurationCountryRuleSet Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration. Request Syntax { "NumberCapability": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. NumberCapability The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS. Type: String Valid Values: SMS | VOICE | MMS Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { GetProtectConfigurationCountryRuleSet API Version 2022-03-31 243 AWS End User Messaging SMS API Reference "CountryRuleSet": { "string" : { "ProtectStatus": "string" } }, "NumberCapability": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CountryRuleSet A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide. Type: String to ProtectConfigurationCountryRuleSetInformation object map Map Entries: Maximum number of 300 items. Key Length Constraints: Fixed length of 2. Key Pattern: [A-Z]{2} NumberCapability The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects. Type: String Valid Values: SMS | VOICE | MMS ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Response Elements API Version 2022-03-31 244 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 Errors API Version 2022-03-31 245 AWS End User Messaging SMS ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 246 AWS End User Messaging SMS GetResourcePolicy API Reference 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. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ |
amazonpinpointsmsvoicev2-api-052 | amazonpinpointsmsvoicev2-api.pdf | 52 | 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. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "CreatedTimestamp": number, "Policy": "string", "ResourceArn": "string" } GetResourcePolicy API Version 2022-03-31 247 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the resource-based policy was created, in UNIX epoch time format. Type: Timestamp Policy The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 248 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 249 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 250 AWS End User Messaging SMS API Reference ListPoolOriginationIdentities Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "PoolId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of PoolOriginationIdentitiesFilter objects to filter the results.. Type: Array of PoolOriginationIdentitiesFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer ListPoolOriginationIdentities API Version 2022-03-31 251 AWS End User Messaging SMS API Reference Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No PoolId The unique identifier for the pool. This value can be either the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "NextToken": "string", "OriginationIdentities": [ { "IsoCountryCode": "string", Response Syntax API Version 2022-03-31 252 AWS End User Messaging SMS API Reference "NumberCapabilities": [ "string" ], "OriginationIdentity": "string", "OriginationIdentityArn": "string", "PhoneNumber": "string" } ], "PoolArn": "string", "PoolId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ OriginationIdentities An array of any |
amazonpinpointsmsvoicev2-api-053 | amazonpinpointsmsvoicev2-api.pdf | 53 | "string", Response Syntax API Version 2022-03-31 252 AWS End User Messaging SMS API Reference "NumberCapabilities": [ "string" ], "OriginationIdentity": "string", "OriginationIdentityArn": "string", "PhoneNumber": "string" } ], "PoolArn": "string", "PoolId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. If this field is empty then there are no more results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ OriginationIdentities An array of any OriginationIdentityMetadata objects. Type: Array of OriginationIdentityMetadata objects PoolArn The Amazon Resource Name (ARN) for the pool. Type: String PoolId The unique PoolId of the pool. Type: String Response Elements API Version 2022-03-31 253 AWS End User Messaging SMS Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2022-03-31 254 AWS End User Messaging SMS • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 255 AWS End User Messaging SMS API Reference ListProtectConfigurationRuleSetNumberOverrides Retrieve all of the protect configuration rule set number overrides that match the filters. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of ProtectConfigurationRuleSetNumberOverrideFilterItem objects to filter the results. Type: Array of ProtectConfigurationRuleSetNumberOverrideFilterItem objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. ListProtectConfigurationRuleSetNumberOverrides API Version 2022-03-31 256 AWS End User Messaging SMS Required: No NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "NextToken": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string", "RuleSetNumberOverrides": [ { "Action": "string", "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "ExpirationTimestamp": number, "IsoCountryCode": "string" } ] } Response Syntax API Version 2022-03-31 257 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ RuleSetNumberOverrides An array of RuleSetNumberOverrides objects. Type: Array of ProtectConfigurationRuleSetNumberOverride objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Response Elements API Version 2022-03-31 258 AWS End User Messaging SMS Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 |
amazonpinpointsmsvoicev2-api-054 | amazonpinpointsmsvoicev2-api.pdf | 54 | objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Response Elements API Version 2022-03-31 258 AWS End User Messaging SMS Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2022-03-31 259 AWS End User Messaging SMS • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 260 AWS End User Messaging SMS API Reference ListRegistrationAssociations Retrieve all of the origination identities that are associated with a registration. Request Syntax { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters An array of RegistrationAssociationFilter to apply to the results that are returned. Type: Array of RegistrationAssociationFilter objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No MaxResults The maximum number of results to return per each request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ListRegistrationAssociations API Version 2022-03-31 261 AWS End User Messaging SMS NextToken API Reference The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "NextToken": "string", "RegistrationArn": "string", "RegistrationAssociations": [ { "IsoCountryCode": "string", "PhoneNumber": "string", "ResourceArn": "string", "ResourceId": "string", "ResourceType": "string" } ], "RegistrationId": "string", "RegistrationType": "string" } Response Syntax API Version 2022-03-31 262 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationAssociations An array of RegistrationAssociationMetadata objects. Type: Array of RegistrationAssociationMetadata objects RegistrationId The unique identifier for the registration. Type: String RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Response Elements API Version 2022-03-31 263 AWS End User Messaging SMS Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2022-03-31 264 AWS End User Messaging SMS • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See |
amazonpinpointsmsvoicev2-api-055 | amazonpinpointsmsvoicev2-api.pdf | 55 | Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2022-03-31 264 AWS End User Messaging SMS • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 265 AWS End User Messaging SMS API Reference ListTagsForResource List all tags associated with a resource. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource to query for. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ListTagsForResource API Version 2022-03-31 266 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ResourceArn The ARN of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Tags An array of key and value pair tags that are associated with the resource. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Response Elements API Version 2022-03-31 267 AWS End User Messaging SMS HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 268 AWS End User Messaging SMS PutKeyword API Reference Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. If you specify a keyword that isn't valid, an error is returned. Request Syntax { "Keyword": "string", "KeywordAction": "string", "KeywordMessage": "string", "OriginationIdentity": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Keyword The new keyword to add. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ Required: Yes KeywordAction The action to perform for the new keyword when it is received. PutKeyword API Version 2022-03-31 269 AWS End User Messaging SMS API Reference • AUTOMATIC_RESPONSE: A message is sent to the recipient. • OPT_OUT: Keeps the recipient from receiving future messages. • OPT_IN: The recipient wants to receive future messages. Type: String Valid Values: AUTOMATIC_RESPONSE | OPT_OUT | OPT_IN Required: No KeywordMessage The message associated with the keyword. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Required: Yes OriginationIdentity The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length |
amazonpinpointsmsvoicev2-api-056 | amazonpinpointsmsvoicev2-api.pdf | 56 | Valid Values: AUTOMATIC_RESPONSE | OPT_OUT | OPT_IN Required: No KeywordMessage The message associated with the keyword. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Required: Yes OriginationIdentity The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Request Parameters API Version 2022-03-31 270 API Reference AWS End User Messaging SMS Response Syntax { "Keyword": "string", "KeywordAction": "string", "KeywordMessage": "string", "OriginationIdentity": "string", "OriginationIdentityArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Keyword The keyword that was added. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ KeywordAction The action to perform when the keyword is used. Type: String Valid Values: AUTOMATIC_RESPONSE | OPT_OUT | OPT_IN KeywordMessage The message associated with the keyword. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Response Syntax API Version 2022-03-31 271 AWS End User Messaging SMS OriginationIdentity API Reference The PhoneNumberId or PoolId that the keyword was associated with. Type: String OriginationIdentityArn The PhoneNumberArn or PoolArn that the keyword was associated with. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. Errors API Version 2022-03-31 272 AWS End User Messaging SMS HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 273 AWS End User Messaging SMS API Reference PutMessageFeedback Set the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId. If you use message feedback then you must update message feedback record. When you receive a signal that a user has received the message you must use PutMessageFeedback to set the message feedback record as RECEIVED; Otherwise, an hour after the message feedback record is set to FAILED. Request Syntax { "MessageFeedbackStatus": "string", "MessageId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MessageFeedbackStatus Set the message feedback to be either RECEIVED or FAILED. Type: String Valid Values: RECEIVED | FAILED Required: Yes MessageId The unique identifier for the message. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_:/-]+ PutMessageFeedback API Version 2022-03-31 274 API Reference AWS End User Messaging SMS Required: Yes Response Syntax { "MessageFeedbackStatus": "string", "MessageId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageFeedbackStatus The current status of the message. Type: String Valid Values: RECEIVED | FAILED MessageId The unique identifier for the message. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_:/-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Syntax API Version 2022-03-31 275 AWS End User Messaging SMS InternalServerException API Reference The API |
amazonpinpointsmsvoicev2-api-057 | amazonpinpointsmsvoicev2-api.pdf | 57 | an HTTP 200 response. The following data is returned in JSON format by the service. MessageFeedbackStatus The current status of the message. Type: String Valid Values: RECEIVED | FAILED MessageId The unique identifier for the message. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_:/-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Syntax API Version 2022-03-31 275 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 276 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 277 AWS End User Messaging SMS API Reference PutOptedOutNumber Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned. Request Syntax { "OptedOutNumber": "string", "OptOutListName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OptedOutNumber The phone number to add to the OptOutList in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes OptOutListName The OptOutListName or OptOutListArn to add the phone number to. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). PutOptedOutNumber API Version 2022-03-31 278 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "EndUserOptedOut": boolean, "OptedOutNumber": "string", "OptedOutTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndUserOptedOut This is true if it was the end user who requested their phone number be removed. Type: Boolean OptedOutNumber The phone number that was added to the OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} OptedOutTimestamp The time that the phone number was added to the OptOutList, in UNIX epoch time format. Response Syntax API Version 2022-03-31 279 API Reference AWS End User Messaging SMS Type: Timestamp OptOutListArn The OptOutListArn that the phone number was removed from. Type: String OptOutListName The OptOutListName that the phone number was removed from. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 Errors API Version 2022-03-31 280 AWS End User Messaging SMS ValidationException A validation exception for a field. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 281 AWS End User Messaging SMS API Reference PutProtectConfigurationRuleSetNumberOverride Create or update a phone number rule override and associate it with a protect configuration. Request Syntax { "Action": |
amazonpinpointsmsvoicev2-api-058 | amazonpinpointsmsvoicev2-api.pdf | 58 | this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 281 AWS End User Messaging SMS API Reference PutProtectConfigurationRuleSetNumberOverride Create or update a phone number rule override and associate it with a protect configuration. Request Syntax { "Action": "string", "ClientToken": "string", "DestinationPhoneNumber": "string", "ExpirationTimestamp": number, "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Action The action for the rule to either block or allow messages to the destination phone number. Type: String Valid Values: ALLOW | BLOCK Required: Yes ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No PutProtectConfigurationRuleSetNumberOverride API Version 2022-03-31 282 API Reference AWS End User Messaging SMS DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes ExpirationTimestamp The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire. Type: Timestamp Required: No ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "Action": "string", "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "ExpirationTimestamp": number, "IsoCountryCode": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" Response Syntax API Version 2022-03-31 283 AWS End User Messaging SMS } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference Action The action for the rule to take. Type: String Valid Values: ALLOW | BLOCK CreatedTimestamp The time when the rule was created, in UNIX epoch time format. Type: Timestamp DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} ExpirationTimestamp The time the rule will expire at. Type: Timestamp IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Response Elements API Version 2022-03-31 284 API Reference AWS End User Messaging SMS Pattern: [A-Z]{2} ProtectConfigurationArn The Amazon Resource Name (ARN) of the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. Errors API Version 2022-03-31 285 AWS End User Messaging SMS HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 286 AWS End User Messaging SMS API Reference PutRegistrationFieldValue Creates or updates a field value for a registration. Request Syntax { "FieldPath": "string", "RegistrationAttachmentId": "string", "RegistrationId": "string", "SelectChoices": [ "string" ], "TextValue": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following |
amazonpinpointsmsvoicev2-api-059 | amazonpinpointsmsvoicev2-api.pdf | 59 | • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 286 AWS End User Messaging SMS API Reference PutRegistrationFieldValue Creates or updates a field value for a registration. Request Syntax { "FieldPath": "string", "RegistrationAttachmentId": "string", "RegistrationId": "string", "SelectChoices": [ "string" ], "TextValue": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FieldPath The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: Yes RegistrationAttachmentId The unique identifier for the registration attachment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ PutRegistrationFieldValue API Version 2022-03-31 287 AWS End User Messaging SMS Required: No RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [A-Za-z0-9_:/-]+ Required: Yes SelectChoices An array of values for the form field. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: No TextValue The text data for a free form field. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "FieldPath": "string", "RegistrationArn": "string", "RegistrationAttachmentId": "string", "RegistrationId": "string", "SelectChoices": [ "string" ], Response Syntax API Version 2022-03-31 288 AWS End User Messaging SMS "TextValue": "string", "VersionNumber": number } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FieldPath The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationAttachmentId The unique identifier for the registration attachment. Type: String RegistrationId The unique identifier for the registration. Type: String SelectChoices An array of values for the form field. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Response Elements API Version 2022-03-31 289 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 256. TextValue The text data for a free form field. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. VersionNumber The version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Errors API Version 2022-03-31 290 AWS End User Messaging SMS HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 291 AWS End User Messaging SMS PutResourcePolicy API Reference 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. Request Syntax { "Policy": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common |
amazonpinpointsmsvoicev2-api-060 | amazonpinpointsmsvoicev2-api.pdf | 60 | AWS SDK for Ruby V3 See Also API Version 2022-03-31 291 AWS End User Messaging SMS PutResourcePolicy API Reference 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. Request Syntax { "Policy": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Policy The JSON formatted resource-based policy to attach. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. Required: Yes ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes PutResourcePolicy API Version 2022-03-31 292 API Reference AWS End User Messaging SMS Response Syntax { "CreatedTimestamp": number, "Policy": "string", "ResourceArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the resource-based policy was created, in UNIX epoch time format. Type: Timestamp Policy The JSON formatted Resource Policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ResourceArn The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2022-03-31 293 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-03-31 294 AWS End User Messaging SMS • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 295 AWS End User Messaging SMS API Reference ReleasePhoneNumber Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned. Request Syntax { "PhoneNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PhoneNumberId The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ReleasePhoneNumber API Version 2022-03-31 296 API Reference AWS End User Messaging SMS Response Syntax { "CreatedTimestamp": number, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PhoneNumber": "string", "PhoneNumberArn": "string", "PhoneNumberId": "string", "RegistrationId": "string", "SelfManagedOptOutsEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the phone number was created, in UNIX epoch time format. Type: Timestamp IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Response Syntax API Version 2022-03-31 297 AWS End User Messaging SMS MessageType API Reference The message type that was associated with the phone number. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL MonthlyLeasingPrice The monthly price of the phone |
amazonpinpointsmsvoicev2-api-061 | amazonpinpointsmsvoicev2-api.pdf | 61 | action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the phone number was created, in UNIX epoch time format. Type: Timestamp IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Response Syntax API Version 2022-03-31 297 AWS End User Messaging SMS MessageType API Reference The message type that was associated with the phone number. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL MonthlyLeasingPrice The monthly price of the phone number, in US dollars. Type: String NumberCapabilities Specifies if the number could be used for text messages, voice, or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS | VOICE | MMS NumberType The type of number that was released. Type: String Valid Values: SHORT_CODE | LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR OptOutListName The name of the OptOutList that was associated with the phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ PhoneNumber The phone number that was released. Type: String Response Elements API Version 2022-03-31 298 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} PhoneNumberArn The PhoneNumberArn of the phone number that was released. Type: String PhoneNumberId The PhoneNumberId of the phone number that was released. Type: String RegistrationId The unique identifier for the registration. Type: String SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean Status The current status of the request. Type: String Valid Values: PENDING | ACTIVE | ASSOCIATING | DISASSOCIATING | DELETED TwoWayChannelArn The Amazon Resource Name (ARN) of the TwoWayChannel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Response Elements API Version 2022-03-31 299 AWS End User Messaging SMS Pattern: \S+ TwoWayChannelRole API Reference An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 300 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 301 API Reference AWS End User Messaging SMS ReleaseSenderId Releases an existing sender ID in your account. Request Syntax { "IsoCountryCode": "string", "SenderId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes SenderId The sender ID to release. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ReleaseSenderId API Version 2022-03-31 302 API Reference AWS End User Messaging SMS Response |
amazonpinpointsmsvoicev2-api-062 | amazonpinpointsmsvoicev2-api.pdf | 62 | existing sender ID in your account. Request Syntax { "IsoCountryCode": "string", "SenderId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes SenderId The sender ID to release. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes ReleaseSenderId API Version 2022-03-31 302 API Reference AWS End User Messaging SMS Response Syntax { "IsoCountryCode": "string", "MessageTypes": [ "string" ], "MonthlyLeasingPrice": "string", "Registered": boolean, "RegistrationId": "string", "SenderId": "string", "SenderIdArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL | PROMOTIONAL MonthlyLeasingPrice The monthly price, in US dollars, to lease the sender ID. Type: String Response Syntax API Version 2022-03-31 303 API Reference AWS End User Messaging SMS Registered True if the sender ID is registered. Type: Boolean RegistrationId The unique identifier for the registration. Type: String SenderId The sender ID that was released. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ SenderIdArn The Amazon Resource Name (ARN) associated with the SenderId. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 Errors API Version 2022-03-31 304 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 305 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 306 AWS End User Messaging SMS API Reference RequestPhoneNumber Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide. Request Syntax { "ClientToken": "string", "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PoolId": "string", "RegistrationId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ RequestPhoneNumber API Version 2022-03-31 307 AWS End User Messaging SMS Required: No DeletionProtectionEnabled API Reference By default this is set to false. When set to true the phone number can't be deleted. Type: Boolean Required: No IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Required: Yes NumberCapabilities Indicates if the |
amazonpinpointsmsvoicev2-api-063 | amazonpinpointsmsvoicev2-api.pdf | 63 | API Version 2022-03-31 307 AWS End User Messaging SMS Required: No DeletionProtectionEnabled API Reference By default this is set to false. When set to true the phone number can't be deleted. Type: Boolean Required: No IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Required: Yes NumberCapabilities Indicates if the phone number will be used for text messages, voice messages, or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS | VOICE | MMS Required: Yes NumberType The type of phone number to request. Request Parameters API Version 2022-03-31 308 AWS End User Messaging SMS API Reference When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL. Type: String Valid Values: LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR Required: Yes OptOutListName The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No PoolId The pool to associated with the phone number. You can use the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Request Parameters API Version 2022-03-31 309 AWS End User Messaging SMS Required: No RegistrationId API Reference Use this field to attach your phone number for an external registration process. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Tags An array of tags (key and value pairs) associate with the requested phone number. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PhoneNumber": "string", "PhoneNumberArn": "string", "PhoneNumberId": "string", "PoolId": "string", "RegistrationId": "string", "SelfManagedOptOutsEnabled": boolean, "Status": "string", "Tags": [ { Response Syntax API Version 2022-03-31 310 AWS End User Messaging SMS API Reference "Key": "string", "Value": "string" } ], "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the phone number was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled By default this is set to false. When set to true the phone number can't be deleted. Type: Boolean IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Response Elements API Version 2022-03-31 311 AWS End User Messaging SMS MonthlyLeasingPrice API Reference The monthly price, in US dollars, to lease the phone number. Type: String NumberCapabilities Indicates if the phone number will be used for text messages, voice messages or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS | VOICE | MMS NumberType The type of number that was released. Type: String Valid Values: LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR OptOutListName The name of the OptOutList that is associated with the requested phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ PhoneNumber The new phone number that was requested. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} PhoneNumberArn The Amazon Resource Name (ARN) of the requested phone number. Response Elements API Version 2022-03-31 312 API Reference AWS End User Messaging SMS Type: String PhoneNumberId The unique identifier of the new phone number. Type: String PoolId The unique identifier of the pool associated with the phone number Type: String RegistrationId The unique identifier for the registration. Type: String SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to |
amazonpinpointsmsvoicev2-api-064 | amazonpinpointsmsvoicev2-api.pdf | 64 | of the requested phone number. Response Elements API Version 2022-03-31 312 API Reference AWS End User Messaging SMS Type: String PhoneNumberId The unique identifier of the new phone number. Type: String PoolId The unique identifier of the pool associated with the phone number Type: String RegistrationId The unique identifier for the registration. Type: String SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean Status The current status of the request. Type: String Valid Values: PENDING | ACTIVE | ASSOCIATING | DISASSOCIATING | DELETED Tags An array of key and value pair tags that are associated with the phone number. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Response Elements API Version 2022-03-31 313 AWS End User Messaging SMS TwoWayChannelArn The ARN used to identify the two way channel. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 Errors API Version 2022-03-31 314 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-03-31 315 AWS End User Messaging SMS • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 316 API Reference AWS End User Messaging SMS RequestSenderId Request a new sender ID that doesn't require registration. Request Syntax { "ClientToken": "string", "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageTypes": [ "string" ], "SenderId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [!-~]+ Required: No DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. RequestSenderId API Version 2022-03-31 317 AWS End User Messaging SMS Type: Boolean Required: No IsoCountryCode API Reference The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL | PROMOTIONAL Required: No SenderId The sender ID string to request. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Required: Yes Tags An array of |
amazonpinpointsmsvoicev2-api-065 | amazonpinpointsmsvoicev2-api.pdf | 65 | two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL | PROMOTIONAL Required: No SenderId The sender ID string to request. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Required: Yes Tags An array of tags (key and value pairs) to associate with the sender ID. Request Parameters API Version 2022-03-31 318 AWS End User Messaging SMS Type: Array of Tag objects API Reference Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax { "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageTypes": [ "string" ], "MonthlyLeasingPrice": "string", "Registered": boolean, "SenderId": "string", "SenderIdArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. Type: Boolean IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Response Syntax API Version 2022-03-31 319 AWS End User Messaging SMS Pattern: [A-Z]{2} MessageTypes API Reference The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL | PROMOTIONAL MonthlyLeasingPrice The monthly price, in US dollars, to lease the sender ID. Type: String Registered True if the sender ID is registered. Type: Boolean SenderId The sender ID that was requested. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ SenderIdArn The Amazon Resource Name (ARN) associated with the SenderId. Type: String Tags An array of tags (key and value pairs) to associate with the sender ID. Type: Array of Tag objects Response Elements API Version 2022-03-31 320 AWS End User Messaging SMS API Reference Array Members: Minimum number of 0 items. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 Errors API Version 2022-03-31 321 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 322 AWS End User Messaging SMS API Reference SendDestinationNumberVerificationCode Before you can send test messages to a verified destination phone number you need to opt- in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationCountryParameters": { "string" : "string" }, "LanguageCode": "string", "OriginationIdentity": "string", "VerificationChannel": "string", "VerifiedDestinationNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of |
amazonpinpointsmsvoicev2-api-066 | amazonpinpointsmsvoicev2-api.pdf | 66 | destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationCountryParameters": { "string" : "string" }, "LanguageCode": "string", "OriginationIdentity": "string", "VerificationChannel": "string", "VerifiedDestinationNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No SendDestinationNumberVerificationCode API Version 2022-03-31 323 AWS End User Messaging SMS Context API Reference You can specify custom data in this field. If you do, that data is logged to the event destination. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 100. Key Pattern: \S+ Value Length Constraints: Minimum length of 1. Maximum length of 800. Value Pattern: (?!\s)^[\s\S]+(?<!\s) Required: No DestinationCountryParameters This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Valid Keys: IN_TEMPLATE_ID | IN_ENTITY_ID Value Length Constraints: Minimum length of 1. Maximum length of 64. Value Pattern: \S+ Required: No LanguageCode Choose the language to use for the message. Type: String Valid Values: DE_DE | EN_GB | EN_US | ES_419 | ES_ES | FR_CA | FR_FR | IT_IT | JA_JP | KO_KR | PT_BR | ZH_CN | ZH_TW Required: No Request Parameters API Version 2022-03-31 324 AWS End User Messaging SMS OriginationIdentity API Reference The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/\+-]+ Required: No VerificationChannel Choose to send the verification code as an SMS or voice message. Type: String Valid Values: TEXT | VOICE Required: Yes VerifiedDestinationNumberId The unique identifier for the verified destination phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { Response Syntax API Version 2022-03-31 325 API Reference AWS End User Messaging SMS "MessageId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageId The unique identifier for the message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. Response Elements API Version 2022-03-31 326 AWS End User Messaging SMS HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 327 AWS End User Messaging SMS SendMediaMessage API Reference Creates a new multimedia message (MMS) and sends it to a recipient's phone number. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationPhoneNumber": "string", "DryRun": boolean, "MaxPrice": "string", "MediaUrls": [ "string" ], "MessageBody": "string", "MessageFeedbackEnabled": boolean, "OriginationIdentity": "string", "ProtectConfigurationId": "string", "TimeToLive": number } Request Parameters For information |
amazonpinpointsmsvoicev2-api-067 | amazonpinpointsmsvoicev2-api.pdf | 67 | Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 327 AWS End User Messaging SMS SendMediaMessage API Reference Creates a new multimedia message (MMS) and sends it to a recipient's phone number. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationPhoneNumber": "string", "DryRun": boolean, "MaxPrice": "string", "MediaUrls": [ "string" ], "MessageBody": "string", "MessageFeedbackEnabled": boolean, "OriginationIdentity": "string", "ProtectConfigurationId": "string", "TimeToLive": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Context You can specify custom data in this field. If you do, that data is logged to the event destination. SendMediaMessage API Version 2022-03-31 328 AWS End User Messaging SMS Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 100. Key Pattern: \S+ Value Length Constraints: Minimum length of 1. Maximum length of 800. Value Pattern: (?!\s)^[\s\S]+(?<!\s) Required: No DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes DryRun When set to true, the message is checked and validated, but isn't sent to the end recipient. Type: Boolean Required: No MaxPrice The maximum amount that you want to spend, in US dollars, per each MMS message. Type: String Length Constraints: Minimum length of 2. Maximum length of 8. Pattern: [0-9]{0,2}\.[0-9]{1,5} Required: No Request Parameters API Version 2022-03-31 329 AWS End User Messaging SMS MediaUrls An array of URLs to each media file to send. API Reference The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the AWS End User Messaging SMS User Guide. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: s3://([a-z0-9\.-]{3,63})/(.+) Required: No MessageBody The text body of the message. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Required: No MessageFeedbackEnabled Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback. Type: Boolean Required: No OriginationIdentity The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn. Request Parameters API Version 2022-03-31 330 AWS End User Messaging SMS API Reference Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/\+-]+ Required: Yes ProtectConfigurationId The unique identifier of the protect configuration to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No TimeToLive How long the media message is valid for. By default this is 72 hours. Type: Integer Valid Range: Minimum value of 5. Maximum value of 259200. Required: No Response Syntax { "MessageId": "string" } Response Syntax API Version 2022-03-31 331 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageId The unique identifier for the message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Response Elements API Version 2022-03-31 332 AWS End User Messaging SMS API Reference ServiceQuotaExceededException The |
amazonpinpointsmsvoicev2-api-068 | amazonpinpointsmsvoicev2-api.pdf | 68 | conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Response Elements API Version 2022-03-31 332 AWS End User Messaging SMS API Reference ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 333 AWS End User Messaging SMS SendTextMessage API Reference Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationCountryParameters": { "string" : "string" }, "DestinationPhoneNumber": "string", "DryRun": boolean, "Keyword": "string", "MaxPrice": "string", "MessageBody": "string", "MessageFeedbackEnabled": boolean, "MessageType": "string", "OriginationIdentity": "string", "ProtectConfigurationId": "string", "TimeToLive": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. SendTextMessage API Version 2022-03-31 334 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No Context You can specify custom data in this field. If you do, that data is logged to the event destination. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 100. Key Pattern: \S+ Value Length Constraints: Minimum length of 1. Maximum length of 800. Value Pattern: (?!\s)^[\s\S]+(?<!\s) Required: No DestinationCountryParameters This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India. • IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process. • IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process. Important Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message. Request Parameters API Version 2022-03-31 335 AWS End User Messaging SMS Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 10 items. Valid Keys: IN_TEMPLATE_ID | IN_ENTITY_ID Value Length Constraints: Minimum length of 1. Maximum length of 64. Value Pattern: \S+ Required: No DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes DryRun When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun. The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.. Type: Boolean Required: No Keyword When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of |
amazonpinpointsmsvoicev2-api-069 | amazonpinpointsmsvoicev2-api.pdf | 69 | recipient. You are not charged for using DryRun. The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.. Type: Boolean Required: No Keyword When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Request Parameters API Version 2022-03-31 336 AWS End User Messaging SMS Pattern: [ \S]+ Required: No MaxPrice API Reference The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned. Type: String Length Constraints: Minimum length of 2. Maximum length of 8. Pattern: [0-9]{0,2}\.[0-9]{1,5} Required: No MessageBody The body of the text message. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Required: No MessageFeedbackEnabled Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback. Type: Boolean Required: No MessageType The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Request Parameters API Version 2022-03-31 337 AWS End User Messaging SMS API Reference Valid Values: TRANSACTIONAL | PROMOTIONAL Required: No OriginationIdentity The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/\+-]+ Required: No ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No TimeToLive How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event. Type: Integer Valid Range: Minimum value of 5. Maximum value of 259200. Request Parameters API Version 2022-03-31 338 API Reference AWS End User Messaging SMS Required: No Response Syntax { "MessageId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageId The unique identifier for the message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. Response Syntax API Version 2022-03-31 339 API Reference AWS End User Messaging SMS HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 340 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 341 AWS End User Messaging SMS SendVoiceMessage API Reference Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationPhoneNumber": "string", "DryRun": boolean, "MaxPricePerMinute": "string", "MessageBody": "string", "MessageBodyTextType": "string", "MessageFeedbackEnabled": boolean, "OriginationIdentity": "string", "ProtectConfigurationId": "string", |
amazonpinpointsmsvoicev2-api-070 | amazonpinpointsmsvoicev2-api.pdf | 70 | AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 340 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 341 AWS End User Messaging SMS SendVoiceMessage API Reference Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message. Request Syntax { "ConfigurationSetName": "string", "Context": { "string" : "string" }, "DestinationPhoneNumber": "string", "DryRun": boolean, "MaxPricePerMinute": "string", "MessageBody": "string", "MessageBodyTextType": "string", "MessageFeedbackEnabled": boolean, "OriginationIdentity": "string", "ProtectConfigurationId": "string", "TimeToLive": number, "VoiceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No SendVoiceMessage API Version 2022-03-31 342 AWS End User Messaging SMS Context API Reference You can specify custom data in this field. If you do, that data is logged to the event destination. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 100. Key Pattern: \S+ Value Length Constraints: Minimum length of 1. Maximum length of 800. Value Pattern: (?!\s)^[\s\S]+(?<!\s) Required: No DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes DryRun When set to true, the message is checked and validated, but isn't sent to the end recipient. Type: Boolean Required: No MaxPricePerMinute The maximum amount to spend per voice message, in US dollars. Type: String Length Constraints: Minimum length of 2. Maximum length of 8. Pattern: [0-9]{0,2}\.[0-9]{1,5} Request Parameters API Version 2022-03-31 343 AWS End User Messaging SMS Required: No MessageBody The text to convert to a voice message. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 6000. Pattern: (?!\s*$)[\s\S]+ Required: No MessageBodyTextType Specifies if the MessageBody field contains text or speech synthesis markup language (SSML). • TEXT: This is the default value. When used the maximum character limit is 3000. • SSML: When used the maximum character limit is 6000 including SSML tagging. Type: String Valid Values: TEXT | SSML Required: No MessageFeedbackEnabled Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback. Type: Boolean Required: No OriginationIdentity The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Request Parameters API Version 2022-03-31 344 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/\+-]+ Required: Yes ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No TimeToLive How long the voice message is valid for. By default this is 72 hours. Type: Integer Valid Range: Minimum value of 5. Maximum value of 259200. Required: No VoiceId The voice for the Amazon Polly service to use. By default this is set to "MATTHEW". Type: String Valid Values: AMY | ASTRID | BIANCA | BRIAN | CAMILA | CARLA | CARMEN | CELINE | CHANTAL | CONCHITA | CRISTIANO | DORA | EMMA | ENRIQUE | EWA | FILIZ | GERAINT | GIORGIO | GWYNETH | HANS | INES | IVY | JACEK | JAN | JOANNA | JOEY | JUSTIN | KARL | KENDRA | KIMBERLY | LEA | LIV | LOTTE | LUCIA | LUPE | MADS | MAJA | MARLENE | MATHIEU | MATTHEW | MAXIM | MIA | MIGUEL | MIZUKI | NAJA | NICOLE | PENELOPE | RAVEENA | RICARDO | RUBEN | RUSSELL | SALLI | SEOYEON | TAKUMI | TATYANA | VICKI | VITORIA | ZEINA | ZHIYU Request Parameters API Version 2022-03-31 345 API Reference AWS End User Messaging SMS Required: No Response Syntax { "MessageId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageId The unique identifier for the message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're |
amazonpinpointsmsvoicev2-api-071 | amazonpinpointsmsvoicev2-api.pdf | 71 | Parameters API Version 2022-03-31 345 API Reference AWS End User Messaging SMS Required: No Response Syntax { "MessageId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MessageId The unique identifier for the message. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. Response Syntax API Version 2022-03-31 346 API Reference AWS End User Messaging SMS HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 347 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 348 AWS End User Messaging SMS API Reference SetAccountDefaultProtectConfiguration Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration. Request Syntax { "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ProtectConfigurationId The unique identifier for the protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "DefaultProtectConfigurationArn": "string", "DefaultProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. SetAccountDefaultProtectConfiguration API Version 2022-03-31 349 AWS End User Messaging SMS API Reference The following data is returned in JSON format by the service. DefaultProtectConfigurationArn The Amazon Resource Name (ARN) of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ DefaultProtectConfigurationId The unique identifier of the account default protect configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 Errors API Version 2022-03-31 350 AWS End User Messaging SMS ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 351 AWS End User Messaging SMS API Reference SetDefaultMessageFeedbackEnabled Sets a configuration set's default for message feedback. Request Syntax { "ConfigurationSetName": "string", "MessageFeedbackEnabled": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: |
amazonpinpointsmsvoicev2-api-072 | amazonpinpointsmsvoicev2-api.pdf | 72 | SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 351 AWS End User Messaging SMS API Reference SetDefaultMessageFeedbackEnabled Sets a configuration set's default for message feedback. Request Syntax { "ConfigurationSetName": "string", "MessageFeedbackEnabled": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes MessageFeedbackEnabled Set to true to enable message feedback. Type: Boolean Required: Yes Response Syntax { SetDefaultMessageFeedbackEnabled API Version 2022-03-31 352 AWS End User Messaging SMS API Reference "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "MessageFeedbackEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The arn of the configuration set. Type: String ConfigurationSetName The name of the configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ MessageFeedbackEnabled True if message feedback is enabled. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 Response Elements API Version 2022-03-31 353 AWS End User Messaging SMS InternalServerException API Reference 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 354 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 355 AWS End User Messaging SMS API Reference SetDefaultMessageType Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire AWS account. Request Syntax { "ConfigurationSetName": "string", "MessageType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL SetDefaultMessageType API Version 2022-03-31 356 API Reference AWS End User Messaging SMS Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "MessageType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the updated configuration set. Type: String ConfigurationSetName The name of the configuration set that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ MessageType The new default message type of the configuration set. Type: String Valid Values: TRANSACTIONAL | PROMOTIONAL Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2022-03-31 357 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception |
amazonpinpointsmsvoicev2-api-073 | amazonpinpointsmsvoicev2-api.pdf | 73 | see Common Errors. Response Syntax API Version 2022-03-31 357 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-03-31 358 AWS End User Messaging SMS • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 359 AWS End User Messaging SMS SetDefaultSenderId Sets default sender ID on a configuration set. API Reference When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account. Request Syntax { "ConfigurationSetName": "string", "SenderId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ConfigurationSetName The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes SenderId The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'. Type: String SetDefaultSenderId API Version 2022-03-31 360 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Required: Yes Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "SenderId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConfigurationSetArn The Amazon Resource Name (ARN) of the updated configuration set. Type: String ConfigurationSetName The name of the configuration set that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ SenderId The default sender ID to set for the ConfigurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Response Syntax API Version 2022-03-31 361 AWS End User Messaging SMS Pattern: [A-Za-z0-9_-]+ Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2022-03-31 362 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 363 AWS End User Messaging SMS API Reference SetMediaMessageSpendLimitOverride Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by AWS. Request Syntax { "MonthlyLimit": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MonthlyLimit The new monthly limit to enforce on text messages. Type: Long Valid |
amazonpinpointsmsvoicev2-api-074 | amazonpinpointsmsvoicev2-api.pdf | 74 | V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 363 AWS End User Messaging SMS API Reference SetMediaMessageSpendLimitOverride Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by AWS. Request Syntax { "MonthlyLimit": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MonthlyLimit The new monthly limit to enforce on text messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Required: Yes Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SetMediaMessageSpendLimitOverride API Version 2022-03-31 364 AWS End User Messaging SMS MonthlyLimit API Reference The current monthly limit to enforce on sending text messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2022-03-31 365 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 366 AWS End User Messaging SMS API Reference SetTextMessageSpendLimitOverride Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by AWS. Request Syntax { "MonthlyLimit": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MonthlyLimit The new monthly limit to enforce on text messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Required: Yes Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SetTextMessageSpendLimitOverride API Version 2022-03-31 367 AWS End User Messaging SMS MonthlyLimit API Reference The current monthly limit to enforce on sending text messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2022-03-31 368 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 369 AWS End User Messaging SMS API Reference SetVoiceMessageSpendLimitOverride Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by AWS. Request Syntax { "MonthlyLimit": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MonthlyLimit The new monthly limit to enforce on voice messages. Type: Long Valid Range: Minimum value of 0. Maximum |
amazonpinpointsmsvoicev2-api-075 | amazonpinpointsmsvoicev2-api.pdf | 75 | • AWS SDK for Ruby V3 See Also API Version 2022-03-31 369 AWS End User Messaging SMS API Reference SetVoiceMessageSpendLimitOverride Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by AWS. Request Syntax { "MonthlyLimit": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MonthlyLimit The new monthly limit to enforce on voice messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Required: Yes Response Syntax { "MonthlyLimit": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. SetVoiceMessageSpendLimitOverride API Version 2022-03-31 370 AWS End User Messaging SMS MonthlyLimit API Reference The current monthly limit to enforce on sending voice messages. Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2022-03-31 371 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 372 AWS End User Messaging SMS API Reference SubmitRegistrationVersion Submit the specified registration for review and approval. Request Syntax { "RegistrationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. RegistrationId The unique identifier for the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "RegistrationArn": "string", "RegistrationId": "string", "RegistrationVersionStatus": "string", "RegistrationVersionStatusHistory": { "ApprovedTimestamp": number, "ArchivedTimestamp": number, "DeniedTimestamp": number, "DiscardedTimestamp": number, "DraftTimestamp": number, SubmitRegistrationVersion API Version 2022-03-31 373 AWS End User Messaging SMS API Reference "RequiresAuthenticationTimestamp": number, "ReviewingTimestamp": number, "RevokedTimestamp": number, "SubmittedTimestamp": number }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String RegistrationId The unique identifier for the registration. Type: String RegistrationVersionStatus The status of the registration version. • APPROVED: Your registration has been approved. • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved. • DENIED: You must fix your registration and resubmit it. • DISCARDED: You've abandon this version of their registration to start over with a new version. • DRAFT: The initial status of a registration version after it’s created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REVIEWING: Your registration has been accepted and is being reviewed. • REVOKED: Your previously approved registration has been revoked. • SUBMITTED: Your registration has been submitted. Response Elements API Version 2022-03-31 374 AWS End User Messaging SMS Type: String API Reference Valid Values: DRAFT | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | APPROVED | DISCARDED | DENIED | REVOKED | ARCHIVED RegistrationVersionStatusHistory The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. Type: RegistrationVersionStatusHistory object VersionNumber The version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request |
amazonpinpointsmsvoicev2-api-076 | amazonpinpointsmsvoicev2-api.pdf | 76 | the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 Errors API Version 2022-03-31 375 AWS End User Messaging SMS ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException API Reference An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 376 AWS End User Messaging SMS TagResource API Reference Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide. Request Syntax { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes Tags An array of key and value pair tags that are associated with the resource. Type: Array of Tag objects TagResource API Version 2022-03-31 377 AWS End User Messaging SMS API Reference Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource. HTTP Status Code: 400 InternalServerException 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. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ServiceQuotaExceededException The request would cause a service quota to be exceeded. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a field. Response Elements API Version 2022-03-31 378 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 379 AWS End User Messaging SMS UntagResource API Reference Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide. Request Syntax { "ResourceArn": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes TagKeys An array of tag key values to unassociate with the resource. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .+ Required: Yes UntagResource API Version 2022-03-31 380 AWS End User Messaging |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.