diff --git a/cran/paws.analytics/R/glue_operations.R b/cran/paws.analytics/R/glue_operations.R index 9b9e558aa6..2c6f30a492 100644 --- a/cran/paws.analytics/R/glue_operations.R +++ b/cran/paws.analytics/R/glue_operations.R @@ -752,7 +752,7 @@ glue_create_crawler <- function(Name, Role, DatabaseName = NULL, Description = N #' @param ContextWords A list of context words. If none of these context words are found within #' the vicinity of the regular expression the data will not be detected as #' sensitive data. -#' +#' #' If no context words are passed only a regular expression is checked. #' #' @keywords internal @@ -826,7 +826,7 @@ glue_create_database <- function(CatalogId = NULL, DatabaseInput, Tags = NULL) { #' authentication. The use of this attribute is preferred over a single #' public key because the public keys allow you to have a different private #' key per client. -#' +#' #' If you previously created an endpoint with a public key, you must remove #' that key to be able to set a list of public keys. Call the #' [`update_dev_endpoint`][glue_update_dev_endpoint] API with the public @@ -836,33 +836,33 @@ glue_create_database <- function(CatalogId = NULL, DatabaseInput, Tags = NULL) { #' `DevEndpoint`. #' @param WorkerType The type of predefined worker that is allocated to the development #' endpoint. Accepts a value of Standard, G.1X, or G.2X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPU, 16 GB #' of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPU, 32 GB #' of memory, 128 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' Known issue: when a development endpoint is created with the `G.2X` #' `WorkerType` configuration, the Spark drivers for the development #' endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. #' @param GlueVersion Glue version determines the versions of Apache Spark and Python that #' Glue supports. The Python version indicates the version supported for #' running your ETL scripts on development endpoints. -#' +#' #' For more information about the available Glue versions and corresponding #' Spark and Python versions, see [Glue #' version](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the #' developer guide. -#' +#' #' Development endpoints that are created without specifying a Glue version #' default to Glue 0.9. -#' +#' #' You can specify a version of Python support for development endpoints by #' using the `Arguments` parameter in the #' [`create_dev_endpoint`][glue_create_dev_endpoint] or @@ -870,13 +870,13 @@ glue_create_database <- function(CatalogId = NULL, DatabaseInput, Tags = NULL) { #' are provided, the version defaults to Python 2. #' @param NumberOfWorkers The number of workers of a defined `workerType` that are allocated to #' the development endpoint. -#' +#' #' The maximum number of workers you can define are 299 for `G.1X`, and 149 #' for `G.2X`. #' @param ExtraPythonLibsS3Path The paths to one or more Python libraries in an Amazon S3 bucket that #' should be loaded in your `DevEndpoint`. Multiple values must be complete #' paths separated by a comma. -#' +#' #' You can only use pure Python libraries with a `DevEndpoint`. Libraries #' that rely on C extensions, such as the #' [pandas](http://pandas.pydata.org/) Python data analysis library, are @@ -929,19 +929,19 @@ glue_create_dev_endpoint <- function(EndpointName, RoleArn, SecurityGroupIds = N #' allowed for this job. #' @param Command [required] The `JobCommand` that runs this job. #' @param DefaultArguments The default arguments for this job. -#' +#' #' You can specify arguments here that your own job-execution script #' consumes, as well as arguments that Glue itself consumes. -#' +#' #' Job arguments may be logged. Do not pass plaintext secrets as arguments. #' Retrieve secrets from a Glue Connection, Secrets Manager or other secret #' management mechanism if you intend to keep them within the Job. -#' +#' #' For information about how to specify and consume your own Job arguments, #' see the [Calling Glue APIs in #' Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) #' topic in the developer guide. -#' +#' #' For information about the key-value pairs that Glue consumes to set up #' your job, see the [Special Parameters Used by #' Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) @@ -950,7 +950,7 @@ glue_create_dev_endpoint <- function(EndpointName, RoleArn, SecurityGroupIds = N #' @param Connections The connections used for this job. #' @param MaxRetries The maximum number of times to retry this job if it fails. #' @param AllocatedCapacity This parameter is deprecated. Use `MaxCapacity` instead. -#' +#' #' The number of Glue data processing units (DPUs) to allocate to this Job. #' You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a #' relative measure of processing power that consists of 4 vCPUs of compute @@ -965,22 +965,22 @@ glue_create_dev_endpoint <- function(EndpointName, RoleArn, SecurityGroupIds = N #' consists of 4 vCPUs of compute capacity and 16 GB of memory. For more #' information, see the [Glue pricing #' page](https://aws.amazon.com/glue/pricing/). -#' +#' #' Do not set `Max Capacity` if using `WorkerType` and `NumberOfWorkers`. -#' +#' #' The value that can be allocated for `MaxCapacity` depends on whether you #' are running a Python shell job or an Apache Spark ETL job: -#' +#' #' - When you specify a Python shell job #' (`JobCommand.Name`="pythonshell"), you can allocate either 0.0625 or #' 1 DPU. The default is 0.0625 DPU. -#' +#' #' - When you specify an Apache Spark ETL job #' (`JobCommand.Name`="glueetl") or Apache Spark streaming ETL job #' (`JobCommand.Name`="gluestreaming"), you can allocate a minimum of 2 #' DPUs. The default is 10 DPUs. This job type cannot have a fractional #' DPU allocation. -#' +#' #' For Glue version 2.0 jobs, you cannot instead specify a #' `Maximum capacity`. Instead, you should specify a `Worker type` and the #' `Number of workers`. @@ -995,30 +995,30 @@ glue_create_dev_endpoint <- function(EndpointName, RoleArn, SecurityGroupIds = N #' @param GlueVersion Glue version determines the versions of Apache Spark and Python that #' Glue supports. The Python version indicates the version supported for #' jobs of type Spark. -#' +#' #' For more information about the available Glue versions and corresponding #' Spark and Python versions, see [Glue #' version](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the #' developer guide. -#' +#' #' Jobs that are created without specifying a Glue version default to Glue #' 0.9. #' @param NumberOfWorkers The number of workers of a defined `workerType` that are allocated when #' a job runs. #' @param WorkerType The type of predefined worker that is allocated when a job runs. Accepts #' a value of Standard, G.1X, G.2X, or G.025X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPU, 16 GB #' of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPU, 32 GB #' of memory, 128 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' - For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPU, #' 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for low volume streaming jobs. This @@ -1028,10 +1028,10 @@ glue_create_dev_endpoint <- function(EndpointName, RoleArn, SecurityGroupIds = N #' @param ExecutionClass Indicates whether the job is run with a standard or flexible execution #' class. The standard execution-class is ideal for time-sensitive #' workloads that require fast job startup and dedicated resources. -#' +#' #' The flexible execution class is appropriate for time-insensitive jobs #' whose start and completion times may vary. -#' +#' #' Only jobs with Glue version 3.0 and above and command type `glueetl` #' will be allowed to set `ExecutionClass` to `FLEX`. The flexible #' execution class is available for Spark jobs. @@ -1073,11 +1073,11 @@ glue_create_job <- function(Name, Description = NULL, LogUri = NULL, Role, Execu #' permissions. The required permissions include both Glue service role #' permissions to Glue resources, and Amazon S3 permissions required by the #' transform. -#' +#' #' - This role needs Glue service role permissions to allow access to #' resources in Glue. See [Attach a Policy to IAM Users That Access #' Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html). -#' +#' #' - This role needs permission to your Amazon Simple Storage Service #' (Amazon S3) sources, targets, temporary directory, scripts, and any #' libraries used by the task run for this transform. @@ -1093,54 +1093,54 @@ glue_create_job <- function(Name, Description = NULL, LogUri = NULL, Role, Execu #' consists of 4 vCPUs of compute capacity and 16 GB of memory. For more #' information, see the [Glue pricing #' page](https://aws.amazon.com/glue/pricing/). -#' +#' #' `MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and #' `WorkerType`. -#' +#' #' - If either `NumberOfWorkers` or `WorkerType` is set, then #' `MaxCapacity` cannot be set. -#' +#' #' - If `MaxCapacity` is set then neither `NumberOfWorkers` or #' `WorkerType` can be set. -#' +#' #' - If `WorkerType` is set, then `NumberOfWorkers` is required (and vice #' versa). -#' +#' #' - `MaxCapacity` and `NumberOfWorkers` must both be at least 1. -#' +#' #' When the `WorkerType` field is set to a value other than `Standard`, the #' `MaxCapacity` field is set automatically and becomes read-only. -#' +#' #' When the `WorkerType` field is set to a value other than `Standard`, the #' `MaxCapacity` field is set automatically and becomes read-only. #' @param WorkerType The type of predefined worker that is allocated when this task runs. #' Accepts a value of Standard, G.1X, or G.2X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker provides 4 vCPU, 16 GB of #' memory and a 64GB disk, and 1 executor per worker. -#' +#' #' - For the `G.2X` worker type, each worker provides 8 vCPU, 32 GB of #' memory and a 128GB disk, and 1 executor per worker. -#' +#' #' `MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and #' `WorkerType`. -#' +#' #' - If either `NumberOfWorkers` or `WorkerType` is set, then #' `MaxCapacity` cannot be set. -#' +#' #' - If `MaxCapacity` is set then neither `NumberOfWorkers` or #' `WorkerType` can be set. -#' +#' #' - If `WorkerType` is set, then `NumberOfWorkers` is required (and vice #' versa). -#' +#' #' - `MaxCapacity` and `NumberOfWorkers` must both be at least 1. #' @param NumberOfWorkers The number of workers of a defined `workerType` that are allocated when #' this task runs. -#' +#' #' If `WorkerType` is set, then `NumberOfWorkers` is required (and vice #' versa). #' @param Timeout The timeout of the task run for this transform in minutes. This is the @@ -1299,44 +1299,44 @@ glue_create_registry <- function(RegistryName, Description = NULL, Tags = NULL) #' @param DataFormat [required] The data format of the schema definition. Currently `AVRO`, `JSON` and #' `PROTOBUF` are supported. #' @param Compatibility The compatibility mode of the schema. The possible values are: -#' +#' #' - *NONE*: No compatibility mode applies. You can use this choice in #' development scenarios or if you do not know the compatibility mode #' that you want to apply to schemas. Any new version added will be #' accepted without undergoing a compatibility check. -#' +#' #' - *DISABLED*: This compatibility choice prevents versioning for a #' particular schema. You can use this choice to prevent future #' versioning of a schema. -#' +#' #' - *BACKWARD*: This compatibility choice is recommended as it allows #' data receivers to read both the current and one previous schema #' version. This means that for instance, a new schema version cannot #' drop data fields or change the type of these fields, so they can't #' be read by readers using the previous version. -#' +#' #' - *BACKWARD_ALL*: This compatibility choice allows data receivers to #' read both the current and all previous schema versions. You can use #' this choice when you need to delete fields or add optional fields, #' and check compatibility against all previous schema versions. -#' +#' #' - *FORWARD*: This compatibility choice allows data receivers to read #' both the current and one next schema version, but not necessarily #' later versions. You can use this choice when you need to add fields #' or delete optional fields, but only check compatibility against the #' last schema version. -#' +#' #' - *FORWARD_ALL*: This compatibility choice allows data receivers to #' read written by producers of any new registered schema. You can use #' this choice when you need to add fields or delete optional fields, #' and check compatibility against all previous schema versions. -#' +#' #' - *FULL*: This compatibility choice allows data receivers to read data #' written by producers using the previous or next version of the #' schema, but not necessarily earlier or later versions. You can use #' this choice when you need to add or remove optional fields, but only #' check compatibility against the last schema version. -#' +#' #' - *FULL_ALL*: This compatibility choice allows data receivers to read #' data written by producers using all previous schema versions. You #' can use this choice when you need to add or remove optional fields, @@ -1450,18 +1450,18 @@ glue_create_security_configuration <- function(Name, EncryptionConfiguration) { #' @param NumberOfWorkers The number of workers of a defined `WorkerType` to use for the session. #' @param WorkerType The type of predefined worker that is allocated to use for the session. #' Accepts a value of Standard, G.1X, G.2X, or G.025X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPU, 16 GB #' of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPU, 32 GB #' of memory, 128 GB disk), and provides 1 executor per worker. We #' recommend this worker type for memory-intensive jobs. -#' +#' #' - For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPU, #' 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for low volume streaming jobs. This @@ -1545,10 +1545,10 @@ glue_create_table <- function(CatalogId = NULL, DatabaseName, TableInput, Partit #' Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). #' For example, to run something every day at 12:15 UTC, you would specify: #' `cron(15 12 * * ? *)`. -#' +#' #' This field is required when the trigger type is SCHEDULED. #' @param Predicate A predicate to specify when the new trigger should fire. -#' +#' #' This field is required when the trigger type is `CONDITIONAL`. #' @param Actions [required] The actions initiated by this trigger when it fires. #' @param Description A description of the new trigger. @@ -2156,9 +2156,9 @@ glue_delete_schema <- function(SchemaId) { #' @param SchemaId [required] This is a wrapper structure that may contain the schema name and Amazon #' Resource Name (ARN). #' @param Versions [required] A version range may be supplied which may be of the format: -#' +#' #' - a single version number, 5 -#' +#' #' - a range, 5-8 : deletes versions 5, 6, 7, 8 #' #' @keywords internal @@ -2921,10 +2921,10 @@ glue_get_database <- function(CatalogId = NULL, Name) { #' @param MaxResults The maximum number of databases to return in one response. #' @param ResourceShareType Allows you to specify that you want to list the databases shared with #' your account. The allowable values are `FOREIGN` or `ALL`. -#' +#' #' - If set to `FOREIGN`, will list the databases shared with your #' account. -#' +#' #' - If set to `ALL`, will list the databases shared with your account, #' as well as the databases in yor local account. #' @@ -3426,90 +3426,90 @@ glue_get_partition_indexes <- function(CatalogId = NULL, DatabaseName, TableName #' @param DatabaseName [required] The name of the catalog database where the partitions reside. #' @param TableName [required] The name of the partitions' table. #' @param Expression An expression that filters the partitions to be returned. -#' +#' #' The expression uses SQL syntax similar to the SQL `WHERE` filter clause. #' The SQL statement parser #' [JSQLParser](https://jsqlparser.sourceforge.net/home.php) parses the #' expression. -#' +#' #' *Operators*: The following are the operators that you can use in the #' `Expression` API call: -#' +#' #' **=** -#' +#' #' Checks whether the values of the two operands are equal; if yes, then #' the condition becomes true. -#' +#' #' Example: Assume 'variable a' holds 10 and 'variable b' holds 20. -#' +#' #' (a = b) is not true. -#' +#' #' **\< \>** -#' +#' #' Checks whether the values of two operands are equal; if the values are #' not equal, then the condition becomes true. -#' +#' #' Example: (a \< \> b) is true. -#' +#' #' **\>** -#' +#' #' Checks whether the value of the left operand is greater than the value #' of the right operand; if yes, then the condition becomes true. -#' +#' #' Example: (a \> b) is not true. -#' +#' #' **\<** -#' +#' #' Checks whether the value of the left operand is less than the value of #' the right operand; if yes, then the condition becomes true. -#' +#' #' Example: (a \< b) is true. -#' +#' #' **\>=** -#' +#' #' Checks whether the value of the left operand is greater than or equal to #' the value of the right operand; if yes, then the condition becomes true. -#' +#' #' Example: (a \>= b) is not true. -#' +#' #' **\<=** -#' +#' #' Checks whether the value of the left operand is less than or equal to #' the value of the right operand; if yes, then the condition becomes true. -#' +#' #' Example: (a \<= b) is true. -#' +#' #' **AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL** -#' +#' #' Logical operators. -#' +#' #' *Supported Partition Key Types*: The following are the supported #' partition keys. -#' +#' #' - `string` -#' +#' #' - `date` -#' +#' #' - `timestamp` -#' +#' #' - `int` -#' +#' #' - `bigint` -#' +#' #' - `long` -#' +#' #' - `tinyint` -#' +#' #' - `smallint` -#' +#' #' - `decimal` -#' +#' #' If an type is encountered that is not valid, an exception is thrown. -#' +#' #' The following list shows the valid operators on each type. When you #' define a crawler, the `partitionKey` type is created as a `STRING`, to #' be compatible with the catalog partitions. -#' +#' #' *Sample API Call*: #' @param NextToken A continuation token, if this is not the first call to retrieve these #' partitions. @@ -3557,13 +3557,13 @@ glue_get_partitions <- function(CatalogId = NULL, DatabaseName, TableName, Expre #' @param Location The parameters for the mapping. #' @param Language The programming language of the code to perform the mapping. #' @param AdditionalPlanOptionsMap A map to hold additional optional key-value parameters. -#' +#' #' Currently, these key-value pairs are supported: -#' +#' #' - `inferSchema`  —  Specifies whether to set `inferSchema` to true or #' false for the default script generated by an Glue job. For example, #' to set `inferSchema` to true, pass the following key value pair: -#' +#' #' `--additional-plan-options-map '{"inferSchema":"true"}'` #' #' @keywords internal @@ -3690,11 +3690,11 @@ glue_get_resource_policy <- function(ResourceArn = NULL) { #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' Either `SchemaArn` or `SchemaName` and `RegistryName` has to be #' provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. Either `SchemaArn` or #' `SchemaName` and `RegistryName` has to be provided. #' @@ -3727,10 +3727,10 @@ glue_get_schema <- function(SchemaId) { #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' One of `SchemaArn` or `SchemaName` has to be provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. One of `SchemaArn` or #' `SchemaName` has to be provided. #' @param SchemaDefinition [required] The definition of the schema for which schema details are required. @@ -3765,11 +3765,11 @@ glue_get_schema_by_definition <- function(SchemaId, SchemaDefinition) { #' #' @param SchemaId This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' Either `SchemaArn` or `SchemaName` and `RegistryName` has to be #' provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. Either `SchemaArn` or #' `SchemaName` and `RegistryName` has to be provided. #' @param SchemaVersionId The `SchemaVersionId` of the schema version. This field is required for @@ -3807,10 +3807,10 @@ glue_get_schema_version <- function(SchemaId = NULL, SchemaVersionId = NULL, Sch #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' One of `SchemaArn` or `SchemaName` has to be provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. One of `SchemaArn` or #' `SchemaName` has to be provided. #' @param FirstSchemaVersionNumber [required] The first of the two schema versions to be compared. @@ -4208,12 +4208,12 @@ glue_get_triggers <- function(NextToken = NULL, DependentJobName = NULL, MaxResu #' #' See [https://paws-r.github.io/docs/glue/get_unfiltered_partition_metadata.html](https://paws-r.github.io/docs/glue/get_unfiltered_partition_metadata.html) for full documentation. #' -#' @param CatalogId [required] -#' @param DatabaseName [required] -#' @param TableName [required] -#' @param PartitionValues [required] -#' @param AuditContext -#' @param SupportedPermissionTypes [required] +#' @param CatalogId [required] +#' @param DatabaseName [required] +#' @param TableName [required] +#' @param PartitionValues [required] +#' @param AuditContext +#' @param SupportedPermissionTypes [required] #' #' @keywords internal #' @@ -4242,15 +4242,15 @@ glue_get_unfiltered_partition_metadata <- function(CatalogId, DatabaseName, Tabl #' #' See [https://paws-r.github.io/docs/glue/get_unfiltered_partitions_metadata.html](https://paws-r.github.io/docs/glue/get_unfiltered_partitions_metadata.html) for full documentation. #' -#' @param CatalogId [required] -#' @param DatabaseName [required] -#' @param TableName [required] -#' @param Expression -#' @param AuditContext -#' @param SupportedPermissionTypes [required] -#' @param NextToken -#' @param Segment -#' @param MaxResults +#' @param CatalogId [required] +#' @param DatabaseName [required] +#' @param TableName [required] +#' @param Expression +#' @param AuditContext +#' @param SupportedPermissionTypes [required] +#' @param NextToken +#' @param Segment +#' @param MaxResults #' #' @keywords internal #' @@ -4279,11 +4279,11 @@ glue_get_unfiltered_partitions_metadata <- function(CatalogId, DatabaseName, Tab #' #' See [https://paws-r.github.io/docs/glue/get_unfiltered_table_metadata.html](https://paws-r.github.io/docs/glue/get_unfiltered_table_metadata.html) for full documentation. #' -#' @param CatalogId [required] -#' @param DatabaseName [required] -#' @param Name [required] -#' @param AuditContext -#' @param SupportedPermissionTypes [required] +#' @param CatalogId [required] +#' @param DatabaseName [required] +#' @param Name [required] +#' @param AuditContext +#' @param SupportedPermissionTypes [required] #' #' @keywords internal #' @@ -4799,11 +4799,11 @@ glue_list_registries <- function(MaxResults = NULL, NextToken = NULL) { #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' Either `SchemaArn` or `SchemaName` and `RegistryName` has to be #' provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. Either `SchemaArn` or #' `SchemaName` and `RegistryName` has to be provided. #' @param MaxResults Maximum number of results required per page. If the value is not @@ -5042,12 +5042,12 @@ glue_put_data_catalog_encryption_settings <- function(CatalogId = NULL, DataCata #' policy. #' @param EnableHybrid If `'TRUE'`, indicates that you are using both methods to grant #' cross-account access to Data Catalog resources: -#' +#' #' - By directly updating the resource policy with `PutResourePolicy` -#' +#' #' - By using the **Grant permissions** command on the Amazon Web #' Services Management Console. -#' +#' #' Must be set to `'TRUE'` if you have already used the Management Console #' to grant cross-account access, otherwise the call fails. Default is #' 'FALSE'. @@ -5182,11 +5182,11 @@ glue_query_schema_version_metadata <- function(SchemaId = NULL, SchemaVersionNum #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' Either `SchemaArn` or `SchemaName` and `RegistryName` has to be #' provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. Either `SchemaArn` or #' `SchemaName` and `RegistryName` has to be provided. #' @param SchemaDefinition [required] The schema definition using the `DataFormat` setting for the @@ -5352,18 +5352,18 @@ glue_run_statement <- function(SessionId, Code, RequestOrigin = NULL) { #' @param NextToken A continuation token, included if this is a continuation call. #' @param Filters A list of key-value pairs, and a comparator used to filter the search #' results. Returns all entities matching the predicate. -#' +#' #' The `Comparator` member of the `PropertyPredicate` struct is used only #' for time fields, and can be omitted for other field types. Also, when #' comparing string values, such as when `Key=Name`, a fuzzy match #' algorithm is used. The `Key` field (for example, the value of the `Name` #' field) is split on certain punctuation characters, for example, -, :, -#' \#, etc. into tokens. Then each token is exact-match compared with the +#' #, etc. into tokens. Then each token is exact-match compared with the #' `Value` member of `PropertyPredicate`. For example, if `Key=Name` and #' `Value=link`, tables named `customer-link` and `xx-link-yy` are #' returned, but `xxlinkyy` is not returned. #' @param SearchText A string used for a text search. -#' +#' #' Specifying a value in quotes filters based on an exact match to the #' value. #' @param SortCriteria A list of criteria for sorting the results by a field name, in an @@ -5371,10 +5371,10 @@ glue_run_statement <- function(SessionId, Code, RequestOrigin = NULL) { #' @param MaxResults The maximum number of tables to return in a single response. #' @param ResourceShareType Allows you to specify that you want to search the tables shared with #' your account. The allowable values are `FOREIGN` or `ALL`. -#' +#' #' - If set to `FOREIGN`, will search the tables shared with your #' account. -#' +#' #' - If set to `ALL`, will search the tables shared with your account, as #' well as the tables in yor local account. #' @@ -5565,25 +5565,25 @@ glue_start_import_labels_task_run <- function(TransformId, InputS3Path, ReplaceA #' @param JobRunId The ID of a previous `JobRun` to retry. #' @param Arguments The job arguments specifically for this run. For this job run, they #' replace the default arguments set in the job definition itself. -#' +#' #' You can specify arguments here that your own job-execution script #' consumes, as well as arguments that Glue itself consumes. -#' +#' #' Job arguments may be logged. Do not pass plaintext secrets as arguments. #' Retrieve secrets from a Glue Connection, Secrets Manager or other secret #' management mechanism if you intend to keep them within the Job. -#' +#' #' For information about how to specify and consume your own Job arguments, #' see the [Calling Glue APIs in #' Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) #' topic in the developer guide. -#' +#' #' For information about the key-value pairs that Glue consumes to set up #' your job, see the [Special Parameters Used by #' Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) #' topic in the developer guide. #' @param AllocatedCapacity This field is deprecated. Use `MaxCapacity` instead. -#' +#' #' The number of Glue data processing units (DPUs) to allocate to this #' JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU #' is a relative measure of processing power that consists of 4 vCPUs of @@ -5592,7 +5592,7 @@ glue_start_import_labels_task_run <- function(TransformId, InputS3Path, ReplaceA #' @param Timeout The `JobRun` timeout in minutes. This is the maximum time that a job run #' can consume resources before it is terminated and enters `TIMEOUT` #' status. This value overrides the timeout value set in the parent job. -#' +#' #' Streaming jobs do not have a timeout. The default for non-streaming jobs #' is 2,880 minutes (48 hours). #' @param MaxCapacity The number of Glue data processing units (DPUs) that can be allocated @@ -5600,16 +5600,16 @@ glue_start_import_labels_task_run <- function(TransformId, InputS3Path, ReplaceA #' consists of 4 vCPUs of compute capacity and 16 GB of memory. For more #' information, see the [Glue pricing #' page](https://aws.amazon.com/glue/pricing/). -#' +#' #' Do not set `Max Capacity` if using `WorkerType` and `NumberOfWorkers`. -#' +#' #' The value that can be allocated for `MaxCapacity` depends on whether you #' are running a Python shell job, or an Apache Spark ETL job: -#' +#' #' - When you specify a Python shell job #' (`JobCommand.Name`="pythonshell"), you can allocate either 0.0625 or #' 1 DPU. The default is 0.0625 DPU. -#' +#' #' - When you specify an Apache Spark ETL job #' (`JobCommand.Name`="glueetl"), you can allocate a minimum of 2 DPUs. #' The default is 10 DPUs. This job type cannot have a fractional DPU @@ -5619,16 +5619,16 @@ glue_start_import_labels_task_run <- function(TransformId, InputS3Path, ReplaceA #' @param NotificationProperty Specifies configuration properties of a job run notification. #' @param WorkerType The type of predefined worker that is allocated when a job runs. Accepts #' a value of Standard, G.1X, G.2X, or G.025X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker provides 4 vCPU, 16 GB of #' memory and a 64GB disk, and 1 executor per worker. -#' +#' #' - For the `G.2X` worker type, each worker provides 8 vCPU, 32 GB of #' memory and a 128GB disk, and 1 executor per worker. -#' +#' #' - For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPU, #' 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We #' recommend this worker type for low volume streaming jobs. This @@ -5638,10 +5638,10 @@ glue_start_import_labels_task_run <- function(TransformId, InputS3Path, ReplaceA #' @param ExecutionClass Indicates whether the job is run with a standard or flexible execution #' class. The standard execution-class is ideal for time-sensitive #' workloads that require fast job startup and dedicated resources. -#' +#' #' The flexible execution class is appropriate for time-insensitive jobs #' whose start and completion times may vary. -#' +#' #' Only jobs with Glue version 3.0 and above and command type `glueetl` #' will be allowed to set `ExecutionClass` to `FLEX`. The flexible #' execution class is available for Spark jobs. @@ -6303,11 +6303,11 @@ glue_update_database <- function(CatalogId = NULL, Name, DatabaseInput) { #' to configure the `DevEndpoint`. #' @param AddArguments The map of arguments to add the map of arguments used to configure the #' `DevEndpoint`. -#' +#' #' Valid arguments are: -#' +#' #' - `"--enable-glue-datacatalog": ""` -#' +#' #' You can specify a version of Python support for development endpoints by #' using the `Arguments` parameter in the #' [`create_dev_endpoint`][glue_create_dev_endpoint] or @@ -6391,18 +6391,18 @@ glue_update_job <- function(JobName, JobUpdate) { #' consists of 4 vCPUs of compute capacity and 16 GB of memory. For more #' information, see the [Glue pricing #' page](https://aws.amazon.com/glue/pricing/). -#' +#' #' When the `WorkerType` field is set to a value other than `Standard`, the #' `MaxCapacity` field is set automatically and becomes read-only. #' @param WorkerType The type of predefined worker that is allocated when this task runs. #' Accepts a value of Standard, G.1X, or G.2X. -#' +#' #' - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB #' of memory and a 50GB disk, and 2 executors per worker. -#' +#' #' - For the `G.1X` worker type, each worker provides 4 vCPU, 16 GB of #' memory and a 64GB disk, and 1 executor per worker. -#' +#' #' - For the `G.2X` worker type, each worker provides 8 vCPU, 32 GB of #' memory and a 128GB disk, and 1 executor per worker. #' @param NumberOfWorkers The number of workers of a defined `workerType` that are allocated when @@ -6447,7 +6447,7 @@ glue_update_ml_transform <- function(TransformId, Name = NULL, Description = NUL #' @param TableName [required] The name of the table in which the partition to be updated is located. #' @param PartitionValueList [required] List of partition key values that define the partition to update. #' @param PartitionInput [required] The new partition object to update the partition to. -#' +#' #' The `Values` property can't be changed. If you want to change the #' partition key values for a partition, delete and recreate the partition. #' @@ -6514,10 +6514,10 @@ glue_update_registry <- function(RegistryId, Description) { #' #' @param SchemaId [required] This is a wrapper structure to contain schema identity fields. The #' structure contains: -#' +#' #' - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. #' One of `SchemaArn` or `SchemaName` has to be provided. -#' +#' #' - SchemaId$SchemaName: The name of the schema. One of `SchemaArn` or #' `SchemaName` has to be provided. #' @param SchemaVersionNumber Version number required for check pointing. One of `VersionNumber` or diff --git a/cran/paws.analytics/cran-comments.md b/cran/paws.analytics/cran-comments.md index 35783bff76..525551807b 100644 --- a/cran/paws.analytics/cran-comments.md +++ b/cran/paws.analytics/cran-comments.md @@ -2,16 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no ERRORs, or WARNINGs. +There were no ERRORs or WARNINGs. -NOTE: -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch + +Maintainer Notes: tarball package size: 534.5K ## Downstream dependencies diff --git a/cran/paws.analytics/man/glue_search_tables.Rd b/cran/paws.analytics/man/glue_search_tables.Rd index e76b0e3165..2fbe186c21 100644 --- a/cran/paws.analytics/man/glue_search_tables.Rd +++ b/cran/paws.analytics/man/glue_search_tables.Rd @@ -28,7 +28,7 @@ for time fields, and can be omitted for other field types. Also, when comparing string values, such as when \code{Key=Name}, a fuzzy match algorithm is used. The \code{Key} field (for example, the value of the \code{Name} field) is split on certain punctuation characters, for example, -, :, -\#, etc. into tokens. Then each token is exact-match compared with the +#, etc. into tokens. Then each token is exact-match compared with the \code{Value} member of \code{PropertyPredicate}. For example, if \code{Key=Name} and \code{Value=link}, tables named \code{customer-link} and \code{xx-link-yy} are returned, but \code{xxlinkyy} is not returned.} diff --git a/cran/paws.application.integration/R/locationservice_operations.R b/cran/paws.application.integration/R/locationservice_operations.R index 6755d3e3fc..5ad26fbd6d 100644 --- a/cran/paws.application.integration/R/locationservice_operations.R +++ b/cran/paws.application.integration/R/locationservice_operations.R @@ -15,8 +15,8 @@ NULL #' associated to tracker resource. Used when you need to specify a resource #' across all AWS. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` +#' - Format example: +#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` #' @param TrackerName [required] The name of the tracker resource to be associated with a geofence #' collection. #' @@ -50,7 +50,7 @@ locationservice_associate_tracker_consumer <- function(ConsumerArn, TrackerName) #' #' @param DeviceIds [required] Devices whose position history you want to delete. #' -#' - For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` +#' - For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` #' @param TrackerName [required] The name of the tracker resource to delete the device position history #' from. #' @@ -146,8 +146,8 @@ locationservice_batch_evaluate_geofences <- function(CollectionName, DevicePosit #' #' @param DeviceIds [required] Devices whose position you want to retrieve. #' -#' - For example, for two devices: -#' `device-ids=DeviceId1&device-ids=DeviceId2` +#' - For example, for two devices: +#' `device-ids=DeviceId1&device-ids=DeviceId2` #' @param TrackerName [required] The tracker resource retrieving the device position. #' #' @keywords internal @@ -258,7 +258,7 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' 84)](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) #' format: `[longitude, latitude]`. #' -#' - For example, `[-123.115, 49.285]` +#' - For example, `[-123.115, 49.285]` #' #' If you specify a departure that's not located on a road, Amazon Location #' [moves the position to the nearest @@ -275,15 +275,14 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' Setting a departure time in the past returns a `400 ValidationException` #' error. #' -#' - In [ISO -#' 8601](https://www.iso.org/iso-8601-date-and-time-format.html) -#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, -#' `2020–07-2T12:15:20.000Z+01:00` +#' - In [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) +#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, +#' `2020–07-2T12:15:20.000Z+01:00` #' @param DestinationPosition [required] The finish position for the route. Defined in [World Geodetic System #' (WGS 84)](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) #' format: `[longitude, latitude]`. #' -#' - For example, `[-122.339, 47.615]` +#' - For example, `[-122.339, 47.615]` #' #' If you specify a destination that's not located on a road, Amazon #' Location [moves the position to the nearest @@ -306,9 +305,9 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' The `TravelMode` you specify also determines how you specify route #' preferences: #' -#' - If traveling by `Car` use the `CarModeOptions` parameter. +#' - If traveling by `Car` use the `CarModeOptions` parameter. #' -#' - If traveling by `Truck` use the `TruckModeOptions` parameter. +#' - If traveling by `Truck` use the `TruckModeOptions` parameter. #' #' Default Value: `Car` #' @param TruckModeOptions Specifies route preferences when traveling by `Truck`, such as avoiding @@ -319,9 +318,9 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' @param WaypointPositions Specifies an ordered list of up to 23 intermediate positions to include #' along a route between the departure position and destination position. #' -#' - For example, from the `DeparturePosition` `[-123.115, 49.285]`, the -#' route follows the order that the waypoint positions are given -#' `[[-122.757, 49.0021],[-122.349, 47.620]]` +#' - For example, from the `DeparturePosition` `[-123.115, 49.285]`, the +#' route follows the order that the waypoint positions are given +#' `[[-122.757, 49.0021],[-122.349, 47.620]]` #' #' If you specify a waypoint position that's not located on a road, Amazon #' Location [moves the position to the nearest @@ -405,10 +404,9 @@ locationservice_calculate_route <- function(CalculatorName, CarModeOptions = NUL #' Setting a departure time in the past returns a `400 ValidationException` #' error. #' -#' - In [ISO -#' 8601](https://www.iso.org/iso-8601-date-and-time-format.html) -#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, -#' `2020–07-2T12:15:20.000Z+01:00` +#' - In [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) +#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, +#' `2020–07-2T12:15:20.000Z+01:00` #' @param DestinationPositions [required] The list of destination positions for the route matrix. An array of #' points, each of which is itself a 2-value array defined in [WGS #' 84](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) format: @@ -437,9 +435,9 @@ locationservice_calculate_route <- function(CalculatorName, CarModeOptions = NUL #' The `TravelMode` you specify also determines how you specify route #' preferences: #' -#' - If traveling by `Car` use the `CarModeOptions` parameter. +#' - If traveling by `Car` use the `CarModeOptions` parameter. #' -#' - If traveling by `Truck` use the `TruckModeOptions` parameter. +#' - If traveling by `Truck` use the `TruckModeOptions` parameter. #' #' Default Value: `Car` #' @param TruckModeOptions Specifies route preferences when traveling by `Truck`, such as avoiding @@ -479,12 +477,12 @@ locationservice_calculate_route_matrix <- function(CalculatorName, CarModeOption #' #' Requirements: #' -#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique geofence collection name. +#' - Must be a unique geofence collection name. #' -#' - No spaces allowed. For example, `ExampleGeofenceCollection`. +#' - No spaces allowed. For example, `ExampleGeofenceCollection`. #' @param Description An optional description for the geofence collection. #' @param KmsKeyId A key identifier for an [AWS KMS customer managed #' key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). @@ -500,18 +498,18 @@ locationservice_calculate_route_matrix <- function(CalculatorName, CarModeOption #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @keywords internal #' @@ -547,12 +545,12 @@ locationservice_create_geofence_collection <- function(CollectionName, Descripti #' #' Requirements: #' -#' - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens -#' (-), periods (.), and underscores (_). +#' - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens +#' (-), periods (.), and underscores (_). #' -#' - Must be a unique map resource name. +#' - Must be a unique map resource name. #' -#' - No spaces allowed. For example, `ExampleMap`. +#' - No spaces allowed. For example, `ExampleMap`. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param Tags Applies one or more tags to the map resource. A tag is a key-value pair @@ -563,18 +561,18 @@ locationservice_create_geofence_collection <- function(CollectionName, Descripti #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @keywords internal #' @@ -610,22 +608,22 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Valid values include: #' -#' - `Esri` – For additional information about -#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s -#' coverage in your region of interest, see [Esri details on geocoding -#' coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm). +#' - `Esri` – For additional information about +#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s +#' coverage in your region of interest, see [Esri details on geocoding +#' coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm). #' -#' - `Here` – For additional information about [HERE -#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' -#' coverage in your region of interest, see HERE details on goecoding -#' coverage. +#' - `Here` – For additional information about [HERE +#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' +#' coverage in your region of interest, see HERE details on goecoding +#' coverage. #' -#' If you specify HERE Technologies (`Here`) as the data provider, you -#' may not [store -#' results](https://docs.aws.amazon.com/location/latest/APIReference/API_DataSourceConfiguration.html) -#' for locations in Japan. For more information, see the [AWS Service -#' Terms](https://aws.amazon.com/service-terms/) for Amazon Location -#' Service. +#' If you specify HERE Technologies (`Here`) as the data provider, you +#' may not [store +#' results](https://docs.aws.amazon.com/location/latest/APIReference/API_DataSourceConfiguration.html) +#' for locations in Japan. For more information, see the [AWS Service +#' Terms](https://aws.amazon.com/service-terms/) for Amazon Location +#' Service. #' #' For additional information , see [Data #' providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) @@ -636,12 +634,12 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Requirements: #' -#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique place index resource name. +#' - Must be a unique place index resource name. #' -#' - No spaces allowed. For example, `ExamplePlaceIndex`. +#' - No spaces allowed. For example, `ExamplePlaceIndex`. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param Tags Applies one or more tags to the place index resource. A tag is a @@ -652,19 +650,19 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Restrictions: #' -#' - Maximum 50 tags per resource. +#' - Maximum 50 tags per resource. #' -#' - Each tag key must be unique and must have exactly one associated -#' value. +#' - Each tag key must be unique and must have exactly one associated +#' value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8. +#' - Maximum key length: 128 Unicode characters in UTF-8. #' -#' - Maximum value length: 256 Unicode characters in UTF-8. +#' - Maximum value length: 256 Unicode characters in UTF-8. #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@ +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@ #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @keywords internal #' @@ -697,12 +695,12 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' #' Requirements: #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), -#' periods (.), and underscores (_). +#' - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods +#' (.), and underscores (_). #' -#' - Must be a unique Route calculator resource name. +#' - Must be a unique Route calculator resource name. #' -#' - No spaces allowed. For example, `ExampleRouteCalculator`. +#' - No spaces allowed. For example, `ExampleRouteCalculator`. #' @param DataSource [required] Specifies the data provider of traffic and road network data. #' #' This field is case-sensitive. Enter the valid values as shown. For @@ -712,16 +710,17 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' #' Valid values include: #' -#' - `Esri` – For additional information about -#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s -#' coverage in your region of interest, see [Esri details on street -#' networks and traffic -#' coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm). +#' - `Esri` – For additional information about +#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s +#' coverage in your region of interest, see [Esri details on street +#' networks and traffic +#' coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm). #' -#' - `Here` – For additional information about [HERE -#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' -#' coverage in your region of interest, see HERE car routing coverage -#' and HERE truck routing coverage. +#' - `Here` – For additional information about [HERE +#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' +#' coverage in your region of interest, see HERE car routing coverage and +#' [HERE truck routing +#' coverage](https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html). #' #' For additional information , see [Data #' providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) @@ -733,24 +732,24 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' key-value pair helps manage, identify, search, and filter your resources #' by labelling them. #' -#' - For example: \{ `"tag1" : "value1"`, `"tag2" : "value2"`\} +#' - For example: \\ `"tag1" : "value1"`, `"tag2" : "value2"`\\ #' #' Format: `"key" : "value"` #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @keywords internal #' @@ -788,28 +787,28 @@ locationservice_create_route_calculator <- function(CalculatorName, DataSource, #' #' Valid values: #' -#' - `TimeBased` - Location updates are evaluated against linked geofence -#' collections, but not every location update is stored. If your update -#' frequency is more often than 30 seconds, only one update per 30 -#' seconds is stored for each unique device ID. -#' -#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), -#' location updates are ignored. Location updates within this area are -#' neither evaluated against linked geofence collections, nor stored. -#' This helps control costs by reducing the number of geofence -#' evaluations and historical device positions to paginate through. -#' Distance-based filtering can also reduce the effects of GPS noise -#' when displaying device trajectories on a map. -#' -#' - `AccuracyBased` - If the device has moved less than the measured -#' accuracy, location updates are ignored. For example, if two -#' consecutive updates from a device have a horizontal accuracy of 5 m -#' and 10 m, the second update is ignored if the device has moved less -#' than 15 m. Ignored location updates are neither evaluated against -#' linked geofence collections, nor stored. This can reduce the effects -#' of GPS noise when displaying device trajectories on a map, and can -#' help control your costs by reducing the number of geofence -#' evaluations. +#' - `TimeBased` - Location updates are evaluated against linked geofence +#' collections, but not every location update is stored. If your update +#' frequency is more often than 30 seconds, only one update per 30 +#' seconds is stored for each unique device ID. +#' +#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), +#' location updates are ignored. Location updates within this area are +#' neither evaluated against linked geofence collections, nor stored. +#' This helps control costs by reducing the number of geofence +#' evaluations and historical device positions to paginate through. +#' Distance-based filtering can also reduce the effects of GPS noise when +#' displaying device trajectories on a map. +#' +#' - `AccuracyBased` - If the device has moved less than the measured +#' accuracy, location updates are ignored. For example, if two +#' consecutive updates from a device have a horizontal accuracy of 5 m +#' and 10 m, the second update is ignored if the device has moved less +#' than 15 m. Ignored location updates are neither evaluated against +#' linked geofence collections, nor stored. This can reduce the effects +#' of GPS noise when displaying device trajectories on a map, and can +#' help control your costs by reducing the number of geofence +#' evaluations. #' #' This field is optional. If not specified, the default value is #' `TimeBased`. @@ -824,28 +823,28 @@ locationservice_create_route_calculator <- function(CalculatorName, DataSource, #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' @param TrackerName [required] The name for the tracker resource. #' #' Requirements: #' -#' - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique tracker resource name. +#' - Must be a unique tracker resource name. #' -#' - No spaces allowed. For example, `ExampleTracker`. +#' - No spaces allowed. For example, `ExampleTracker`. #' #' @keywords internal #' @@ -1169,8 +1168,8 @@ locationservice_describe_tracker <- function(TrackerName) { #' disassociated from the tracker resource. Used when you need to specify a #' resource across all AWS. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` +#' - Format example: +#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` #' @param TrackerName [required] The name of the tracker resource to be dissociated from the consumer. #' #' @keywords internal @@ -1239,8 +1238,8 @@ locationservice_get_device_position <- function(DeviceId, TrackerName) { #' #' Requirement: #' -#' - The time specified for `EndTimeExclusive` must be after the time for -#' `StartTimeInclusive`. +#' - The time specified for `EndTimeExclusive` must be after the time for +#' `StartTimeInclusive`. #' @param MaxResults An optional limit for the number of device positions returned in a #' single call. #' @@ -1256,8 +1255,8 @@ locationservice_get_device_position <- function(DeviceId, TrackerName) { #' #' Requirement: #' -#' - The time specified for `StartTimeInclusive` must be before -#' `EndTimeExclusive`. +#' - The time specified for `StartTimeInclusive` must be before +#' `EndTimeExclusive`. #' @param TrackerName [required] The tracker resource receiving the request for the device position #' history. #' @@ -1325,30 +1324,29 @@ locationservice_get_geofence <- function(CollectionName, GeofenceId) { #' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html) #' styles: #' -#' - VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` | `Ubuntu Medium` -#' | `Ubuntu Italic` | `Ubuntu Regular` | `Ubuntu Bold` +#' - VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` | `Ubuntu Medium` | +#' `Ubuntu Italic` | `Ubuntu Regular` | `Ubuntu Bold` #' -#' - VectorEsriLightGrayCanvas – `Ubuntu Italic` | `Ubuntu Regular` | -#' `Ubuntu Light` | `Ubuntu Bold` +#' - VectorEsriLightGrayCanvas – `Ubuntu Italic` | `Ubuntu Regular` | +#' `Ubuntu Light` | `Ubuntu Bold` #' -#' - VectorEsriTopographic – `Noto Sans Italic` | `Noto Sans Regular` | -#' `Noto Sans Bold` | `Noto Serif Regular` | -#' `Roboto Condensed Light Italic` +#' - VectorEsriTopographic – `Noto Sans Italic` | `Noto Sans Regular` | +#' `Noto Sans Bold` | `Noto Serif Regular` | +#' `Roboto Condensed Light Italic` #' -#' - VectorEsriStreets – `Arial Regular` | `Arial Italic` | `Arial Bold` +#' - VectorEsriStreets – `Arial Regular` | `Arial Italic` | `Arial Bold` #' -#' - VectorEsriNavigation – `Arial Regular` | `Arial Italic` | -#' `Arial Bold` +#' - VectorEsriNavigation – `Arial Regular` | `Arial Italic` | `Arial Bold` #' #' Valid font stacks for [HERE #' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) #' styles: #' -#' - VectorHereContrast – `Fira GO Regular` | `Fira GO Bold` +#' - VectorHereContrast – `Fira GO Regular` | `Fira GO Bold` #' -#' - VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` | -#' `Fira GO Map` | `Fira GO Map Bold` | `Noto Sans CJK JP Bold` | -#' `Noto Sans CJK JP Light` | `Noto Sans CJK JP Regular` +#' - VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` | +#' `Fira GO Map` | `Fira GO Map Bold` | `Noto Sans CJK JP Bold` | +#' `Noto Sans CJK JP Light` | `Noto Sans CJK JP Regular` #' @param FontUnicodeRange [required] A Unicode range of characters to download glyphs for. Each response will #' contain 256 characters. For example, 0–255 includes all characters from #' range `U+0000` to `00FF`. Must be aligned to multiples of 256. @@ -1384,16 +1382,16 @@ locationservice_get_map_glyphs <- function(FontStack, FontUnicodeRange, MapName) #' @param FileName [required] The name of the sprite file. Use the following file names for the sprite #' sheet: #' -#' - `sprites.png` +#' - `sprites.png` #' -#' - `sprites@@2x.png` for high pixel density displays +#' - `sprites@@2x.png` for high pixel density displays #' #' For the JSON document contain image offsets. Use the following file #' names: #' -#' - `sprites.json` +#' - `sprites.json` #' -#' - `sprites@@2x.json` for high pixel density displays +#' - `sprites@@2x.json` for high pixel density displays #' @param MapName [required] The map resource associated with the sprite file. #' #' @keywords internal @@ -1701,8 +1699,8 @@ locationservice_list_route_calculators <- function(MaxResults = NULL, NextToken #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource whose tags you want to #' retrieve. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' #' @keywords internal #' @@ -1857,7 +1855,7 @@ locationservice_put_geofence <- function(CollectionName, GeofenceId, Geometry) { #' `city` in the results will most likely be returned as `Athens`. #' #' If you set the `language` parameter to `el`, for Greek, then the `city` -#' in the results will more likely be returned as ``. +#' in the results will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -1934,9 +1932,9 @@ locationservice_search_place_index_for_position <- function(IndexName, Language #' @param FilterCountries An optional parameter that limits the search results by returning only #' suggestions within the provided list of countries. #' -#' - Use the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) -#' 3-digit country code. For example, Australia uses three upper-case -#' characters: `AUS`. +#' - Use the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) +#' 3-digit country code. For example, Australia uses three upper-case +#' characters: `AUS`. #' @param IndexName [required] The name of the place index resource you want to use for the search. #' @param Language The preferred language used to return results. The value must be a valid #' [BCP @@ -1953,7 +1951,7 @@ locationservice_search_place_index_for_position <- function(IndexName, Language #' `Athens, Greece`. #' #' If you set the `language` parameter to `el`, for Greek, then the result -#' found will more likely be returned as `, Ελλάδ`. +#' found will more likely be returned as \eqn{A\Theta\eta\nu\sigma, E\lambda\lambda\alpha\delta}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -2024,10 +2022,9 @@ locationservice_search_place_index_for_suggestions <- function(BiasPosition = NU #' @param FilterCountries An optional parameter that limits the search results by returning only #' places that are in a specified list of countries. #' -#' - Valid values include [ISO -#' 3166](https://www.iso.org/iso-3166-country-codes.html) 3-digit -#' country codes. For example, Australia uses three upper-case -#' characters: `AUS`. +#' - Valid values include [ISO +#' 3166](https://www.iso.org/iso-3166-country-codes.html) 3-digit country +#' codes. For example, Australia uses three upper-case characters: `AUS`. #' @param IndexName [required] The name of the place index resource you want to use for the search. #' @param Language The preferred language used to return results. The value must be a valid #' [BCP @@ -2044,7 +2041,7 @@ locationservice_search_place_index_for_suggestions <- function(BiasPosition = NU #' found will most likely be returned as `Athens`. #' #' If you set the `language` parameter to `el`, for Greek, then the result -#' found will more likely be returned as ``. +#' found will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -2086,8 +2083,8 @@ locationservice_search_place_index_for_text <- function(BiasPosition = NULL, Fil #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource whose tags you want to #' update. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' @param Tags [required] Applies one or more tags to specific resource. A tag is a key-value pair #' that helps you manage, identify, search, and filter your resources. #' @@ -2095,19 +2092,19 @@ locationservice_search_place_index_for_text <- function(BiasPosition = NULL, Fil #' #' Restrictions: #' -#' - Maximum 50 tags per resource. +#' - Maximum 50 tags per resource. #' -#' - Each tag key must be unique and must have exactly one associated -#' value. +#' - Each tag key must be unique and must have exactly one associated +#' value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8. +#' - Maximum key length: 128 Unicode characters in UTF-8. #' -#' - Maximum value length: 256 Unicode characters in UTF-8. +#' - Maximum value length: 256 Unicode characters in UTF-8. #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@ +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@ #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @keywords internal #' @@ -2139,8 +2136,8 @@ locationservice_tag_resource <- function(ResourceArn, Tags) { #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource from which you want to #' remove tags. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' @param TagKeys [required] The list of tag keys to remove from the specified resource. #' #' @keywords internal @@ -2305,28 +2302,27 @@ locationservice_update_route_calculator <- function(CalculatorName, Description #' #' Valid values: #' -#' - `TimeBased` - Location updates are evaluated against linked geofence -#' collections, but not every location update is stored. If your update -#' frequency is more often than 30 seconds, only one update per 30 -#' seconds is stored for each unique device ID. -#' -#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), -#' location updates are ignored. Location updates within this distance -#' are neither evaluated against linked geofence collections, nor -#' stored. This helps control costs by reducing the number of geofence -#' evaluations and historical device positions to paginate through. -#' Distance-based filtering can also reduce the effects of GPS noise -#' when displaying device trajectories on a map. -#' -#' - `AccuracyBased` - If the device has moved less than the measured -#' accuracy, location updates are ignored. For example, if two -#' consecutive updates from a device have a horizontal accuracy of 5 m -#' and 10 m, the second update is ignored if the device has moved less -#' than 15 m. Ignored location updates are neither evaluated against -#' linked geofence collections, nor stored. This helps educe the -#' effects of GPS noise when displaying device trajectories on a map, -#' and can help control costs by reducing the number of geofence -#' evaluations. +#' - `TimeBased` - Location updates are evaluated against linked geofence +#' collections, but not every location update is stored. If your update +#' frequency is more often than 30 seconds, only one update per 30 +#' seconds is stored for each unique device ID. +#' +#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), +#' location updates are ignored. Location updates within this distance +#' are neither evaluated against linked geofence collections, nor stored. +#' This helps control costs by reducing the number of geofence +#' evaluations and historical device positions to paginate through. +#' Distance-based filtering can also reduce the effects of GPS noise when +#' displaying device trajectories on a map. +#' +#' - `AccuracyBased` - If the device has moved less than the measured +#' accuracy, location updates are ignored. For example, if two +#' consecutive updates from a device have a horizontal accuracy of 5 m +#' and 10 m, the second update is ignored if the device has moved less +#' than 15 m. Ignored location updates are neither evaluated against +#' linked geofence collections, nor stored. This helps educe the effects +#' of GPS noise when displaying device trajectories on a map, and can +#' help control costs by reducing the number of geofence evaluations. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param PricingPlanDataSource This parameter is no longer used. diff --git a/cran/paws.application.integration/cran-comments.md b/cran/paws.application.integration/cran-comments.md index 3a6c8aebe5..68dabab1d7 100644 --- a/cran/paws.application.integration/cran-comments.md +++ b/cran/paws.application.integration/cran-comments.md @@ -2,12 +2,13 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no NOTEs, ERRORs, or WARNINGs. +There were no ERRORs, WARNINGs, or Notes. -Update to package maintainer +Maintainer Notes: tarball package size: 195.7K ## Downstream dependencies diff --git a/cran/paws.application.integration/man/locationservice_search_place_index_for_position.Rd b/cran/paws.application.integration/man/locationservice_search_place_index_for_position.Rd index 94d6c87158..62dce46c2d 100644 --- a/cran/paws.application.integration/man/locationservice_search_place_index_for_position.Rd +++ b/cran/paws.application.integration/man/locationservice_search_place_index_for_position.Rd @@ -27,7 +27,7 @@ around Athens, Greece, with the \code{language} parameter set to \code{en}. The \code{city} in the results will most likely be returned as \code{Athens}. If you set the \code{language} parameter to \code{el}, for Greek, then the \code{city} -in the results will more likely be returned as ``. +in the results will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.} diff --git a/cran/paws.application.integration/man/locationservice_search_place_index_for_suggestions.Rd b/cran/paws.application.integration/man/locationservice_search_place_index_for_suggestions.Rd index e54fc32ceb..e2c99e4093 100644 --- a/cran/paws.application.integration/man/locationservice_search_place_index_for_suggestions.Rd +++ b/cran/paws.application.integration/man/locationservice_search_place_index_for_suggestions.Rd @@ -71,7 +71,7 @@ For an example, we'll use the Greek language. You search for \verb{Athens, Greece}. If you set the \code{language} parameter to \code{el}, for Greek, then the result -found will more likely be returned as \verb{, Ελλάδ}. +found will more likely be returned as \eqn{A\Theta\eta\nu\sigma, E\lambda\lambda\alpha\delta}. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.} diff --git a/cran/paws.application.integration/man/locationservice_search_place_index_for_text.Rd b/cran/paws.application.integration/man/locationservice_search_place_index_for_text.Rd index d1e7046f37..f3e5c65b49 100644 --- a/cran/paws.application.integration/man/locationservice_search_place_index_for_text.Rd +++ b/cran/paws.application.integration/man/locationservice_search_place_index_for_text.Rd @@ -50,9 +50,8 @@ options results in an error.} \item{FilterCountries}{An optional parameter that limits the search results by returning only places that are in a specified list of countries. \itemize{ -\item Valid values include \href{https://www.iso.org/iso-3166-country-codes.html}{ISO 3166} 3-digit -country codes. For example, Australia uses three upper-case -characters: \code{AUS}. +\item Valid values include \href{https://www.iso.org/iso-3166-country-codes.html}{ISO 3166} 3-digit country +codes. For example, Australia uses three upper-case characters: \code{AUS}. }} \item{IndexName}{[required] The name of the place index resource you want to use for the search.} @@ -71,7 +70,7 @@ For an example, we'll use the Greek language. You search for found will most likely be returned as \code{Athens}. If you set the \code{language} parameter to \code{el}, for Greek, then the result -found will more likely be returned as ``. +found will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.} diff --git a/cran/paws.compute/cran-comments.md b/cran/paws.compute/cran-comments.md index 31dd282212..326d7389b3 100644 --- a/cran/paws.compute/cran-comments.md +++ b/cran/paws.compute/cran-comments.md @@ -2,11 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results There were no ERRORs, or WARNINGs. +Notes: +checking installed package size ... NOTE + installed size is 6.5Mb + sub-directories of 1Mb or more: + R 3.0Mb + help 3.3Mb +Maintainer Notes: tarball package size: 856.7K ## Downstream dependencies diff --git a/cran/paws.cost.management/cran-comments.md b/cran/paws.cost.management/cran-comments.md index 03582c9c42..86dfd7a052 100644 --- a/cran/paws.cost.management/cran-comments.md +++ b/cran/paws.cost.management/cran-comments.md @@ -2,16 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no ERRORs, or WARNINGs. +There were no ERRORs or WARNINGs. -Note: -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch + +Maintainer Notes: tarball package size: 89.5K ## Downstream dependencies diff --git a/cran/paws.customer.engagement/cran-comments.md b/cran/paws.customer.engagement/cran-comments.md index 03582c9c42..949bd9519e 100644 --- a/cran/paws.customer.engagement/cran-comments.md +++ b/cran/paws.customer.engagement/cran-comments.md @@ -2,16 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no ERRORs, or WARNINGs. +There were no ERRORs or WARNINGs. -Note: -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch + +Maintainer Notes: tarball package size: 290.6K ## Downstream dependencies diff --git a/cran/paws.database/R/dynamodb_operations.R b/cran/paws.database/R/dynamodb_operations.R index 192a4f22ce..173fbaaa76 100644 --- a/cran/paws.database/R/dynamodb_operations.R +++ b/cran/paws.database/R/dynamodb_operations.R @@ -12,7 +12,7 @@ NULL #' See [https://paws-r.github.io/docs/dynamodb/batch_execute_statement.html](https://paws-r.github.io/docs/dynamodb/batch_execute_statement.html) for full documentation. #' #' @param Statements [required] The list of PartiQL statements representing the batch to run. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' #' @keywords internal #' @@ -46,77 +46,77 @@ dynamodb_batch_execute_statement <- function(Statements, ReturnConsumedCapacity #' describes one or more items to retrieve from that table. Each table name #' can be used only once per [`batch_get_item`][dynamodb_batch_get_item] #' request. -#' +#' #' Each element in the map of items to retrieve consists of the following: -#' +#' #' - `ConsistentRead` - If `true`, a strongly consistent read is used; if #' `false` (the default), an eventually consistent read is used. -#' +#' #' - `ExpressionAttributeNames` - One or more substitution tokens for #' attribute names in the `ProjectionExpression` parameter. The #' following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB #' reserved word. -#' +#' #' - To create a placeholder for repeating occurrences of an #' attribute name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an +#' +#' Use the **#** character in an expression to dereference an #' attribute name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it #' cannot be used directly in an expression. (For the complete list of #' reserved words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information about expression attribute names, see #' [Accessing Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. -#' +#' #' - `Keys` - An array of primary key attribute values that define #' specific items in the table. For each primary key, you must provide #' *all* of the key attributes. For example, with a simple primary key, #' you only need to provide the partition key value. For a composite #' key, you must provide *both* the partition key value and the sort #' key value. -#' +#' #' - `ProjectionExpression` - A string that identifies one or more #' attributes to retrieve from the table. These attributes can include #' scalars, sets, or elements of a JSON document. The attributes in the #' expression must be separated by commas. -#' +#' #' If no attribute names are specified, then all attributes are #' returned. If any of the requested attributes are not found, they do #' not appear in the result. -#' +#' #' For more information, see [Accessing Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. -#' +#' #' - `AttributesToGet` - This is a legacy parameter. Use #' `ProjectionExpression` instead. For more information, see #' [AttributesToGet](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) #' in the *Amazon DynamoDB Developer Guide*. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' #' @keywords internal #' @@ -149,11 +149,11 @@ dynamodb_batch_get_item <- function(RequestItems, ReturnConsumedCapacity = NULL) #' @param RequestItems [required] A map of one or more table names and, for each table, a list of #' operations to be performed (`DeleteRequest` or `PutRequest`). Each #' element in the map consists of the following: -#' +#' #' - `DeleteRequest` - Perform a [`delete_item`][dynamodb_delete_item] #' operation on the specified item. The item to be deleted is #' identified by a `Key` subelement: -#' +#' #' - `Key` - A map of primary key attribute values that uniquely #' identify the item. Each entry in this map consists of an #' attribute name and an attribute value. For each primary key, you @@ -161,22 +161,22 @@ dynamodb_batch_get_item <- function(RequestItems, ReturnConsumedCapacity = NULL) #' simple primary key, you only need to provide a value for the #' partition key. For a composite primary key, you must provide #' values for *both* the partition key and the sort key. -#' +#' #' - `PutRequest` - Perform a [`put_item`][dynamodb_put_item] operation #' on the specified item. The item to be put is identified by an `Item` #' subelement: -#' +#' #' - `Item` - A map of attributes and their values. Each entry in #' this map consists of an attribute name and an attribute value. #' Attribute values must not be null; string and binary type #' attributes must have lengths greater than zero; and set type #' attributes must not be empty. Requests that contain empty values #' are rejected with a `ValidationException` exception. -#' +#' #' If you specify any attributes that are part of an index key, #' then the data types for those attributes must match those of the #' schema in the table's attribute definition. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ReturnItemCollectionMetrics Determines whether item collection metrics are returned. If set to #' `SIZE`, the response includes statistics about item collections, if any, #' that were modified during the operation are returned in the response. If @@ -277,35 +277,35 @@ dynamodb_create_global_table <- function(GlobalTableName, ReplicationGroup) { #' `AttributeDefinitions` array. For more information, see [Data #' Model](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.html) #' in the *Amazon DynamoDB Developer Guide*. -#' +#' #' Each `KeySchemaElement` in the array is composed of: -#' +#' #' - `AttributeName` - The name of this key attribute. -#' +#' #' - `KeyType` - The role that the key attribute will assume: -#' +#' #' - `HASH` - partition key -#' +#' #' - `RANGE` - sort key -#' +#' #' The partition key of an item is also known as its *hash attribute*. The #' term "hash attribute" derives from the DynamoDB usage of an internal #' hash function to evenly distribute data items across partitions, based #' on their partition key values. -#' +#' #' The sort key of an item is also known as its *range attribute*. The term #' "range attribute" derives from the way DynamoDB stores items with the #' same partition key physically close together, in sorted order by the #' sort key value. -#' +#' #' For a simple primary key (partition key), you must provide exactly one #' element with a `KeyType` of `HASH`. -#' +#' #' For a composite primary key (partition key and sort key), you must #' provide exactly two elements, in this order: The first element must have #' a `KeyType` of `HASH`, and the second element must have a `KeyType` of #' `RANGE`. -#' +#' #' For more information, see [Working with #' Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key) #' in the *Amazon DynamoDB Developer Guide*. @@ -313,33 +313,33 @@ dynamodb_create_global_table <- function(GlobalTableName, ReplicationGroup) { #' the table. Each index is scoped to a given partition key value. There is #' a 10 GB size limit per partition key value; otherwise, the size of a #' local secondary index is unconstrained. -#' +#' #' Each local secondary index in the array includes the following: -#' +#' #' - `IndexName` - The name of the local secondary index. Must be unique #' only for this table. -#' +#' #' - `KeySchema` - Specifies the key schema for the local secondary #' index. The key schema must begin with the same partition key as the #' table. -#' +#' #' - `Projection` - Specifies attributes that are copied (projected) from #' the table into the index. These are in addition to the primary key #' attributes and index key attributes, which are automatically #' projected. Each attribute specification is composed of: -#' +#' #' - `ProjectionType` - One of the following: -#' +#' #' - `KEYS_ONLY` - Only the index and primary keys are projected #' into the index. -#' +#' #' - `INCLUDE` - Only the specified table attributes are #' projected into the index. The list of projected attributes #' is in `NonKeyAttributes`. -#' +#' #' - `ALL` - All of the table attributes are projected into the #' index. -#' +#' #' - `NonKeyAttributes` - A list of one or more non-key attribute #' names that are projected into the secondary index. The total #' count of attributes provided in `NonKeyAttributes`, summed @@ -349,47 +349,47 @@ dynamodb_create_global_table <- function(GlobalTableName, ReplicationGroup) { #' @param GlobalSecondaryIndexes One or more global secondary indexes (the maximum is 20) to be created #' on the table. Each global secondary index in the array includes the #' following: -#' +#' #' - `IndexName` - The name of the global secondary index. Must be unique #' only for this table. -#' +#' #' - `KeySchema` - Specifies the key schema for the global secondary #' index. -#' +#' #' - `Projection` - Specifies attributes that are copied (projected) from #' the table into the index. These are in addition to the primary key #' attributes and index key attributes, which are automatically #' projected. Each attribute specification is composed of: -#' +#' #' - `ProjectionType` - One of the following: -#' +#' #' - `KEYS_ONLY` - Only the index and primary keys are projected #' into the index. -#' +#' #' - `INCLUDE` - Only the specified table attributes are #' projected into the index. The list of projected attributes #' is in `NonKeyAttributes`. -#' +#' #' - `ALL` - All of the table attributes are projected into the #' index. -#' +#' #' - `NonKeyAttributes` - A list of one or more non-key attribute #' names that are projected into the secondary index. The total #' count of attributes provided in `NonKeyAttributes`, summed #' across all of the secondary indexes, must not exceed 100. If you #' project the same attribute into two different indexes, this #' counts as two distinct attributes when determining the total. -#' +#' #' - `ProvisionedThroughput` - The provisioned throughput settings for #' the global secondary index, consisting of read and write capacity #' units. #' @param BillingMode Controls how you are charged for read and write throughput and how you #' manage capacity. This setting can be changed later. -#' +#' #' - `PROVISIONED` - We recommend using `PROVISIONED` for predictable #' workloads. `PROVISIONED` sets the billing mode to [Provisioned #' Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). -#' +#' #' - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for #' unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to #' [On-Demand @@ -397,34 +397,34 @@ dynamodb_create_global_table <- function(GlobalTableName, ReplicationGroup) { #' @param ProvisionedThroughput Represents the provisioned throughput settings for a specified table or #' index. The settings can be modified using the #' [`update_table`][dynamodb_update_table] operation. -#' +#' #' If you set BillingMode as `PROVISIONED`, you must specify this property. #' If you set BillingMode as `PAY_PER_REQUEST`, you cannot specify this #' property. -#' +#' #' For current minimum and maximum provisioned throughput values, see #' [Service, Account, and Table #' Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ServiceQuotas.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param StreamSpecification The settings for DynamoDB Streams on the table. These settings consist #' of: -#' +#' #' - `StreamEnabled` - Indicates whether DynamoDB Streams is to be #' enabled (true) or disabled (false). -#' +#' #' - `StreamViewType` - When an item in the table is modified, #' `StreamViewType` determines what information is written to the #' table's stream. Valid values for `StreamViewType` are: -#' +#' #' - `KEYS_ONLY` - Only the key attributes of the modified item are #' written to the stream. -#' +#' #' - `NEW_IMAGE` - The entire item, as it appears after it was #' modified, is written to the stream. -#' +#' #' - `OLD_IMAGE` - The entire item, as it appeared before it was #' modified, is written to the stream. -#' +#' #' - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of #' the item are written to the stream. #' @param SSESpecification Represents the settings used to enable server-side encryption. @@ -493,7 +493,7 @@ dynamodb_delete_backup <- function(BackupArn) { #' @param TableName [required] The name of the table from which to delete the item. #' @param Key [required] A map of attribute names to `AttributeValue` objects, representing the #' primary key of the item to delete. -#' +#' #' For the primary key, you must provide all of the attributes. For #' example, with a simple primary key, you only need to provide a value for #' the partition key. For a composite primary key, you must provide values @@ -509,95 +509,95 @@ dynamodb_delete_backup <- function(BackupArn) { #' @param ReturnValues Use `ReturnValues` if you want to get the item attributes as they #' appeared before they were deleted. For #' [`delete_item`][dynamodb_delete_item], the valid values are: -#' +#' #' - `NONE` - If `ReturnValues` is not specified, or if its value is #' `NONE`, then nothing is returned. (This setting is the default for #' `ReturnValues`.) -#' +#' #' - `ALL_OLD` - The content of the old item is returned. -#' +#' #' There is no additional cost associated with requesting a return value #' aside from the small network and processing overhead of receiving a #' larger response. No read capacity units are consumed. -#' +#' #' The `ReturnValues` parameter is used by several DynamoDB operations; #' however, [`delete_item`][dynamodb_delete_item] does not recognize any #' values other than `NONE` or `ALL_OLD`. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ReturnItemCollectionMetrics Determines whether item collection metrics are returned. If set to #' `SIZE`, the response includes statistics about item collections, if any, #' that were modified during the operation are returned in the response. If #' set to `NONE` (the default), no statistics are returned. #' @param ConditionExpression A condition that must be satisfied in order for a conditional #' [`delete_item`][dynamodb_delete_item] to succeed. -#' +#' #' An expression can contain any of the following: -#' +#' #' - Functions: #' `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size` -#' +#' #' These function names are case-sensitive. -#' +#' #' - Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN ` -#' +#' #' - Logical operators: `AND | OR | NOT` -#' +#' #' For more information about condition expressions, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information on expression attribute names, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeValues One or more values that can be substituted in an expression. -#' +#' #' Use the **:** (colon) character in an expression to dereference an #' attribute value. For example, suppose that you wanted to check whether #' the value of the *ProductStatus* attribute was one of the following: -#' +#' #' `Available | Backordered | Discontinued` -#' +#' #' You would first need to specify `ExpressionAttributeValues` as follows: -#' +#' #' `{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }` -#' +#' #' You could then use these values in an expression, such as this: -#' +#' #' `ProductStatus IN (:avail, :back, :disc)` -#' +#' #' For more information on expression attribute values, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -1081,7 +1081,7 @@ dynamodb_enable_kinesis_streaming_destination <- function(TableName, StreamArn) #' used. #' @param NextToken Set this value to get remaining results, if `NextToken` was returned in #' the statement response. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param Limit The maximum number of items to evaluate (not necessarily the number of #' matching items). If DynamoDB processes the number of items up to the #' limit while processing the results, it stops the operation and returns @@ -1162,13 +1162,13 @@ dynamodb_execute_transaction <- function(TransactStatements, ClientRequestToken #' @param ClientToken Providing a `ClientToken` makes the call to #' `ExportTableToPointInTimeInput` idempotent, meaning that multiple #' identical calls have the same effect as one single call. -#' +#' #' A client token is valid for 8 hours after the first request that uses it #' is completed. After 8 hours, any request with the same client token is #' treated as a new request. Do not resubmit the same request with the same #' client token for more than 8 hours, or the result might not be #' idempotent. -#' +#' #' If you submit a request with the same client token but a change in other #' parameters within the 8-hour idempotency window, DynamoDB returns an #' `IdempotentParameterMismatch` exception. @@ -1179,9 +1179,9 @@ dynamodb_execute_transaction <- function(TransactStatements, ClientRequestToken #' exported snapshot. #' @param S3SseAlgorithm Type of encryption used on the bucket where export data will be stored. #' Valid values for `S3SseAlgorithm` are: -#' +#' #' - `AES256` - server-side encryption with Amazon S3 managed keys -#' +#' #' - `KMS` - server-side encryption with KMS managed keys #' @param S3SseKmsKeyId The ID of the KMS managed key used to encrypt the S3 bucket where export #' data will be stored (if applicable). @@ -1219,7 +1219,7 @@ dynamodb_export_table_to_point_in_time <- function(TableArn, ExportTime = NULL, #' @param TableName [required] The name of the table containing the requested item. #' @param Key [required] A map of attribute names to `AttributeValue` objects, representing the #' primary key of the item to retrieve. -#' +#' #' For the primary key, you must provide all of the attributes. For #' example, with a simple primary key, you only need to provide a value for #' the partition key. For a composite primary key, you must provide values @@ -1231,52 +1231,52 @@ dynamodb_export_table_to_point_in_time <- function(TableArn, ExportTime = NULL, #' @param ConsistentRead Determines the read consistency model: If set to `true`, then the #' operation uses strongly consistent reads; otherwise, the operation uses #' eventually consistent reads. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ProjectionExpression A string that identifies one or more attributes to retrieve from the #' table. These attributes can include scalars, sets, or elements of a JSON #' document. The attributes in the expression must be separated by commas. -#' +#' #' If no attribute names are specified, then all attributes are returned. #' If any of the requested attributes are not found, they do not appear in #' the result. -#' +#' #' For more information, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information on expression attribute names, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -1321,14 +1321,14 @@ dynamodb_get_item <- function(TableName, Key, AttributesToGet = NULL, Consistent #' [`list_backups`][dynamodb_list_backups] operation in order to fetch the #' next page of results. #' @param BackupType The backups from the table specified by `BackupType` are listed. -#' +#' #' Where `BackupType` can be: -#' +#' #' - `USER` - On-demand backup created by you. (The default setting if no #' other backup types are specified.) -#' +#' #' - `SYSTEM` - On-demand backup automatically created by DynamoDB. -#' +#' #' - `ALL` - All types of on-demand backups (USER and SYSTEM). #' #' @keywords internal @@ -1426,7 +1426,7 @@ dynamodb_list_exports <- function(TableArn = NULL, MaxResults = NULL, NextToken #' @param ExclusiveStartGlobalTableName The first global table name that this operation will evaluate. #' @param Limit The maximum number of table names to return, if the parameter is not #' specified DynamoDB defaults to 100. -#' +#' #' If the number of global tables DynamoDB finds reaches this limit, it #' stops the operation and returns the table names collected up to that #' point, with a table name in the `LastEvaluatedGlobalTableName` to apply @@ -1532,24 +1532,24 @@ dynamodb_list_tags_of_resource <- function(ResourceArn, NextToken = NULL) { #' @param Item [required] A map of attribute name/value pairs, one for each attribute. Only the #' primary key attributes are required; you can optionally provide other #' attribute name-value pairs for the item. -#' +#' #' You must provide all of the attributes for the primary key. For example, #' with a simple primary key, you only need to provide a value for the #' partition key. For a composite primary key, you must provide both values #' for both the partition key and the sort key. -#' +#' #' If you specify any attributes that are part of an index key, then the #' data types for those attributes must match those of the schema in the #' table's attribute definition. -#' +#' #' Empty String and Binary attribute values are allowed. Attribute values #' of type String and Binary must have a length greater than zero if the #' attribute is used as a key attribute for a table or index. -#' +#' #' For more information about primary keys, see [Primary #' Key](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey) #' in the *Amazon DynamoDB Developer Guide*. -#' +#' #' Each element in the `Item` map is an `AttributeValue` object. #' @param Expected This is a legacy parameter. Use `ConditionExpression` instead. For more #' information, see @@ -1559,25 +1559,25 @@ dynamodb_list_tags_of_resource <- function(ResourceArn, NextToken = NULL) { #' appeared before they were updated with the #' [`put_item`][dynamodb_put_item] request. For #' [`put_item`][dynamodb_put_item], the valid values are: -#' +#' #' - `NONE` - If `ReturnValues` is not specified, or if its value is #' `NONE`, then nothing is returned. (This setting is the default for #' `ReturnValues`.) -#' +#' #' - `ALL_OLD` - If [`put_item`][dynamodb_put_item] overwrote an #' attribute name-value pair, then the content of the old item is #' returned. -#' +#' #' The values returned are strongly consistent. -#' +#' #' There is no additional cost associated with requesting a return value #' aside from the small network and processing overhead of receiving a #' larger response. No read capacity units are consumed. -#' +#' #' The `ReturnValues` parameter is used by several DynamoDB operations; #' however, [`put_item`][dynamodb_put_item] does not recognize any values #' other than `NONE` or `ALL_OLD`. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ReturnItemCollectionMetrics Determines whether item collection metrics are returned. If set to #' `SIZE`, the response includes statistics about item collections, if any, #' that were modified during the operation are returned in the response. If @@ -1588,74 +1588,74 @@ dynamodb_list_tags_of_resource <- function(ResourceArn, NextToken = NULL) { #' in the *Amazon DynamoDB Developer Guide*. #' @param ConditionExpression A condition that must be satisfied in order for a conditional #' [`put_item`][dynamodb_put_item] operation to succeed. -#' +#' #' An expression can contain any of the following: -#' +#' #' - Functions: #' `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size` -#' +#' #' These function names are case-sensitive. -#' +#' #' - Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN ` -#' +#' #' - Logical operators: `AND | OR | NOT` -#' +#' #' For more information on condition expressions, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information on expression attribute names, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeValues One or more values that can be substituted in an expression. -#' +#' #' Use the **:** (colon) character in an expression to dereference an #' attribute value. For example, suppose that you wanted to check whether #' the value of the *ProductStatus* attribute was one of the following: -#' +#' #' `Available | Backordered | Discontinued` -#' +#' #' You would first need to specify `ExpressionAttributeValues` as follows: -#' +#' #' `{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }` -#' +#' #' You could then use these values in an expression, such as this: -#' +#' #' `ProductStatus IN (:avail, :back, :disc)` -#' +#' #' For more information on expression attribute values, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -1696,38 +1696,38 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' attributes, specific item attributes, the count of matching items, or in #' the case of an index, some or all of the attributes projected into the #' index. -#' +#' #' - `ALL_ATTRIBUTES` - Returns all of the item attributes from the #' specified table or index. If you query a local secondary index, then #' for each matching item in the index, DynamoDB fetches the entire #' item from the parent table. If the index is configured to project #' all item attributes, then all of the data can be obtained from the #' local secondary index, and no fetching is required. -#' +#' #' - `ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. #' Retrieves all attributes that have been projected into the index. If #' the index is configured to project all attributes, this return value #' is equivalent to specifying `ALL_ATTRIBUTES`. -#' +#' #' - `COUNT` - Returns the number of matching items, rather than the #' matching items themselves. -#' +#' #' - `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in #' `ProjectionExpression`. This return value is equivalent to #' specifying `ProjectionExpression` without specifying any value for #' `Select`. -#' +#' #' If you query or scan a local secondary index and request only #' attributes that are projected into that index, the operation will #' read only the index and not the table. If any of the requested #' attributes are not projected into the local secondary index, #' DynamoDB fetches each of these attributes from the parent table. #' This extra fetching incurs additional throughput cost and latency. -#' +#' #' If you query or scan a global secondary index, you can only request #' attributes that are projected into the index. Global secondary index #' queries cannot fetch attributes from the parent table. -#' +#' #' If neither `Select` nor `ProjectionExpression` are specified, DynamoDB #' defaults to `ALL_ATTRIBUTES` when accessing a table, and #' `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both @@ -1735,7 +1735,7 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is #' equivalent to specifying `ProjectionExpression` without any value for #' `Select`.) -#' +#' #' If you use the `ProjectionExpression` parameter, then the value for #' `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` #' will return an error. @@ -1758,7 +1758,7 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' @param ConsistentRead Determines the read consistency model: If set to `true`, then the #' operation uses strongly consistent reads; otherwise, the operation uses #' eventually consistent reads. -#' +#' #' Strongly consistent reads are not supported on global secondary indexes. #' If you query a global secondary index with `ConsistentRead` set to #' `true`, you will receive a `ValidationException`. @@ -1777,13 +1777,13 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' @param ScanIndexForward Specifies the order for index traversal: If `true` (default), the #' traversal is performed in ascending order; if `false`, the traversal is #' performed in descending order. -#' +#' #' Items with the same partition key value are stored in sorted order by #' sort key. If the sort key data type is Number, the results are stored in #' numeric order. For type String, the results are stored in order of UTF-8 #' bytes. For type Binary, DynamoDB treats each byte of the binary data as #' unsigned. -#' +#' #' If `ScanIndexForward` is `true`, DynamoDB returns the results in the #' order in which they are stored (by sort key value). This is the default #' behavior. If `ScanIndexForward` is `false`, DynamoDB reads the results @@ -1792,18 +1792,18 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' @param ExclusiveStartKey The primary key of the first item that this operation will evaluate. Use #' the value that was returned for `LastEvaluatedKey` in the previous #' operation. -#' +#' #' The data type for `ExclusiveStartKey` must be String, Number, or Binary. #' No set data types are allowed. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ProjectionExpression A string that identifies one or more attributes to retrieve from the #' table. These attributes can include scalars, sets, or elements of a JSON #' document. The attributes in the expression must be separated by commas. -#' +#' #' If no attribute names are specified, then all attributes will be #' returned. If any of the requested attributes are not found, they will #' not appear in the result. -#' +#' #' For more information, see [Accessing Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -1811,88 +1811,88 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' [`query`][dynamodb_query] operation, but before the data is returned to #' you. Items that do not satisfy the `FilterExpression` criteria are not #' returned. -#' +#' #' A `FilterExpression` does not allow key attributes. You cannot define a #' filter expression based on a partition key or a sort key. -#' +#' #' A `FilterExpression` is applied after the items have already been read; #' the process of filtering does not consume any additional read capacity #' units. -#' +#' #' For more information, see [Filter #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.FilterExpression) #' in the *Amazon DynamoDB Developer Guide*. #' @param KeyConditionExpression The condition that specifies the key values for items to be retrieved by #' the [`query`][dynamodb_query] action. -#' +#' #' The condition must perform an equality test on a single partition key #' value. -#' +#' #' The condition can optionally perform one of several comparison tests on #' a single sort key value. This allows [`query`][dynamodb_query] to #' retrieve one item with a given partition key value and sort key value, #' or several items that have the same partition key value but different #' sort key values. -#' +#' #' The partition key equality test is required, and must be specified in #' the following format: -#' +#' #' `partitionKeyName` *=* `:partitionkeyval` -#' +#' #' If you also want to provide a condition for the sort key, it must be #' combined using `AND` with the condition for the sort key. Following is #' an example, using the **=** comparison operator for the sort key: -#' +#' #' `partitionKeyName` `=` `:partitionkeyval` `AND` `sortKeyName` `=` #' `:sortkeyval` -#' +#' #' Valid comparisons for the sort key condition are as follows: -#' +#' #' - `sortKeyName` `=` `:sortkeyval` - true if the sort key value is #' equal to `:sortkeyval`. -#' +#' #' - `sortKeyName` `<` `:sortkeyval` - true if the sort key value is less #' than `:sortkeyval`. -#' +#' #' - `sortKeyName` `<=` `:sortkeyval` - true if the sort key value is #' less than or equal to `:sortkeyval`. -#' +#' #' - `sortKeyName` `>` `:sortkeyval` - true if the sort key value is #' greater than `:sortkeyval`. -#' +#' #' - `sortKeyName` `>= ` `:sortkeyval` - true if the sort key value is #' greater than or equal to `:sortkeyval`. -#' +#' #' - `sortKeyName` `BETWEEN` `:sortkeyval1` `AND` `:sortkeyval2` - true #' if the sort key value is greater than or equal to `:sortkeyval1`, #' and less than or equal to `:sortkeyval2`. -#' +#' #' - `begins_with (` `sortKeyName`, `:sortkeyval` `)` - true if the sort #' key value begins with a particular operand. (You cannot use this #' function with a sort key that is of type Number.) Note that the #' function name `begins_with` is case-sensitive. -#' +#' #' Use the `ExpressionAttributeValues` parameter to replace tokens such as #' `:partitionval` and `:sortval` with actual values at runtime. -#' +#' #' You can optionally use the `ExpressionAttributeNames` parameter to #' replace the names of the partition key and sort key with placeholder #' tokens. This option might be necessary if an attribute name conflicts #' with a DynamoDB reserved word. For example, the following #' `KeyConditionExpression` parameter causes an error because *Size* is a #' reserved word: -#' +#' #' - `Size = :myval` -#' +#' #' To work around this, define a placeholder (such a `#S`) to represent the #' attribute name *Size*. `KeyConditionExpression` then is as follows: -#' +#' #' - `#S = :myval` -#' +#' #' For a list of reserved words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*. -#' +#' #' For more information on `ExpressionAttributeNames` and #' `ExpressionAttributeValues`, see [Using Placeholders for Attribute Names #' and @@ -1900,57 +1900,57 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information on expression attribute names, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeValues One or more values that can be substituted in an expression. -#' +#' #' Use the **:** (colon) character in an expression to dereference an #' attribute value. For example, suppose that you wanted to check whether #' the value of the *ProductStatus* attribute was one of the following: -#' +#' #' `Available | Backordered | Discontinued` -#' +#' #' You would first need to specify `ExpressionAttributeValues` as follows: -#' +#' #' `{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }` -#' +#' #' You could then use these values in an expression, such as this: -#' +#' #' `ProductStatus IN (:avail, :back, :disc)` -#' +#' #' For more information on expression attribute values, see [Specifying #' Conditions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -2093,38 +2093,38 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' attributes, specific item attributes, the count of matching items, or in #' the case of an index, some or all of the attributes projected into the #' index. -#' +#' #' - `ALL_ATTRIBUTES` - Returns all of the item attributes from the #' specified table or index. If you query a local secondary index, then #' for each matching item in the index, DynamoDB fetches the entire #' item from the parent table. If the index is configured to project #' all item attributes, then all of the data can be obtained from the #' local secondary index, and no fetching is required. -#' +#' #' - `ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. #' Retrieves all attributes that have been projected into the index. If #' the index is configured to project all attributes, this return value #' is equivalent to specifying `ALL_ATTRIBUTES`. -#' +#' #' - `COUNT` - Returns the number of matching items, rather than the #' matching items themselves. -#' +#' #' - `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in #' `ProjectionExpression`. This return value is equivalent to #' specifying `ProjectionExpression` without specifying any value for #' `Select`. -#' +#' #' If you query or scan a local secondary index and request only #' attributes that are projected into that index, the operation reads #' only the index and not the table. If any of the requested attributes #' are not projected into the local secondary index, DynamoDB fetches #' each of these attributes from the parent table. This extra fetching #' incurs additional throughput cost and latency. -#' +#' #' If you query or scan a global secondary index, you can only request #' attributes that are projected into the index. Global secondary index #' queries cannot fetch attributes from the parent table. -#' +#' #' If neither `Select` nor `ProjectionExpression` are specified, DynamoDB #' defaults to `ALL_ATTRIBUTES` when accessing a table, and #' `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both @@ -2132,7 +2132,7 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is #' equivalent to specifying `ProjectionExpression` without any value for #' `Select`.) -#' +#' #' If you use the `ProjectionExpression` parameter, then the value for #' `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` #' will return an error. @@ -2147,15 +2147,15 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' @param ExclusiveStartKey The primary key of the first item that this operation will evaluate. Use #' the value that was returned for `LastEvaluatedKey` in the previous #' operation. -#' +#' #' The data type for `ExclusiveStartKey` must be String, Number or Binary. #' No set data types are allowed. -#' +#' #' In a parallel scan, a [`scan`][dynamodb_scan] request that includes #' `ExclusiveStartKey` must specify the same segment whose previous #' [`scan`][dynamodb_scan] returned the corresponding value of #' `LastEvaluatedKey`. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param TotalSegments For a parallel [`scan`][dynamodb_scan] request, `TotalSegments` #' represents the total number of segments into which the #' [`scan`][dynamodb_scan] operation will be divided. The value of @@ -2163,38 +2163,38 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' will perform the parallel scan. For example, if you want to use four #' application threads to scan a table or an index, specify a #' `TotalSegments` value of 4. -#' +#' #' The value for `TotalSegments` must be greater than or equal to 1, and #' less than or equal to 1000000. If you specify a `TotalSegments` value of #' 1, the [`scan`][dynamodb_scan] operation will be sequential rather than #' parallel. -#' +#' #' If you specify `TotalSegments`, you must also specify `Segment`. #' @param Segment For a parallel [`scan`][dynamodb_scan] request, `Segment` identifies an #' individual segment to be scanned by an application worker. -#' +#' #' Segment IDs are zero-based, so the first segment is always 0. For #' example, if you want to use four application threads to scan a table or #' an index, then the first thread specifies a `Segment` value of 0, the #' second thread specifies 1, and so on. -#' +#' #' The value of `LastEvaluatedKey` returned from a parallel #' [`scan`][dynamodb_scan] request must be used as `ExclusiveStartKey` with #' the same segment ID in a subsequent [`scan`][dynamodb_scan] operation. -#' +#' #' The value for `Segment` must be greater than or equal to 0, and less #' than the value provided for `TotalSegments`. -#' +#' #' If you provide `Segment`, you must also provide `TotalSegments`. #' @param ProjectionExpression A string that identifies one or more attributes to retrieve from the #' specified table or index. These attributes can include scalars, sets, or #' elements of a JSON document. The attributes in the expression must be #' separated by commas. -#' +#' #' If no attribute names are specified, then all attributes will be #' returned. If any of the requested attributes are not found, they will #' not appear in the result. -#' +#' #' For more information, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -2202,86 +2202,86 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' [`scan`][dynamodb_scan] operation, but before the data is returned to #' you. Items that do not satisfy the `FilterExpression` criteria are not #' returned. -#' +#' #' A `FilterExpression` is applied after the items have already been read; #' the process of filtering does not consume any additional read capacity #' units. -#' +#' #' For more information, see [Filter #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.FilterExpression) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*). To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information on expression attribute names, see [Specifying Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeValues One or more values that can be substituted in an expression. -#' +#' #' Use the **:** (colon) character in an expression to dereference an #' attribute value. For example, suppose that you wanted to check whether #' the value of the `ProductStatus` attribute was one of the following: -#' +#' #' `Available | Backordered | Discontinued` -#' +#' #' You would first need to specify `ExpressionAttributeValues` as follows: -#' +#' #' `{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }` -#' +#' #' You could then use these values in an expression, such as this: -#' +#' #' `ProductStatus IN (:avail, :back, :disc)` -#' +#' #' For more information on expression attribute values, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ConsistentRead A Boolean value that determines the read consistency model during the #' scan: -#' +#' #' - If `ConsistentRead` is `false`, then the data returned from #' [`scan`][dynamodb_scan] might not contain the results from other #' recently completed write operations #' ([`put_item`][dynamodb_put_item], #' [`update_item`][dynamodb_update_item], or #' [`delete_item`][dynamodb_delete_item]). -#' +#' #' - If `ConsistentRead` is `true`, then all of the write operations that #' completed before the [`scan`][dynamodb_scan] began are guaranteed to #' be contained in the [`scan`][dynamodb_scan] response. -#' +#' #' The default setting for `ConsistentRead` is `false`. -#' +#' #' The `ConsistentRead` parameter is not supported on global secondary #' indexes. If you scan a global secondary index with `ConsistentRead` set #' to true, you will receive a `ValidationException`. @@ -2385,7 +2385,7 @@ dynamodb_transact_get_items <- function(TransactItems, ReturnConsumedCapacity = #' can operate on items in different tables, but the tables must reside in #' the same Amazon Web Services account and Region, and no two of them can #' operate on the same item. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ReturnItemCollectionMetrics Determines whether item collection metrics are returned. If set to #' `SIZE`, the response includes statistics about item collections (if #' any), that were modified during the operation and are returned in the @@ -2394,7 +2394,7 @@ dynamodb_transact_get_items <- function(TransactItems, ReturnConsumedCapacity = #' [`transact_write_items`][dynamodb_transact_write_items] idempotent, #' meaning that multiple identical calls have the same effect as one single #' call. -#' +#' #' Although multiple identical calls using the same client request token #' produce the same result on the server (no side effects), the responses #' to the calls might not be the same. If the `ReturnConsumedCapacity>` @@ -2404,13 +2404,13 @@ dynamodb_transact_get_items <- function(TransactItems, ReturnConsumedCapacity = #' Subsequent [`transact_write_items`][dynamodb_transact_write_items] calls #' with the same client token return the number of read capacity units #' consumed in reading the item. -#' +#' #' A client request token is valid for 10 minutes after the first request #' that uses it is completed. After 10 minutes, any request with the same #' client token is treated as a new request. Do not resubmit the same #' request with the same client token for more than 10 minutes, or the #' result might not be idempotent. -#' +#' #' If you submit a request with the same client token but a change in other #' parameters within the 10-minute idempotency window, DynamoDB returns an #' `IdempotentParameterMismatch` exception. @@ -2571,11 +2571,11 @@ dynamodb_update_global_table <- function(GlobalTableName, ReplicaUpdates) { #' @param GlobalTableBillingMode The billing mode of the global table. If `GlobalTableBillingMode` is not #' specified, the global table defaults to `PROVISIONED` capacity billing #' mode. -#' +#' #' - `PROVISIONED` - We recommend using `PROVISIONED` for predictable #' workloads. `PROVISIONED` sets the billing mode to [Provisioned #' Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). -#' +#' #' - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for #' unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to #' [On-Demand @@ -2620,7 +2620,7 @@ dynamodb_update_global_table_settings <- function(GlobalTableName, GlobalTableBi #' @param TableName [required] The name of the table containing the item to update. #' @param Key [required] The primary key of the item to be updated. Each element consists of an #' attribute name and a value for that attribute. -#' +#' #' For the primary key, you must provide all of the attributes. For #' example, with a simple primary key, you only need to provide a value for #' the partition key. For a composite primary key, you must provide values @@ -2640,73 +2640,73 @@ dynamodb_update_global_table_settings <- function(GlobalTableName, GlobalTableBi #' @param ReturnValues Use `ReturnValues` if you want to get the item attributes as they appear #' before or after they are updated. For #' [`update_item`][dynamodb_update_item], the valid values are: -#' +#' #' - `NONE` - If `ReturnValues` is not specified, or if its value is #' `NONE`, then nothing is returned. (This setting is the default for #' `ReturnValues`.) -#' +#' #' - `ALL_OLD` - Returns all of the attributes of the item, as they #' appeared before the UpdateItem operation. -#' +#' #' - `UPDATED_OLD` - Returns only the updated attributes, as they #' appeared before the UpdateItem operation. -#' +#' #' - `ALL_NEW` - Returns all of the attributes of the item, as they #' appear after the UpdateItem operation. -#' +#' #' - `UPDATED_NEW` - Returns only the updated attributes, as they appear #' after the UpdateItem operation. -#' +#' #' There is no additional cost associated with requesting a return value #' aside from the small network and processing overhead of receiving a #' larger response. No read capacity units are consumed. -#' +#' #' The values returned are strongly consistent. -#' @param ReturnConsumedCapacity +#' @param ReturnConsumedCapacity #' @param ReturnItemCollectionMetrics Determines whether item collection metrics are returned. If set to #' `SIZE`, the response includes statistics about item collections, if any, #' that were modified during the operation are returned in the response. If #' set to `NONE` (the default), no statistics are returned. #' @param UpdateExpression An expression that defines one or more attributes to be updated, the #' action to be performed on them, and new values for them. -#' +#' #' The following action values are available for `UpdateExpression`. -#' +#' #' - `SET` - Adds one or more attributes and values to an item. If any of #' these attributes already exist, they are replaced by the new values. #' You can also use `SET` to add or subtract from an attribute that is #' of type Number. For example: `SET myNum = myNum + :val` -#' +#' #' `SET` supports the following functions: -#' +#' #' - `if_not_exists (path, operand)` - if the item does not contain #' an attribute at the specified path, then `if_not_exists` #' evaluates to operand; otherwise, it evaluates to path. You can #' use this function to avoid overwriting an attribute that may #' already be present in the item. -#' +#' #' - `list_append (operand, operand)` - evaluates to a list with a #' new element added to it. You can append the new element to the #' start or the end of the list by reversing the order of the #' operands. -#' +#' #' These function names are case-sensitive. -#' +#' #' - `REMOVE` - Removes one or more attributes from an item. -#' +#' #' - `ADD` - Adds the specified value to the item, if the attribute does #' not already exist. If the attribute does exist, then the behavior of #' `ADD` depends on the data type of the attribute: -#' +#' #' - If the existing attribute is a number, and if `Value` is also a #' number, then `Value` is mathematically added to the existing #' attribute. If `Value` is a negative number, then it is #' subtracted from the existing attribute. -#' +#' #' If you use `ADD` to increment or decrement a number value for an #' item that doesn't exist before the update, DynamoDB uses `0` as #' the initial value. -#' +#' #' Similarly, if you use `ADD` for an existing item to increment or #' decrement an attribute value that doesn't exist before the #' update, DynamoDB uses `0` as the initial value. For example, @@ -2716,7 +2716,7 @@ dynamodb_update_global_table_settings <- function(GlobalTableName, GlobalTableBi #' `itemcount` attribute, set its initial value to `0`, and finally #' add `3` to it. The result will be a new `itemcount` attribute in #' the item, with a value of `3`. -#' +#' #' - If the existing data type is a set and if `Value` is also a set, #' then `Value` is added to the existing set. For example, if the #' attribute value is the set `[1,2]`, and the `ADD` action @@ -2724,103 +2724,103 @@ dynamodb_update_global_table_settings <- function(GlobalTableName, GlobalTableBi #' error occurs if an `ADD` action is specified for a set attribute #' and the attribute type specified does not match the existing set #' type. -#' +#' #' Both sets must have the same primitive data type. For example, #' if the existing data type is a set of strings, the `Value` must #' also be a set of strings. -#' +#' #' The `ADD` action only supports Number and set data types. In #' addition, `ADD` can only be used on top-level attributes, not nested #' attributes. -#' +#' #' - `DELETE` - Deletes an element from a set. -#' +#' #' If a set of values is specified, then those values are subtracted #' from the old set. For example, if the attribute value was the set #' `[a,b,c]` and the `DELETE` action specifies `[a,c]`, then the final #' attribute value is `[b]`. Specifying an empty set is an error. -#' +#' #' The `DELETE` action only supports set data types. In addition, #' `DELETE` can only be used on top-level attributes, not nested #' attributes. -#' +#' #' You can have many actions in a single expression, such as the following: #' `SET a=:value1, b=:value2 DELETE :value3, :value4, :value5` -#' +#' #' For more information on update expressions, see [Modifying Items and #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ConditionExpression A condition that must be satisfied in order for a conditional update to #' succeed. -#' +#' #' An expression can contain any of the following: -#' +#' #' - Functions: #' `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size` -#' +#' #' These function names are case-sensitive. -#' +#' #' - Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN ` -#' +#' #' - Logical operators: `AND | OR | NOT` -#' +#' #' For more information about condition expressions, see [Specifying #' Conditions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeNames One or more substitution tokens for attribute names in an expression. #' The following are some use cases for using `ExpressionAttributeNames`: -#' +#' #' - To access an attribute whose name conflicts with a DynamoDB reserved #' word. -#' +#' #' - To create a placeholder for repeating occurrences of an attribute #' name in an expression. -#' +#' #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. -#' -#' Use the **\#** character in an expression to dereference an attribute +#' +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: -#' +#' #' - `Percentile` -#' +#' #' The name of this attribute conflicts with a reserved word, so it cannot #' be used directly in an expression. (For the complete list of reserved #' words, see [Reserved #' Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) #' in the *Amazon DynamoDB Developer Guide*.) To work around this, you #' could specify the following for `ExpressionAttributeNames`: -#' +#' #' - `{"#P":"Percentile"}` -#' +#' #' You could then use this substitution in an expression, as in this #' example: -#' +#' #' - `#P = :val` -#' +#' #' Tokens that begin with the **:** character are *expression attribute #' values*, which are placeholders for the actual value at runtime. -#' +#' #' For more information about expression attribute names, see [Specifying #' Item #' Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param ExpressionAttributeValues One or more values that can be substituted in an expression. -#' +#' #' Use the **:** (colon) character in an expression to dereference an #' attribute value. For example, suppose that you wanted to check whether #' the value of the `ProductStatus` attribute was one of the following: -#' +#' #' `Available | Backordered | Discontinued` -#' +#' #' You would first need to specify `ExpressionAttributeValues` as follows: -#' +#' #' `{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }` -#' +#' #' You could then use these values in an expression, such as this: -#' +#' #' `ProductStatus IN (:avail, :back, :disc)` -#' +#' #' For more information on expression attribute values, see [Condition #' Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) #' in the *Amazon DynamoDB Developer Guide*. @@ -2863,11 +2863,11 @@ dynamodb_update_item <- function(TableName, Key, AttributeUpdates = NULL, Expect #' provisioned capacity values are estimated based on the consumed read and #' write capacity of your table and global secondary indexes over the past #' 30 minutes. -#' +#' #' - `PROVISIONED` - We recommend using `PROVISIONED` for predictable #' workloads. `PROVISIONED` sets the billing mode to [Provisioned #' Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). -#' +#' #' - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for #' unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to #' [On-Demand @@ -2876,29 +2876,29 @@ dynamodb_update_item <- function(TableName, Key, AttributeUpdates = NULL, Expect #' index. #' @param GlobalSecondaryIndexUpdates An array of one or more global secondary indexes for the table. For each #' index in the array, you can request one action: -#' +#' #' - `Create` - add a new global secondary index to the table. -#' +#' #' - `Update` - modify the provisioned throughput settings of an existing #' global secondary index. -#' +#' #' - `Delete` - remove a global secondary index from the table. -#' +#' #' You can create or delete only one global secondary index per #' [`update_table`][dynamodb_update_table] operation. -#' +#' #' For more information, see [Managing Global Secondary #' Indexes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html) #' in the *Amazon DynamoDB Developer Guide*. #' @param StreamSpecification Represents the DynamoDB Streams configuration for the table. -#' +#' #' You receive a `ResourceInUseException` if you try to enable a stream on #' a table that already has a stream, or if you try to disable a stream on #' a table that doesn't have a stream. #' @param SSESpecification The new server-side encryption settings for the specified table. #' @param ReplicaUpdates A list of replica update actions (create, delete, or update) for the #' table. -#' +#' #' This property only applies to [Version #' 2019.11.21](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) #' of global tables. @@ -2935,7 +2935,7 @@ dynamodb_update_table <- function(AttributeDefinitions = NULL, TableName, Billin #' @param GlobalSecondaryIndexUpdates Represents the auto scaling settings of the global secondary indexes of #' the replica to be updated. #' @param TableName [required] The name of the global table to be updated. -#' @param ProvisionedWriteCapacityAutoScalingUpdate +#' @param ProvisionedWriteCapacityAutoScalingUpdate #' @param ReplicaUpdates Represents the auto scaling settings of replicas of the table that will #' be modified. #' diff --git a/cran/paws.database/R/elasticache_operations.R b/cran/paws.database/R/elasticache_operations.R index b432aac59f..d910fdd07a 100644 --- a/cran/paws.database/R/elasticache_operations.R +++ b/cran/paws.database/R/elasticache_operations.R @@ -15,7 +15,7 @@ NULL #' `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or #' `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`. #' ElastiCache resources are *cluster* and *snapshot*. -#' +#' #' For more information about ARNs, see [Amazon Resource Names (ARNs) and #' Amazon Service #' Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -183,13 +183,13 @@ elasticache_complete_migration <- function(ReplicationGroupId, Force = NULL) { #' ElastiCache or an Amazon S3 bucket if exporting. #' @param TargetBucket The Amazon S3 bucket to which the snapshot is exported. This parameter #' is used only when exporting a snapshot for external access. -#' +#' #' When using this parameter to export a snapshot, be sure Amazon #' ElastiCache has the needed permissions to this S3 bucket. For more #' information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 #' Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) #' in the *Amazon ElastiCache User Guide*. -#' +#' #' For more information, see [Exporting a #' Snapshot](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) #' in the *Amazon ElastiCache User Guide*. @@ -226,174 +226,174 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' #' @param CacheClusterId [required] The node group (shard) identifier. This parameter is stored as a #' lowercase string. -#' +#' #' **Constraints:** -#' +#' #' - A name must contain from 1 to 50 alphanumeric characters or hyphens. -#' +#' #' - The first character must be a letter. -#' +#' #' - A name cannot end with a hyphen or contain two consecutive hyphens. #' @param ReplicationGroupId The ID of the replication group to which this cluster should belong. If #' this parameter is specified, the cluster is added to the specified #' replication group as a read replica; otherwise, the cluster is a #' standalone primary that is not part of any replication group. -#' +#' #' If the specified replication group is Multi-AZ enabled and the #' Availability Zone is not specified, the cluster is created in #' Availability Zones that provide the best spread of read replicas across #' Availability Zones. -#' +#' #' This parameter is only valid if the `Engine` parameter is `redis`. #' @param AZMode Specifies whether the nodes in this Memcached cluster are created in a #' single Availability Zone or created across multiple Availability Zones #' in the cluster's region. -#' +#' #' This parameter is only supported for Memcached clusters. -#' +#' #' If the `AZMode` and `PreferredAvailabilityZones` are not specified, #' ElastiCache assumes `single-az` mode. #' @param PreferredAvailabilityZone The EC2 Availability Zone in which the cluster is created. -#' +#' #' All nodes belonging to this cluster are placed in the preferred #' Availability Zone. If you want to create your nodes across multiple #' Availability Zones, use `PreferredAvailabilityZones`. -#' +#' #' Default: System chosen Availability Zone. #' @param PreferredAvailabilityZones A list of the Availability Zones in which cache nodes are created. The #' order of the zones in the list is not important. -#' +#' #' This option is only supported on Memcached. -#' +#' #' If you are creating your cluster in an Amazon VPC (recommended) you can #' only locate nodes in Availability Zones that are associated with the #' subnets in the selected subnet group. -#' +#' #' The number of Availability Zones listed must equal the value of #' `NumCacheNodes`. -#' +#' #' If you want all the nodes in the same Availability Zone, use #' `PreferredAvailabilityZone` instead, or repeat the Availability Zone #' multiple times in the list. -#' +#' #' Default: System chosen Availability Zones. #' @param NumCacheNodes The initial number of cache nodes that the cluster has. -#' +#' #' For clusters running Redis, this value must be 1. For clusters running #' Memcached, this value must be between 1 and 40. -#' +#' #' If you need more than 40 nodes for your Memcached cluster, please fill #' out the ElastiCache Limit Increase Request form at #' http://aws.amazon.com/contact-us/elasticache-node-limit-request/. #' @param CacheNodeType The compute and memory capacity of the nodes in the node group (shard). -#' +#' #' The following node types are supported by ElastiCache. Generally #' speaking, the current generation types provide more memory and #' computational power at lower cost when compared to their equivalent #' previous generation counterparts. -#' +#' #' - General purpose: -#' +#' #' - Current generation: -#' +#' #' **M6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward): #' `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, #' `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, #' `cache.m6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, #' `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, #' `cache.m5.24xlarge` -#' +#' #' **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, #' `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` -#' +#' #' **T4g node types** (available only for Redis engine version #' 5.0.6 onward and Memcached engine version 1.5.16 onward): #' `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` -#' +#' #' **T3 node types:** `cache.t3.micro`, `cache.t3.small`, #' `cache.t3.medium` -#' +#' #' **T2 node types:** `cache.t2.micro`, `cache.t2.small`, #' `cache.t2.medium` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **T1 node types:** `cache.t1.micro` -#' +#' #' **M1 node types:** `cache.m1.small`, `cache.m1.medium`, #' `cache.m1.large`, `cache.m1.xlarge` -#' +#' #' **M3 node types:** `cache.m3.medium`, `cache.m3.large`, #' `cache.m3.xlarge`, `cache.m3.2xlarge` -#' +#' #' - Compute optimized: -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **C1 node types:** `cache.c1.xlarge` -#' +#' #' - Memory optimized: -#' +#' #' - Current generation: -#' +#' #' **R6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward). -#' +#' #' `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, #' `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, #' `cache.r6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, #' `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, #' `cache.r5.24xlarge` -#' +#' #' **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, #' `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, #' `cache.r4.16xlarge` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, #' `cache.m2.4xlarge` -#' +#' #' **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, #' `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` -#' +#' #' **Additional node type info** -#' +#' #' - All current generation instance types are created in Amazon VPC by #' default. -#' +#' #' - Redis append-only files (AOF) are not supported for T1 or T2 #' instances. -#' +#' #' - Redis Multi-AZ with automatic failover is not supported on T1 #' instances. -#' +#' #' - Redis configuration variables `appendonly` and `appendfsync` are not #' supported on Redis version 2.8.22 and later. #' @param Engine The name of the cache engine to be used for this cluster. -#' +#' #' Valid values for this parameter are: `memcached` | `redis` #' @param EngineVersion The version number of the cache engine to be used for this cluster. To #' view the supported cache engine versions, use the #' DescribeCacheEngineVersions operation. -#' +#' #' **Important:** You can upgrade to a newer engine version (see [Selecting #' a Cache Engine and #' Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), @@ -405,20 +405,20 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' engine is used. You cannot use any parameter group which has #' `cluster-enabled='yes'` when creating a cluster. #' @param CacheSubnetGroupName The name of the subnet group to be used for the cluster. -#' +#' #' Use this parameter only when you are creating a cluster in an Amazon #' Virtual Private Cloud (Amazon VPC). -#' +#' #' If you're going to launch your cluster in an Amazon VPC, you need to #' create a subnet group before you start creating a cluster. For more #' information, see [Subnets and Subnet #' Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). #' @param CacheSecurityGroupNames A list of security group names to associate with this cluster. -#' +#' #' Use this parameter only when you are creating a cluster outside of an #' Amazon Virtual Private Cloud (Amazon VPC). #' @param SecurityGroupIds One or more VPC security groups associated with the cluster. -#' +#' #' Use this parameter only when you are creating a cluster in an Amazon #' Virtual Private Cloud (Amazon VPC). #' @param Tags A list of tags to be added to this resource. @@ -426,14 +426,14 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. #' The snapshot file is used to populate the node group (shard). The Amazon #' S3 object name in the ARN cannot contain any commas. -#' +#' #' This parameter is only valid if the `Engine` parameter is `redis`. -#' +#' #' Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb` #' @param SnapshotName The name of a Redis snapshot from which to restore data into the new #' node group (shard). The snapshot status changes to `restoring` while the #' new node group (shard) is being created. -#' +#' #' This parameter is only valid if the `Engine` parameter is `redis`. #' @param PreferredMaintenanceWindow Specifies the weekly time range during which maintenance on the cluster #' is performed. It is specified as a range in the format @@ -442,7 +442,7 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' @param Port The port number on which each of the cache nodes accepts connections. #' @param NotificationTopicArn The Amazon Resource Name (ARN) of the Amazon Simple Notification Service #' (SNS) topic to which notifications are sent. -#' +#' #' The Amazon SNS topic owner must be the same as the cluster owner. #' @param AutoMinorVersionUpgrade  If you are running Redis engine version 6.0 or later, set this #' parameter to yes if you want to opt-in to the next auto minor version @@ -451,34 +451,34 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' before deleting them. For example, if you set `SnapshotRetentionLimit` #' to 5, a snapshot taken today is retained for 5 days before being #' deleted. -#' +#' #' This parameter is only valid if the `Engine` parameter is `redis`. -#' +#' #' Default: 0 (i.e., automatic backups are disabled for this cache #' cluster). #' @param SnapshotWindow The daily time range (in UTC) during which ElastiCache begins taking a #' daily snapshot of your node group (shard). -#' +#' #' Example: `05:00-09:00` -#' +#' #' If you do not specify this parameter, ElastiCache automatically chooses #' an appropriate time range. -#' +#' #' This parameter is only valid if the `Engine` parameter is `redis`. #' @param AuthToken **Reserved parameter.** The password used to access a password protected #' server. -#' +#' #' Password constraints: -#' +#' #' - Must be only printable ASCII characters. -#' +#' #' - Must be at least 16 characters and no more than 128 characters in #' length. -#' -#' - The only permitted printable special characters are !, &, \#, $, ^, +#' +#' - The only permitted printable special characters are !, &, #, $, ^, #' \<, \>, and -. Other printable special characters cannot be used in #' the AUTH token. -#' +#' #' For more information, see [AUTH #' password](https://redis.io/commands/auth/) at #' http://redis.io/commands/AUTH. @@ -491,7 +491,7 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' modify the value of `TransitEncryptionEnabled` after the cluster is #' created. To enable in-transit encryption on a cluster you must set #' `TransitEncryptionEnabled` to true when you create a cluster. -#' +#' #' **Required:** Only available when creating a cache cluster in an Amazon #' VPC using Memcached version `1.6.12` or later. #' @@ -525,7 +525,7 @@ elasticache_create_cache_cluster <- function(CacheClusterId, ReplicationGroupId #' @param CacheParameterGroupName [required] A user-specified name for the cache parameter group. #' @param CacheParameterGroupFamily [required] The name of the cache parameter group family that the cache parameter #' group can be used with. -#' +#' #' Valid values are: `memcached1.4` | `memcached1.5` | `memcached1.6` | #' `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | #' `redis6.x` @@ -562,10 +562,10 @@ elasticache_create_cache_parameter_group <- function(CacheParameterGroupName, Ca #' #' @param CacheSecurityGroupName [required] A name for the cache security group. This value is stored as a lowercase #' string. -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters. #' Cannot be the word "Default". -#' +#' #' Example: `mysecuritygroup` #' @param Description [required] A description for the cache security group. #' @param Tags A list of tags to be added to this resource. A tag is a key-value pair. @@ -600,10 +600,10 @@ elasticache_create_cache_security_group <- function(CacheSecurityGroupName, Desc #' #' @param CacheSubnetGroupName [required] A name for the cache subnet group. This value is stored as a lowercase #' string. -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters or #' hyphens. -#' +#' #' Example: `mysubnetgroup` #' @param CacheSubnetGroupDescription [required] A description for the cache subnet group. #' @param SubnetIds [required] A list of VPC subnet IDs for the cache subnet group. @@ -645,7 +645,7 @@ elasticache_create_cache_subnet_group <- function(CacheSubnetGroupName, CacheSub #' suffix name you provide. The suffix, combined with the auto-generated #' prefix, guarantees uniqueness of the Global datastore name across #' multiple regions. -#' +#' #' For a full list of Amazon Regions and their respective Global datastore #' iD prefixes, see [Using the Amazon CLI with Global #' datastores](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html) @@ -684,64 +684,64 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' #' @param ReplicationGroupId [required] The replication group identifier. This parameter is stored as a #' lowercase string. -#' +#' #' Constraints: -#' +#' #' - A name must contain from 1 to 40 alphanumeric characters or hyphens. -#' +#' #' - The first character must be a letter. -#' +#' #' - A name cannot end with a hyphen or contain two consecutive hyphens. #' @param ReplicationGroupDescription [required] A user-created description for the replication group. #' @param GlobalReplicationGroupId The name of the Global datastore #' @param PrimaryClusterId The identifier of the cluster that serves as the primary for this #' replication group. This cluster must already exist and have a status of #' `available`. -#' +#' #' This parameter is not required if `NumCacheClusters`, `NumNodeGroups`, #' or `ReplicasPerNodeGroup` is specified. #' @param AutomaticFailoverEnabled Specifies whether a read-only replica is automatically promoted to #' read/write primary if the existing primary fails. -#' +#' #' `AutomaticFailoverEnabled` must be enabled for Redis (cluster mode #' enabled) replication groups. -#' +#' #' Default: false #' @param MultiAZEnabled A flag indicating if you have Multi-AZ enabled to enhance fault #' tolerance. For more information, see [Minimizing Downtime: #' Multi-AZ](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). #' @param NumCacheClusters The number of clusters this replication group initially has. -#' +#' #' This parameter is not used if there is more than one node group (shard). #' You should use `ReplicasPerNodeGroup` instead. -#' +#' #' If `AutomaticFailoverEnabled` is `true`, the value of this parameter #' must be at least 2. If `AutomaticFailoverEnabled` is `false` you can #' omit this parameter (it will default to 1), or you can explicitly set it #' to a value between 2 and 6. -#' +#' #' The maximum permitted value for `NumCacheClusters` is 6 (1 primary plus #' 5 replicas). #' @param PreferredCacheClusterAZs A list of EC2 Availability Zones in which the replication group's #' clusters are created. The order of the Availability Zones in the list is #' the order in which clusters are allocated. The primary cluster is #' created in the first AZ in the list. -#' +#' #' This parameter is not used if there is more than one node group (shard). #' You should use `NodeGroupConfiguration` instead. -#' +#' #' If you are creating your replication group in an Amazon VPC #' (recommended), you can only locate clusters in Availability Zones #' associated with the subnets in the selected subnet group. -#' +#' #' The number of Availability Zones listed must equal the value of #' `NumCacheClusters`. -#' +#' #' Default: system chosen Availability Zones. #' @param NumNodeGroups An optional parameter that specifies the number of node groups (shards) #' for this Redis (cluster mode enabled) replication group. For Redis #' (cluster mode disabled) either omit this parameter or set it to 1. -#' +#' #' Default: 1 #' @param ReplicasPerNodeGroup An optional parameter that specifies the number of replica nodes in each #' node group (shard). Valid values are 0 to 5. @@ -749,7 +749,7 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' (shard) configuration has the following members: #' `PrimaryAvailabilityZone`, `ReplicaAvailabilityZones`, `ReplicaCount`, #' and `Slots`. -#' +#' #' If you're creating a Redis (cluster mode disabled) or a Redis (cluster #' mode enabled) replication group, you can use this parameter to #' individually configure each node group (shard), or you can omit this @@ -758,116 +758,116 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' (shard) using this parameter because you must specify the slots for each #' node group. #' @param CacheNodeType The compute and memory capacity of the nodes in the node group (shard). -#' +#' #' The following node types are supported by ElastiCache. Generally #' speaking, the current generation types provide more memory and #' computational power at lower cost when compared to their equivalent #' previous generation counterparts. -#' +#' #' - General purpose: -#' +#' #' - Current generation: -#' +#' #' **M6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward): #' `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, #' `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, #' `cache.m6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, #' `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, #' `cache.m5.24xlarge` -#' +#' #' **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, #' `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` -#' +#' #' **T4g node types** (available only for Redis engine version #' 5.0.6 onward and Memcached engine version 1.5.16 onward): #' `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` -#' +#' #' **T3 node types:** `cache.t3.micro`, `cache.t3.small`, #' `cache.t3.medium` -#' +#' #' **T2 node types:** `cache.t2.micro`, `cache.t2.small`, #' `cache.t2.medium` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **T1 node types:** `cache.t1.micro` -#' +#' #' **M1 node types:** `cache.m1.small`, `cache.m1.medium`, #' `cache.m1.large`, `cache.m1.xlarge` -#' +#' #' **M3 node types:** `cache.m3.medium`, `cache.m3.large`, #' `cache.m3.xlarge`, `cache.m3.2xlarge` -#' +#' #' - Compute optimized: -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **C1 node types:** `cache.c1.xlarge` -#' +#' #' - Memory optimized with data tiering: -#' +#' #' - Current generation: -#' +#' #' **R6gd node types** (available only for Redis engine version 6.2 #' onward). -#' +#' #' `cache.r6gd.xlarge`, `cache.r6gd.2xlarge`, `cache.r6gd.4xlarge`, #' `cache.r6gd.8xlarge`, `cache.r6gd.12xlarge`, #' `cache.r6gd.16xlarge` -#' +#' #' - Memory optimized: -#' +#' #' - Current generation: -#' +#' #' **R6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward). -#' +#' #' `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, #' `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, #' `cache.r6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, #' `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, #' `cache.r5.24xlarge` -#' +#' #' **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, #' `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, #' `cache.r4.16xlarge` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, #' `cache.m2.4xlarge` -#' +#' #' **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, #' `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` -#' +#' #' **Additional node type info** -#' +#' #' - All current generation instance types are created in Amazon VPC by #' default. -#' +#' #' - Redis append-only files (AOF) are not supported for T1 or T2 #' instances. -#' +#' #' - Redis Multi-AZ with automatic failover is not supported on T1 #' instances. -#' +#' #' - Redis configuration variables `appendonly` and `appendfsync` are not #' supported on Redis version 2.8.22 and later. #' @param Engine The name of the cache engine to be used for the clusters in this @@ -877,7 +877,7 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' the #' [`describe_cache_engine_versions`][elasticache_describe_cache_engine_versions] #' operation. -#' +#' #' **Important:** You can upgrade to a newer engine version (see [Selecting #' a Cache Engine and #' Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) @@ -888,18 +888,18 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' @param CacheParameterGroupName The name of the parameter group to associate with this replication #' group. If this argument is omitted, the default cache parameter group #' for the specified engine is used. -#' +#' #' If you are running Redis version 3.2.4 or later, only one node group #' (shard), and want to use a default parameter group, we recommend that #' you specify the parameter group by name. -#' +#' #' - To create a Redis (cluster mode disabled) replication group, use #' `CacheParameterGroupName=default.redis3.2`. -#' +#' #' - To create a Redis (cluster mode enabled) replication group, use #' `CacheParameterGroupName=default.redis3.2.cluster.on`. #' @param CacheSubnetGroupName The name of the cache subnet group to be used for the replication group. -#' +#' #' If you're going to launch your cluster in an Amazon VPC, you need to #' create a subnet group before you start creating a cluster. For more #' information, see [Subnets and Subnet @@ -908,7 +908,7 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' group. #' @param SecurityGroupIds One or more Amazon VPC security groups associated with this replication #' group. -#' +#' #' Use this parameter only when you are creating a replication group in an #' Amazon Virtual Private Cloud (Amazon VPC). #' @param Tags A list of tags to be added to this resource. Tags are comma-separated @@ -924,7 +924,7 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' *NumNodeGroups* or the number of node groups configured by #' *NodeGroupConfiguration* regardless of the number of ARNs specified #' here. -#' +#' #' Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb` #' @param SnapshotName The name of a snapshot from which to restore data into the new #' replication group. The snapshot status changes to `restoring` while the @@ -933,34 +933,34 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' is performed. It is specified as a range in the format #' ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window #' is a 60 minute period. Valid values for `ddd` are: -#' +#' #' Specifies the weekly time range during which maintenance on the cluster #' is performed. It is specified as a range in the format #' ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window #' is a 60 minute period. -#' +#' #' Valid values for `ddd` are: -#' +#' #' - `sun` -#' +#' #' - `mon` -#' +#' #' - `tue` -#' +#' #' - `wed` -#' +#' #' - `thu` -#' +#' #' - `fri` -#' +#' #' - `sat` -#' +#' #' Example: `sun:23:00-mon:01:30` #' @param Port The port number on which each member of the replication group accepts #' connections. #' @param NotificationTopicArn The Amazon Resource Name (ARN) of the Amazon Simple Notification Service #' (SNS) topic to which notifications are sent. -#' +#' #' The Amazon SNS topic owner must be the same as the cluster owner. #' @param AutoMinorVersionUpgrade  If you are running Redis engine version 6.0 or later, set this #' parameter to yes if you want to opt-in to the next auto minor version @@ -969,68 +969,68 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' before deleting them. For example, if you set `SnapshotRetentionLimit` #' to 5, a snapshot that was taken today is retained for 5 days before #' being deleted. -#' +#' #' Default: 0 (i.e., automatic backups are disabled for this cluster). #' @param SnapshotWindow The daily time range (in UTC) during which ElastiCache begins taking a #' daily snapshot of your node group (shard). -#' +#' #' Example: `05:00-09:00` -#' +#' #' If you do not specify this parameter, ElastiCache automatically chooses #' an appropriate time range. #' @param AuthToken **Reserved parameter.** The password used to access a password protected #' server. -#' +#' #' `AuthToken` can be specified only on replication groups where #' `TransitEncryptionEnabled` is `true`. -#' +#' #' For HIPAA compliance, you must specify `TransitEncryptionEnabled` as #' `true`, an `AuthToken`, and a `CacheSubnetGroup`. -#' +#' #' Password constraints: -#' +#' #' - Must be only printable ASCII characters. -#' +#' #' - Must be at least 16 characters and no more than 128 characters in #' length. -#' -#' - The only permitted printable special characters are !, &, \#, $, ^, +#' +#' - The only permitted printable special characters are !, &, #, $, ^, #' \<, \>, and -. Other printable special characters cannot be used in #' the AUTH token. -#' +#' #' For more information, see [AUTH #' password](https://redis.io/commands/auth/) at #' http://redis.io/commands/AUTH. #' @param TransitEncryptionEnabled A flag that enables in-transit encryption when set to `true`. -#' +#' #' You cannot modify the value of `TransitEncryptionEnabled` after the #' cluster is created. To enable in-transit encryption on a cluster you #' must set `TransitEncryptionEnabled` to `true` when you create a cluster. -#' +#' #' This parameter is valid only if the `Engine` parameter is `redis`, the #' `EngineVersion` parameter is `3.2.6`, `4.x` or later, and the cluster is #' being created in an Amazon VPC. -#' +#' #' If you enable in-transit encryption, you must also specify a value for #' `CacheSubnetGroup`. -#' +#' #' **Required:** Only available when creating a replication group in an #' Amazon VPC using redis version `3.2.6`, `4.x` or later. -#' +#' #' Default: `false` -#' +#' #' For HIPAA compliance, you must specify `TransitEncryptionEnabled` as #' `true`, an `AuthToken`, and a `CacheSubnetGroup`. #' @param AtRestEncryptionEnabled A flag that enables encryption at rest when set to `true`. -#' +#' #' You cannot modify the value of `AtRestEncryptionEnabled` after the #' replication group is created. To enable encryption at rest on a #' replication group you must set `AtRestEncryptionEnabled` to `true` when #' you create the replication group. -#' +#' #' **Required:** Only available when creating a replication group in an #' Amazon VPC using redis version `3.2.6`, `4.x` or later. -#' +#' #' Default: `false` #' @param KmsKeyId The ID of the KMS key used to encrypt the disk in the cluster. #' @param UserGroupIds The user group to associate with the replication group. @@ -1227,15 +1227,15 @@ elasticache_decrease_node_groups_in_global_replication_group <- function(GlobalR #' the number of replica nodes in the replication group. For Redis (cluster #' mode enabled) replication groups, this is the number of replica nodes in #' each of the replication group's node groups. -#' +#' #' The minimum number of replicas in a shard or replication group is: -#' +#' #' - Redis (cluster mode disabled) -#' +#' #' - If Multi-AZ is enabled: 1 -#' +#' #' - If Multi-AZ is not enabled: 0 -#' +#' #' - Redis (cluster mode enabled): 0 (though you will not be able to #' failover to a replica if your primary node fails) #' @param ReplicaConfiguration A list of `ConfigureShard` objects that can be used to configure each @@ -1308,7 +1308,7 @@ elasticache_delete_cache_cluster <- function(CacheClusterId, FinalSnapshotIdenti #' See [https://paws-r.github.io/docs/elasticache/delete_cache_parameter_group.html](https://paws-r.github.io/docs/elasticache/delete_cache_parameter_group.html) for full documentation. #' #' @param CacheParameterGroupName [required] The name of the cache parameter group to delete. -#' +#' #' The specified cache security group must not be associated with any #' clusters. #' @@ -1340,7 +1340,7 @@ elasticache_delete_cache_parameter_group <- function(CacheParameterGroupName) { #' See [https://paws-r.github.io/docs/elasticache/delete_cache_security_group.html](https://paws-r.github.io/docs/elasticache/delete_cache_security_group.html) for full documentation. #' #' @param CacheSecurityGroupName [required] The name of the cache security group to delete. -#' +#' #' You cannot delete the default security group. #' #' @keywords internal @@ -1371,7 +1371,7 @@ elasticache_delete_cache_security_group <- function(CacheSecurityGroupName) { #' See [https://paws-r.github.io/docs/elasticache/delete_cache_subnet_group.html](https://paws-r.github.io/docs/elasticache/delete_cache_subnet_group.html) for full documentation. #' #' @param CacheSubnetGroupName [required] The name of the cache subnet group to delete. -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters or #' hyphens. #' @@ -1565,9 +1565,9 @@ elasticache_delete_user_group <- function(UserGroupId) { #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1609,28 +1609,28 @@ elasticache_describe_cache_clusters <- function(CacheClusterId = NULL, MaxRecord #' #' @param Engine The cache engine to return. Valid values: `memcached` | `redis` #' @param EngineVersion The cache engine version to return. -#' +#' #' Example: `1.4.14` #' @param CacheParameterGroupFamily The name of a specific cache parameter group family to return details #' for. -#' +#' #' Valid values are: `memcached1.4` | `memcached1.5` | `memcached1.6` | #' `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | #' `redis6.x` | `redis6.2` -#' +#' #' Constraints: -#' +#' #' - Must be 1 to 255 alphanumeric characters -#' +#' #' - First character must be a letter -#' +#' #' - Cannot end with a hyphen or contain two consecutive hyphens #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1670,9 +1670,9 @@ elasticache_describe_cache_engine_versions <- function(Engine = NULL, EngineVers #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1709,14 +1709,14 @@ elasticache_describe_cache_parameter_groups <- function(CacheParameterGroupName #' #' @param CacheParameterGroupName [required] The name of a specific cache parameter group to return details for. #' @param Source The parameter types to return. -#' +#' #' Valid values: `user` | `system` | `engine-default` #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1754,9 +1754,9 @@ elasticache_describe_cache_parameters <- function(CacheParameterGroupName, Sourc #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1794,9 +1794,9 @@ elasticache_describe_cache_security_groups <- function(CacheSecurityGroupName = #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1832,16 +1832,16 @@ elasticache_describe_cache_subnet_groups <- function(CacheSubnetGroupName = NULL #' See [https://paws-r.github.io/docs/elasticache/describe_engine_default_parameters.html](https://paws-r.github.io/docs/elasticache/describe_engine_default_parameters.html) for full documentation. #' #' @param CacheParameterGroupFamily [required] The name of the cache parameter group family. -#' +#' #' Valid values are: `memcached1.4` | `memcached1.5` | `memcached1.6` | #' `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | #' `redis6.x` | `redis6.2` #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1882,19 +1882,19 @@ elasticache_describe_engine_default_parameters <- function(CacheParameterGroupFa #' events are returned. #' @param StartTime The beginning of the time interval to retrieve events for, specified in #' ISO 8601 format. -#' +#' #' **Example:** 2017-03-30T07:03:49.555Z #' @param EndTime The end of the time interval for which to retrieve events, specified in #' ISO 8601 format. -#' +#' #' **Example:** 2017-03-30T07:03:49.555Z #' @param Duration The number of minutes worth of events to retrieve. #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -1967,15 +1967,15 @@ elasticache_describe_global_replication_groups <- function(GlobalReplicationGrou #' #' @param ReplicationGroupId The identifier for the replication group to be described. This parameter #' is not case sensitive. -#' +#' #' If you do not specify this parameter, information about all replication #' groups is returned. #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -2016,135 +2016,135 @@ elasticache_describe_replication_groups <- function(ReplicationGroupId = NULL, M #' purchased reservations matching the specified offering identifier. #' @param CacheNodeType The cache node type filter value. Use this parameter to show only those #' reservations matching the specified cache node type. -#' +#' #' The following node types are supported by ElastiCache. Generally #' speaking, the current generation types provide more memory and #' computational power at lower cost when compared to their equivalent #' previous generation counterparts. -#' +#' #' - General purpose: -#' +#' #' - Current generation: -#' +#' #' **M6g node types:** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward): #' `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, #' `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, #' `cache.m6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, #' `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, #' `cache.m5.24xlarge` -#' +#' #' **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, #' `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` -#' +#' #' **T4g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward): #' `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` -#' +#' #' **T3 node types:** `cache.t3.micro`, `cache.t3.small`, #' `cache.t3.medium` -#' +#' #' **T2 node types:** `cache.t2.micro`, `cache.t2.small`, #' `cache.t2.medium` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **T1 node types:** `cache.t1.micro` -#' +#' #' **M1 node types:** `cache.m1.small`, `cache.m1.medium`, #' `cache.m1.large`, `cache.m1.xlarge` -#' +#' #' **M3 node types:** `cache.m3.medium`, `cache.m3.large`, #' `cache.m3.xlarge`, `cache.m3.2xlarge` -#' +#' #' - Compute optimized: -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **C1 node types:** `cache.c1.xlarge` -#' +#' #' - Memory optimized with data tiering: -#' +#' #' - Current generation: -#' +#' #' **R6gd node types** (available only for Redis engine version 6.2 #' onward). -#' +#' #' `cache.r6gd.xlarge`, `cache.r6gd.2xlarge`, `cache.r6gd.4xlarge`, #' `cache.r6gd.8xlarge`, `cache.r6gd.12xlarge`, #' `cache.r6gd.16xlarge` -#' +#' #' - Memory optimized: -#' +#' #' - Current generation: -#' +#' #' **R6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward). -#' +#' #' `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, #' `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, #' `cache.r6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, #' `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, #' `cache.r5.24xlarge` -#' +#' #' **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, #' `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, #' `cache.r4.16xlarge` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, #' `cache.m2.4xlarge` -#' +#' #' **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, #' `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` -#' +#' #' **Additional node type info** -#' +#' #' - All current generation instance types are created in Amazon VPC by #' default. -#' +#' #' - Redis append-only files (AOF) are not supported for T1 or T2 #' instances. -#' +#' #' - Redis Multi-AZ with automatic failover is not supported on T1 #' instances. -#' +#' #' - Redis configuration variables `appendonly` and `appendfsync` are not #' supported on Redis version 2.8.22 and later. #' @param Duration The duration filter value, specified in years or seconds. Use this #' parameter to show only reservations for this duration. -#' +#' #' Valid Values: `1 | 3 | 31536000 | 94608000` #' @param ProductDescription The product description filter value. Use this parameter to show only #' those reservations matching the specified product description. #' @param OfferingType The offering type filter value. Use this parameter to show only the #' available offerings matching the specified offering type. -#' +#' #' Valid values: #' `"Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"` #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -2181,139 +2181,139 @@ elasticache_describe_reserved_cache_nodes <- function(ReservedCacheNodeId = NULL #' @param ReservedCacheNodesOfferingId The offering identifier filter value. Use this parameter to show only #' the available offering that matches the specified reservation #' identifier. -#' +#' #' Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706` #' @param CacheNodeType The cache node type filter value. Use this parameter to show only the #' available offerings matching the specified cache node type. -#' +#' #' The following node types are supported by ElastiCache. Generally #' speaking, the current generation types provide more memory and #' computational power at lower cost when compared to their equivalent #' previous generation counterparts. -#' +#' #' - General purpose: -#' +#' #' - Current generation: -#' +#' #' **M6g node types:** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward) #' `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, #' `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, #' `cache.m6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, #' `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, #' `cache.m5.24xlarge` -#' +#' #' **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, #' `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` -#' +#' #' **T4g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward): #' `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` -#' +#' #' **T3 node types:** `cache.t3.micro`, `cache.t3.small`, #' `cache.t3.medium` -#' +#' #' **T2 node types:** `cache.t2.micro`, `cache.t2.small`, #' `cache.t2.medium` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **T1 node types:** `cache.t1.micro` -#' +#' #' **M1 node types:** `cache.m1.small`, `cache.m1.medium`, #' `cache.m1.large`, `cache.m1.xlarge` -#' +#' #' **M3 node types:** `cache.m3.medium`, `cache.m3.large`, #' `cache.m3.xlarge`, `cache.m3.2xlarge` -#' +#' #' - Compute optimized: -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **C1 node types:** `cache.c1.xlarge` -#' +#' #' - Memory optimized with data tiering: -#' +#' #' - Current generation: -#' +#' #' **R6gd node types** (available only for Redis engine version 6.2 #' onward). -#' +#' #' `cache.r6gd.xlarge`, `cache.r6gd.2xlarge`, `cache.r6gd.4xlarge`, #' `cache.r6gd.8xlarge`, `cache.r6gd.12xlarge`, #' `cache.r6gd.16xlarge` -#' +#' #' - Memory optimized: -#' +#' #' - Current generation: -#' +#' #' **R6g node types** (available only for Redis engine version #' 5.0.6 onward and for Memcached engine version 1.5.16 onward). -#' +#' #' `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, #' `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, #' `cache.r6g.16xlarge` -#' +#' #' For region availability, see [Supported Node #' Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -#' +#' #' **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, #' `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, #' `cache.r5.24xlarge` -#' +#' #' **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, #' `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, #' `cache.r4.16xlarge` -#' +#' #' - Previous generation: (not recommended. Existing clusters are #' still supported but creation of new clusters is not supported #' for these types.) -#' +#' #' **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, #' `cache.m2.4xlarge` -#' +#' #' **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, #' `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` -#' +#' #' **Additional node type info** -#' +#' #' - All current generation instance types are created in Amazon VPC by #' default. -#' +#' #' - Redis append-only files (AOF) are not supported for T1 or T2 #' instances. -#' +#' #' - Redis Multi-AZ with automatic failover is not supported on T1 #' instances. -#' +#' #' - Redis configuration variables `appendonly` and `appendfsync` are not #' supported on Redis version 2.8.22 and later. #' @param Duration Duration filter value, specified in years or seconds. Use this parameter #' to show only reservations for a given duration. -#' +#' #' Valid Values: `1 | 3 | 31536000 | 94608000` #' @param ProductDescription The product description filter value. Use this parameter to show only #' the available offerings matching the specified product description. #' @param OfferingType The offering type filter value. Use this parameter to show only the #' available offerings matching the specified offering type. -#' +#' #' Valid Values: #' `"Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"` #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 100 -#' +#' #' Constraints: minimum 20; maximum 100. #' @param Marker An optional marker returned from a prior request. Use this marker for #' pagination of results from this operation. If this parameter is @@ -2400,9 +2400,9 @@ elasticache_describe_service_updates <- function(ServiceUpdateName = NULL, Servi #' @param MaxRecords The maximum number of records to include in the response. If more #' records exist than the specified `MaxRecords` value, a marker is #' included in the response so that the remaining results can be retrieved. -#' +#' #' Default: 50 -#' +#' #' Constraints: minimum 20; maximum 50. #' @param ShowNodeGroupConfig A Boolean value which if true, the node group (shard) configuration is #' included in the snapshot description. @@ -2699,14 +2699,14 @@ elasticache_increase_replica_count <- function(ReplicationGroupId, NewReplicaCou #' type. ElastiCache uses the cluster id to identify the current node type #' of this cluster and from that to create a list of node types you can #' scale up to. -#' +#' #' You must provide a value for either the `CacheClusterId` or the #' `ReplicationGroupId`. #' @param ReplicationGroupId The name of the replication group want to scale up to a larger node #' type. ElastiCache uses the replication group id to identify the current #' node type being used by this replication group, and from that to create #' a list of node types you can scale up to. -#' +#' #' You must provide a value for either the `CacheClusterId` or the #' `ReplicationGroupId`. #' @@ -2741,7 +2741,7 @@ elasticache_list_allowed_node_type_modifications <- function(CacheClusterId = NU #' list of tags, for example #' `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or #' `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`. -#' +#' #' For more information about ARNs, see [Amazon Resource Names (ARNs) and #' Amazon Web Services Service #' Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -2781,16 +2781,16 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' existing cache nodes, nodes are removed. If the value is equal to the #' number of current cache nodes, any pending add or remove requests are #' canceled. -#' +#' #' If you are removing cache nodes, you must use the `CacheNodeIdsToRemove` #' parameter to provide the IDs of the specific cache nodes to remove. -#' +#' #' For clusters running Redis, this value must be 1. For clusters running #' Memcached, this value must be between 1 and 40. -#' +#' #' Adding or removing Memcached cache nodes can be applied immediately or #' as a pending operation (see `ApplyImmediately`). -#' +#' #' A pending operation to modify the number of cache nodes in a cluster #' during its maintenance window, whether by adding or removing nodes in #' accordance with the scale out architecture, is not queued. The @@ -2816,7 +2816,7 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' difference between the existing number of cache nodes in the cluster or #' pending cache nodes, whichever is greater, and the value of #' `NumCacheNodes` in the request. -#' +#' #' For example: If you have 3 active cache nodes, 7 pending cache nodes, #' and the number of cache nodes in this #' [`modify_cache_cluster`][elasticache_modify_cache_cluster] call is 5, @@ -2824,130 +2824,130 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' @param AZMode Specifies whether the new nodes in this Memcached cluster are all #' created in a single Availability Zone or created across multiple #' Availability Zones. -#' +#' #' Valid values: `single-az` | `cross-az`. -#' +#' #' This option is only supported for Memcached clusters. -#' +#' #' You cannot specify `single-az` if the Memcached cluster already has #' cache nodes in different Availability Zones. If `cross-az` is specified, #' existing Memcached nodes remain in their current Availability Zone. -#' +#' #' Only newly created nodes are located in different Availability Zones. #' @param NewAvailabilityZones This option is only supported on Memcached clusters. -#' +#' #' The list of Availability Zones where the new Memcached cache nodes are #' created. -#' +#' #' This parameter is only valid when `NumCacheNodes` in the request is #' greater than the sum of the number of active cache nodes and the number #' of cache nodes pending creation (which may be zero). The number of #' Availability Zones supplied in this list must match the cache nodes #' being added in this request. -#' +#' #' Scenarios: -#' +#' #' - **Scenario 1:** You have 3 active nodes and wish to add 2 nodes. #' Specify `NumCacheNodes=5` (3 + 2) and optionally specify two #' Availability Zones for the two new nodes. -#' +#' #' - **Scenario 2:** You have 3 active nodes and 2 nodes pending creation #' (from the scenario 1 call) and want to add 1 more node. Specify #' `NumCacheNodes=6` ((3 + 2) + 1) and optionally specify an #' Availability Zone for the new node. -#' +#' #' - **Scenario 3:** You want to cancel all pending operations. Specify #' `NumCacheNodes=3` to cancel all pending operations. -#' +#' #' The Availability Zone placement of nodes pending creation cannot be #' modified. If you wish to cancel any nodes pending creation, add 0 nodes #' by setting `NumCacheNodes` to the number of current nodes. -#' +#' #' If `cross-az` is specified, existing Memcached nodes remain in their #' current Availability Zone. Only newly created nodes can be located in #' different Availability Zones. For guidance on how to move existing #' Memcached nodes to different Availability Zones, see the **Availability #' Zone Considerations** section of [Cache Node Considerations for #' Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html). -#' +#' #' **Impact of new add/remove requests upon pending requests** -#' +#' #' - Scenario-1 -#' +#' #' - Pending Action: Delete -#' +#' #' - New Request: Delete -#' +#' #' - Result: The new delete, pending or immediate, replaces the #' pending delete. -#' +#' #' - Scenario-2 -#' +#' #' - Pending Action: Delete -#' +#' #' - New Request: Create -#' +#' #' - Result: The new create, pending or immediate, replaces the #' pending delete. -#' +#' #' - Scenario-3 -#' +#' #' - Pending Action: Create -#' +#' #' - New Request: Delete -#' +#' #' - Result: The new delete, pending or immediate, replaces the #' pending create. -#' +#' #' - Scenario-4 -#' +#' #' - Pending Action: Create -#' +#' #' - New Request: Create -#' +#' #' - Result: The new create is added to the pending create. -#' +#' #' **Important:** If the new create request is **Apply #' Immediately - Yes**, all creates are performed immediately. If #' the new create request is **Apply Immediately - No**, all #' creates are pending. #' @param CacheSecurityGroupNames A list of cache security group names to authorize on this cluster. This #' change is asynchronously applied as soon as possible. -#' +#' #' You can use this parameter only with clusters that are created outside #' of an Amazon Virtual Private Cloud (Amazon VPC). -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters. Must #' not be "Default". #' @param SecurityGroupIds Specifies the VPC Security Groups associated with the cluster. -#' +#' #' This parameter can be used only with clusters that are created in an #' Amazon Virtual Private Cloud (Amazon VPC). #' @param PreferredMaintenanceWindow Specifies the weekly time range during which maintenance on the cluster #' is performed. It is specified as a range in the format #' ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window #' is a 60 minute period. -#' +#' #' Valid values for `ddd` are: -#' +#' #' - `sun` -#' +#' #' - `mon` -#' +#' #' - `tue` -#' +#' #' - `wed` -#' +#' #' - `thu` -#' +#' #' - `fri` -#' +#' #' - `sat` -#' +#' #' Example: `sun:23:00-mon:01:30` #' @param NotificationTopicArn The Amazon Resource Name (ARN) of the Amazon SNS topic to which #' notifications are sent. -#' +#' #' The Amazon SNS topic owner must be same as the cluster owner. #' @param CacheParameterGroupName The name of the cache parameter group to apply to this cluster. This #' change is asynchronously applied as soon as possible for parameters when @@ -2955,26 +2955,26 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' request. #' @param NotificationTopicStatus The status of the Amazon SNS notification topic. Notifications are sent #' only if the status is `active`. -#' +#' #' Valid values: `active` | `inactive` #' @param ApplyImmediately If `true`, this parameter causes the modifications in this request and #' any pending modifications to be applied, asynchronously and as soon as #' possible, regardless of the `PreferredMaintenanceWindow` setting for the #' cluster. -#' +#' #' If `false`, changes to the cluster are applied on the next maintenance #' reboot, or the next failure reboot, whichever occurs first. -#' +#' #' If you perform a #' [`modify_cache_cluster`][elasticache_modify_cache_cluster] before a #' pending modification is applied, the pending modification is replaced by #' the newer modification. -#' +#' #' Valid values: `true` | `false` -#' +#' #' Default: `false` #' @param EngineVersion The upgraded version of the cache engine to be run on the cache nodes. -#' +#' #' **Important:** You can upgrade to a newer engine version (see [Selecting #' a Cache Engine and #' Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), @@ -2988,7 +2988,7 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' snapshots before deleting them. For example, if you set #' `SnapshotRetentionLimit` to 5, a snapshot that was taken today is #' retained for 5 days before being deleted. -#' +#' #' If the value of `SnapshotRetentionLimit` is set to zero (0), backups are #' turned off. #' @param SnapshotWindow The daily time range (in UTC) during which ElastiCache begins taking a @@ -2997,24 +2997,24 @@ elasticache_list_tags_for_resource <- function(ResourceName) { #' @param AuthToken Reserved parameter. The password used to access a password protected #' server. This parameter must be specified with the `auth-token-update` #' parameter. Password constraints: -#' +#' #' - Must be only printable ASCII characters -#' +#' #' - Must be at least 16 characters and no more than 128 characters in #' length -#' +#' #' - Cannot contain any of the following characters: '/', '"', or '@@', #' '%' -#' +#' #' For more information, see AUTH password at #' [AUTH](https://redis.io/commands/auth/). #' @param AuthTokenUpdateStrategy Specifies the strategy to use to update the AUTH token. This parameter #' must be specified with the `auth-token` parameter. Possible values: -#' +#' #' - Rotate -#' +#' #' - Set -#' +#' #' For more information, see [Authenticating Users with Redis #' AUTH](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) #' @param LogDeliveryConfigurations Specifies the destination, format and type of the logs. @@ -3080,10 +3080,10 @@ elasticache_modify_cache_parameter_group <- function(CacheParameterGroupName, Pa #' #' @param CacheSubnetGroupName [required] The name for the cache subnet group. This value is stored as a lowercase #' string. -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters or #' hyphens. -#' +#' #' Example: `mysubnetgroup` #' @param CacheSubnetGroupDescription A description of the cache subnet group. #' @param SubnetIds The EC2 subnet IDs for the cache subnet group. @@ -3169,50 +3169,50 @@ elasticache_modify_global_replication_group <- function(GlobalReplicationGroupId #' enabled) replication groups. #' @param AutomaticFailoverEnabled Determines whether a read replica is automatically promoted to #' read/write primary if the existing primary encounters a failure. -#' +#' #' Valid values: `true` | `false` #' @param MultiAZEnabled A flag to indicate MultiAZ is enabled. #' @param NodeGroupId Deprecated. This parameter is not used. #' @param CacheSecurityGroupNames A list of cache security group names to authorize for the clusters in #' this replication group. This change is asynchronously applied as soon as #' possible. -#' +#' #' This parameter can be used only with replication group containing #' clusters running outside of an Amazon Virtual Private Cloud (Amazon #' VPC). -#' +#' #' Constraints: Must contain no more than 255 alphanumeric characters. Must #' not be `Default`. #' @param SecurityGroupIds Specifies the VPC Security Groups associated with the clusters in the #' replication group. -#' +#' #' This parameter can be used only with replication group containing #' clusters running in an Amazon Virtual Private Cloud (Amazon VPC). #' @param PreferredMaintenanceWindow Specifies the weekly time range during which maintenance on the cluster #' is performed. It is specified as a range in the format #' ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window #' is a 60 minute period. -#' +#' #' Valid values for `ddd` are: -#' +#' #' - `sun` -#' +#' #' - `mon` -#' +#' #' - `tue` -#' +#' #' - `wed` -#' +#' #' - `thu` -#' +#' #' - `fri` -#' +#' #' - `sat` -#' +#' #' Example: `sun:23:00-mon:01:30` #' @param NotificationTopicArn The Amazon Resource Name (ARN) of the Amazon SNS topic to which #' notifications are sent. -#' +#' #' The Amazon SNS topic owner must be same as the replication group owner. #' @param CacheParameterGroupName The name of the cache parameter group to apply to all of the clusters in #' this replication group. This change is asynchronously applied as soon as @@ -3220,23 +3220,23 @@ elasticache_modify_global_replication_group <- function(GlobalReplicationGroupId #' specified as `true` for this request. #' @param NotificationTopicStatus The status of the Amazon SNS notification topic for the replication #' group. Notifications are sent only if the status is `active`. -#' +#' #' Valid values: `active` | `inactive` #' @param ApplyImmediately If `true`, this parameter causes the modifications in this request and #' any pending modifications to be applied, asynchronously and as soon as #' possible, regardless of the `PreferredMaintenanceWindow` setting for the #' replication group. -#' +#' #' If `false`, changes to the nodes in the replication group are applied on #' the next maintenance reboot, or the next failure reboot, whichever #' occurs first. -#' +#' #' Valid values: `true` | `false` -#' +#' #' Default: `false` #' @param EngineVersion The upgraded version of the cache engine to be run on the clusters in #' the replication group. -#' +#' #' **Important:** You can upgrade to a newer engine version (see [Selecting #' a Cache Engine and #' Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), @@ -3250,15 +3250,15 @@ elasticache_modify_global_replication_group <- function(GlobalReplicationGroupId #' (shard) snapshots before deleting them. For example, if you set #' `SnapshotRetentionLimit` to 5, a snapshot that was taken today is #' retained for 5 days before being deleted. -#' +#' #' **Important** If the value of SnapshotRetentionLimit is set to zero (0), #' backups are turned off. #' @param SnapshotWindow The daily time range (in UTC) during which ElastiCache begins taking a #' daily snapshot of the node group (shard) specified by #' `SnapshottingClusterId`. -#' +#' #' Example: `05:00-09:00` -#' +#' #' If you do not specify this parameter, ElastiCache automatically chooses #' an appropriate time range. #' @param CacheNodeType A valid cache node type that you want to scale this replication group @@ -3266,24 +3266,24 @@ elasticache_modify_global_replication_group <- function(GlobalReplicationGroupId #' @param AuthToken Reserved parameter. The password used to access a password protected #' server. This parameter must be specified with the #' `auth-token-update-strategy ` parameter. Password constraints: -#' +#' #' - Must be only printable ASCII characters -#' +#' #' - Must be at least 16 characters and no more than 128 characters in #' length -#' +#' #' - Cannot contain any of the following characters: '/', '"', or '@@', #' '%' -#' +#' #' For more information, see AUTH password at #' [AUTH](https://redis.io/commands/auth/). #' @param AuthTokenUpdateStrategy Specifies the strategy to use to update the AUTH token. This parameter #' must be specified with the `auth-token` parameter. Possible values: -#' +#' #' - Rotate -#' +#' #' - Set -#' +#' #' For more information, see [Authenticating Users with Redis #' AUTH](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) #' @param UserGroupIdsToAdd The ID of the user group you are associating with the replication group. @@ -3328,28 +3328,28 @@ elasticache_modify_replication_group <- function(ReplicationGroupId, Replication #' the shard configuration. #' @param ApplyImmediately [required] Indicates that the shard reconfiguration process begins immediately. At #' present, the only permitted value for this parameter is `true`. -#' +#' #' Value: true #' @param ReshardingConfiguration Specifies the preferred availability zones for each node group in the #' cluster. If the value of `NodeGroupCount` is greater than the current #' number of node groups (shards), you can use this parameter to specify #' the preferred availability zones of the cluster's shards. If you omit #' this parameter ElastiCache selects availability zones for you. -#' +#' #' You can specify this parameter only if the value of `NodeGroupCount` is #' greater than the current number of node groups (shards). #' @param NodeGroupsToRemove If the value of `NodeGroupCount` is less than the current number of node #' groups (shards), then either `NodeGroupsToRemove` or #' `NodeGroupsToRetain` is required. `NodeGroupsToRemove` is a list of #' `NodeGroupId`s to remove from the cluster. -#' +#' #' ElastiCache for Redis will attempt to remove all node groups listed by #' `NodeGroupsToRemove` from the cluster. #' @param NodeGroupsToRetain If the value of `NodeGroupCount` is less than the current number of node #' groups (shards), then either `NodeGroupsToRemove` or #' `NodeGroupsToRetain` is required. `NodeGroupsToRetain` is a list of #' `NodeGroupId`s to retain in the cluster. -#' +#' #' ElastiCache for Redis will attempt to remove all node groups except #' those listed by `NodeGroupsToRetain` from the cluster. #' @@ -3445,17 +3445,17 @@ elasticache_modify_user_group <- function(UserGroupId, UserIdsToAdd = NULL, User #' See [https://paws-r.github.io/docs/elasticache/purchase_reserved_cache_nodes_offering.html](https://paws-r.github.io/docs/elasticache/purchase_reserved_cache_nodes_offering.html) for full documentation. #' #' @param ReservedCacheNodesOfferingId [required] The ID of the reserved cache node offering to purchase. -#' +#' #' Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706` #' @param ReservedCacheNodeId A customer-specified identifier to track this reservation. -#' +#' #' The Reserved Cache Node ID is an unique customer-specified identifier to #' track this reservation. If this parameter is not specified, ElastiCache #' automatically generates an identifier for the reservation. -#' +#' #' Example: myreservationID #' @param CacheNodeCount The number of cache node instances to reserve. -#' +#' #' Default: `1` #' @param Tags A list of tags to be added to this resource. A tag is a key-value pair. #' A tag key must be accompanied by a tag value, although null is accepted. @@ -3554,7 +3554,7 @@ elasticache_reboot_cache_cluster <- function(CacheClusterId, CacheNodeIdsToReboo #' tags removed, for example #' `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or #' `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`. -#' +#' #' For more information about ARNs, see [Amazon Resource Names (ARNs) and #' Amazon Service #' Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). @@ -3593,7 +3593,7 @@ elasticache_remove_tags_from_resource <- function(ResourceName, TagKeys) { #' @param ResetAllParameters If `true`, all parameters in the cache parameter group are reset to #' their default values. If `false`, only the parameters listed by #' `ParameterNameValues` are reset to their default values. -#' +#' #' Valid values: `true` | `false` #' @param ParameterNameValues An array of parameter names to reset to their default values. If #' `ResetAllParameters` is `true`, do not use `ParameterNameValues`. If diff --git a/cran/paws.database/cran-comments.md b/cran/paws.database/cran-comments.md index 03582c9c42..9219ee5425 100644 --- a/cran/paws.database/cran-comments.md +++ b/cran/paws.database/cran-comments.md @@ -2,17 +2,25 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results There were no ERRORs, or WARNINGs. +Notes: +checking installed package size ... NOTE + installed size is 5.1Mb + sub-directories of 1Mb or more: + R 2.0Mb + help 2.9Mb -Note: New maintainer: Dyfan Jones Old maintainer(s): David Kretch +Maintainer Notes: tarball package size: 662.2K + ## Downstream dependencies All downstream dependencies ('paws') pass R CMD check. diff --git a/cran/paws.database/man/dynamodb_batch_get_item.Rd b/cran/paws.database/man/dynamodb_batch_get_item.Rd index 1cbeef5adf..c58e9e5ca4 100644 --- a/cran/paws.database/man/dynamodb_batch_get_item.Rd +++ b/cran/paws.database/man/dynamodb_batch_get_item.Rd @@ -29,7 +29,7 @@ attribute name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_delete_item.Rd b/cran/paws.database/man/dynamodb_delete_item.Rd index 9fdeb55132..5ecfbc31f7 100644 --- a/cran/paws.database/man/dynamodb_delete_item.Rd +++ b/cran/paws.database/man/dynamodb_delete_item.Rd @@ -90,7 +90,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_get_item.Rd b/cran/paws.database/man/dynamodb_get_item.Rd index f5fb742961..a7dd7e08a6 100644 --- a/cran/paws.database/man/dynamodb_get_item.Rd +++ b/cran/paws.database/man/dynamodb_get_item.Rd @@ -59,7 +59,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_put_item.Rd b/cran/paws.database/man/dynamodb_put_item.Rd index b615067be4..4728d0364c 100644 --- a/cran/paws.database/man/dynamodb_put_item.Rd +++ b/cran/paws.database/man/dynamodb_put_item.Rd @@ -109,7 +109,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_query.Rd b/cran/paws.database/man/dynamodb_query.Rd index c7f1f7ec54..c30cb2ba1b 100644 --- a/cran/paws.database/man/dynamodb_query.Rd +++ b/cran/paws.database/man/dynamodb_query.Rd @@ -251,7 +251,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_scan.Rd b/cran/paws.database/man/dynamodb_scan.Rd index d45fea7139..0d0bbeb1d0 100644 --- a/cran/paws.database/man/dynamodb_scan.Rd +++ b/cran/paws.database/man/dynamodb_scan.Rd @@ -186,7 +186,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/dynamodb_update_item.Rd b/cran/paws.database/man/dynamodb_update_item.Rd index f138b4194a..0c4ed5f2c6 100644 --- a/cran/paws.database/man/dynamodb_update_item.Rd +++ b/cran/paws.database/man/dynamodb_update_item.Rd @@ -184,7 +184,7 @@ name in an expression. misinterpreted in an expression. } -Use the \strong{\#} character in an expression to dereference an attribute +Use the \strong{#} character in an expression to dereference an attribute name. For example, consider the following attribute name: \itemize{ \item \code{Percentile} diff --git a/cran/paws.database/man/elasticache_create_cache_cluster.Rd b/cran/paws.database/man/elasticache_create_cache_cluster.Rd index 2d96663fec..6d66942504 100644 --- a/cran/paws.database/man/elasticache_create_cache_cluster.Rd +++ b/cran/paws.database/man/elasticache_create_cache_cluster.Rd @@ -299,7 +299,7 @@ Password constraints: \item Must be only printable ASCII characters. \item Must be at least 16 characters and no more than 128 characters in length. -\item The only permitted printable special characters are !, &, \#, $, ^, +\item The only permitted printable special characters are !, &, #, $, ^, \<, \>, and -. Other printable special characters cannot be used in the AUTH token. } diff --git a/cran/paws.database/man/elasticache_create_replication_group.Rd b/cran/paws.database/man/elasticache_create_replication_group.Rd index 5a52ef608c..427544f27d 100644 --- a/cran/paws.database/man/elasticache_create_replication_group.Rd +++ b/cran/paws.database/man/elasticache_create_replication_group.Rd @@ -366,7 +366,7 @@ Password constraints: \item Must be only printable ASCII characters. \item Must be at least 16 characters and no more than 128 characters in length. -\item The only permitted printable special characters are !, &, \#, $, ^, +\item The only permitted printable special characters are !, &, #, $, ^, \<, \>, and -. Other printable special characters cannot be used in the AUTH token. } diff --git a/cran/paws.developer.tools/cran-comments.md b/cran/paws.developer.tools/cran-comments.md index a70b65da04..55cce4023b 100644 --- a/cran/paws.developer.tools/cran-comments.md +++ b/cran/paws.developer.tools/cran-comments.md @@ -2,19 +2,20 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) -* win-devel +* win-builder ## R CMD check results There were no ERRORs or WARNINGs. -There was one NOTE: +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Maintainer Notes: tarball package size: 302.9K ## Downstream dependencies -There are no downstream dependencies. +All downstream dependencies ('paws') pass R CMD check. diff --git a/cran/paws.end.user.computing/cran-comments.md b/cran/paws.end.user.computing/cran-comments.md index a70b65da04..f0416dd6fb 100644 --- a/cran/paws.end.user.computing/cran-comments.md +++ b/cran/paws.end.user.computing/cran-comments.md @@ -2,19 +2,21 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) -* win-devel +* win-builder ## R CMD check results There were no ERRORs or WARNINGs. -There was one NOTE: +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch + +Maintainer Notes: tarball package size: 177.7K ## Downstream dependencies -There are no downstream dependencies. +All downstream dependencies ('paws') pass R CMD check. diff --git a/cran/paws.machine.learning/cran-comments.md b/cran/paws.machine.learning/cran-comments.md index 6a6d81b70c..702aa30895 100644 --- a/cran/paws.machine.learning/cran-comments.md +++ b/cran/paws.machine.learning/cran-comments.md @@ -2,16 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no NOTEs, ERRORs, or WARNINGs. +There were no ERRORs or WARNINGs. -There was one Note: -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch + +Maintainer Notes: tarball package size: 576.2K ## Downstream dependencies diff --git a/cran/paws.management/R/licensemanager_operations.R b/cran/paws.management/R/licensemanager_operations.R index b607bab79d..b90a1b38f2 100644 --- a/cran/paws.management/R/licensemanager_operations.R +++ b/cran/paws.management/R/licensemanager_operations.R @@ -263,23 +263,23 @@ licensemanager_create_license <- function(LicenseName, ProductName, ProductSKU, #' @param LicenseCount Number of licenses managed by the license configuration. #' @param LicenseCountHardLimit Indicates whether hard or soft license enforcement is used. Exceeding a #' hard limit blocks the launch of new instances. -#' @param LicenseRules License rules. The syntax is \#name=value (for example, -#' \#allowedTenancy=EC2-DedicatedHost). The available rules vary by +#' @param LicenseRules License rules. The syntax is #name=value (for example, +#' #allowedTenancy=EC2-DedicatedHost). The available rules vary by #' dimension, as follows. -#' +#' #' - `Cores` dimension: `allowedTenancy` | `licenseAffinityToHost` | #' `maximumCores` | `minimumCores` -#' +#' #' - `Instances` dimension: `allowedTenancy` | `maximumCores` | #' `minimumCores` | `maximumSockets` | `minimumSockets` | #' `maximumVcpus` | `minimumVcpus` -#' +#' #' - `Sockets` dimension: `allowedTenancy` | `licenseAffinityToHost` | #' `maximumSockets` | `minimumSockets` -#' +#' #' - `vCPUs` dimension: `allowedTenancy` | `honorVcpuOptimization` | #' `maximumVcpus` | `minimumVcpus` -#' +#' #' The unit for `licenseAffinityToHost` is days and the range is 1 to 180. #' The possible values for `allowedTenancy` are `EC2-Default`, #' `EC2-DedicatedHost`, and `EC2-DedicatedInstance`. The possible values @@ -357,10 +357,10 @@ licensemanager_create_license_conversion_task_for_resource <- function(ResourceA #' #' @param ReportGeneratorName [required] Name of the report generator. #' @param Type [required] Type of reports to generate. The following report types an be generated: -#' +#' #' - License configuration report - Reports the number and details of #' consumed licenses for a license configuration. -#' +#' #' - Resource report - Reports the tracked licenses and resource #' consumption for a license configuration. #' @param ReportContext [required] Defines the type of license configuration the report generator tracks. @@ -925,15 +925,15 @@ licensemanager_list_associations_for_license_configuration <- function(LicenseCo #' #' @param GrantArns Amazon Resource Names (ARNs) of the grants. #' @param Filters Filters to scope the results. The following filters are supported: -#' +#' #' - `LicenseArn` -#' +#' #' - `GrantStatus` -#' +#' #' - `GranteePrincipalARN` -#' +#' #' - `ProductSKU` -#' +#' #' - `LicenseIssuerName` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1001,15 +1001,15 @@ licensemanager_list_failures_for_license_configuration_operations <- function(Li #' @param NextToken Token for the next set of results. #' @param Filters Filters to scope the results. The following filters and logical #' operators are supported: -#' +#' #' - `licenseCountingType` - The dimension for which licenses are #' counted. Possible values are `vCPU` | `Instance` | `Core` | #' `Socket`. Logical operators are `EQUALS` | `NOT_EQUALS`. -#' +#' #' - `enforceLicenseCount` - A Boolean value that indicates whether hard #' license enforcement is used. Logical operators are `EQUALS` | #' `NOT_EQUALS`. -#' +#' #' - `usagelimitExceeded` - A Boolean value that indicates whether the #' available licenses have been exceeded. Logical operators are #' `EQUALS` | `NOT_EQUALS`. @@ -1074,7 +1074,7 @@ licensemanager_list_license_conversion_tasks <- function(NextToken = NULL, MaxRe #' See [https://paws-r.github.io/docs/licensemanager/list_license_manager_report_generators.html](https://paws-r.github.io/docs/licensemanager/list_license_manager_report_generators.html) for full documentation. #' #' @param Filters Filters to scope the results. The following filters are supported: -#' +#' #' - `LicenseConfigurationArn` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1171,13 +1171,13 @@ licensemanager_list_license_versions <- function(LicenseArn, NextToken = NULL, M #' #' @param LicenseArns Amazon Resource Names (ARNs) of the licenses. #' @param Filters Filters to scope the results. The following filters are supported: -#' +#' #' - `Beneficiary` -#' +#' #' - `ProductSKU` -#' +#' #' - `Fingerprint` -#' +#' #' - `Status` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1211,15 +1211,15 @@ licensemanager_list_licenses <- function(LicenseArns = NULL, Filters = NULL, Nex #' #' @param GrantArns Amazon Resource Names (ARNs) of the grants. #' @param Filters Filters to scope the results. The following filters are supported: -#' +#' #' - `ProductSKU` -#' +#' #' - `LicenseIssuerName` -#' +#' #' - `LicenseArn` -#' +#' #' - `GrantStatus` -#' +#' #' - `GranterAccountId` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1253,15 +1253,15 @@ licensemanager_list_received_grants <- function(GrantArns = NULL, Filters = NULL #' #' @param LicenseArns Amazon Resource Names (ARNs) of the licenses. #' @param Filters Filters to scope the results. The following filters are supported: -#' +#' #' - `ProductSKU` -#' +#' #' - `Status` -#' +#' #' - `Fingerprint` -#' +#' #' - `IssuerName` -#' +#' #' - `Beneficiary` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1297,24 +1297,24 @@ licensemanager_list_received_licenses <- function(LicenseArns = NULL, Filters = #' @param NextToken Token for the next set of results. #' @param Filters Filters to scope the results. The following filters and logical #' operators are supported: -#' +#' #' - `account_id` - The ID of the Amazon Web Services account that owns #' the resource. Logical operators are `EQUALS` | `NOT_EQUALS`. -#' +#' #' - `application_name` - The name of the application. Logical operators #' are `EQUALS` | `BEGINS_WITH`. -#' +#' #' - `license_included` - The type of license included. Logical operators #' are `EQUALS` | `NOT_EQUALS`. Possible values are #' `sql-server-enterprise` | `sql-server-standard` | `sql-server-web` | #' `windows-server-datacenter`. -#' +#' #' - `platform` - The platform of the resource. Logical operators are #' `EQUALS` | `BEGINS_WITH`. -#' +#' #' - `resource_id` - The ID of the resource. Logical operators are #' `EQUALS` | `NOT_EQUALS`. -#' +#' #' - `tag:` - The key/value combination of a tag assigned to the #' resource. Logical operators are `EQUALS` (single account) or #' `EQUALS` | `NOT_EQUALS` (cross account). @@ -1377,7 +1377,7 @@ licensemanager_list_tags_for_resource <- function(ResourceArn) { #' #' @param TokenIds Token IDs. #' @param Filters Filters to scope the results. The following filter is supported: -#' +#' #' - `LicenseArns` #' @param NextToken Token for the next set of results. #' @param MaxResults Maximum number of results to return in a single call. @@ -1415,14 +1415,14 @@ licensemanager_list_tokens <- function(TokenIds = NULL, Filters = NULL, NextToke #' @param NextToken Token for the next set of results. #' @param Filters Filters to scope the results. The following filters and logical #' operators are supported: -#' +#' #' - `resourceArn` - The ARN of the license configuration resource. #' Logical operators are `EQUALS` | `NOT_EQUALS`. -#' +#' #' - `resourceType` - The resource type (`EC2_INSTANCE` | `EC2_HOST` | #' `EC2_AMI` | `SYSTEMS_MANAGER_MANAGED_INSTANCE`). Logical operators #' are `EQUALS` | `NOT_EQUALS`. -#' +#' #' - `resourceAccount` - The ID of the account that owns the resource. #' Logical operators are `EQUALS` | `NOT_EQUALS`. #' @@ -1583,10 +1583,10 @@ licensemanager_update_license_configuration <- function(LicenseConfigurationArn, #' @param LicenseManagerReportGeneratorArn [required] Amazon Resource Name (ARN) of the report generator to update. #' @param ReportGeneratorName [required] Name of the report generator. #' @param Type [required] Type of reports to generate. The following report types are supported: -#' +#' #' - License configuration report - Reports the number and details of #' consumed licenses for a license configuration. -#' +#' #' - Resource report - Reports the tracked licenses and resource #' consumption for a license configuration. #' @param ReportContext [required] The report context. diff --git a/cran/paws.management/R/opsworks_operations.R b/cran/paws.management/R/opsworks_operations.R index 9fb620194f..01e801a611 100644 --- a/cran/paws.management/R/opsworks_operations.R +++ b/cran/paws.management/R/opsworks_operations.R @@ -142,26 +142,26 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' @param VpcId The ID of the VPC that the cloned stack is to be launched into. It must #' be in the specified region. All instances are launched into this VPC, #' and you cannot change the ID later. -#' +#' #' - If your account supports EC2 Classic, the default value is no VPC. -#' +#' #' - If your account does not support EC2 Classic, the default value is #' the default VPC for the specified region. -#' +#' #' If the VPC ID corresponds to a default VPC and you have specified either #' the `DefaultAvailabilityZone` or the `DefaultSubnetId` parameter only, #' AWS OpsWorks Stacks infers the value of the other parameter. If you #' specify neither parameter, AWS OpsWorks Stacks sets these parameters to #' the first valid Availability Zone for the specified region and the #' corresponding default VPC subnet ID, respectively. -#' +#' #' If you specify a nondefault VPC ID, note the following: -#' +#' #' - It must belong to a VPC in your account that is in the specified #' region. -#' +#' #' - You must specify a value for `DefaultSubnetId`. -#' +#' #' For more information about how to use AWS OpsWorks Stacks with a VPC, #' see [Running a Stack in a #' VPC](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). @@ -178,7 +178,7 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' [`describe_permissions`][opsworks_describe_permissions]. For more #' information about IAM ARNs, see [Using #' Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html). -#' +#' #' You must set this parameter to a valid service role ARN or the action #' will fail; there is no default value. You can specify the source stack's #' service role ARN, if you prefer, but you must do so explicitly. @@ -187,35 +187,35 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' IAM ARNs, see [Using #' Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html). #' @param DefaultOs The stack's operating system, which must be set to one of the following. -#' +#' #' - A supported Linux operating system: An Amazon Linux version, such as #' `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, #' `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, #' `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or #' `Amazon Linux 2015.03`. -#' +#' #' - A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`, #' `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`. -#' +#' #' - `CentOS Linux 7` -#' +#' #' - `Red Hat Enterprise Linux 7` -#' +#' #' - `Microsoft Windows Server 2012 R2 Base`, #' `Microsoft Windows Server 2012 R2 with SQL Server Express`, #' `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or #' `Microsoft Windows Server 2012 R2 with SQL Server Web`. -#' +#' #' - A custom AMI: `Custom`. You specify the custom AMI you want to use #' when you create instances. For more information about how to use #' custom AMIs with OpsWorks, see [Using Custom #' AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). -#' +#' #' The default option is the parent stack's operating system. For more #' information about supported operating systems, see [AWS OpsWorks Stacks #' Operating #' Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). -#' +#' #' You can specify a different Linux operating system for the cloned stack, #' but you cannot change from Linux to Windows or Windows to Linux. #' @param HostnameTheme The stack's host name theme, with spaces are replaced by underscores. @@ -223,29 +223,29 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' default, `HostnameTheme` is set to `Layer_Dependent`, which creates host #' names by appending integers to the layer's short name. The other themes #' are: -#' +#' #' - `Baked_Goods` -#' +#' #' - `Clouds` -#' +#' #' - `Europe_Cities` -#' +#' #' - `Fruits` -#' +#' #' - `Greek_Deities_and_Titans` -#' +#' #' - `Legendary_creatures_from_Japan` -#' +#' #' - `Planets_and_Moons` -#' +#' #' - `Roman_Deities` -#' +#' #' - `Scottish_Islands` -#' +#' #' - `US_Cities` -#' +#' #' - `Wild_Cats` -#' +#' #' To obtain a generated host name, call `GetHostNameSuggestion`, which #' returns a host name based on the current theme. #' @param DefaultAvailabilityZone The cloned stack's default Availability Zone, which must be in the @@ -263,9 +263,9 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' @param CustomJson A string that contains user-defined, custom JSON. It is used to override #' the corresponding default stack configuration JSON values. The string #' should be in the following format: -#' +#' #' `"{\"key1\": \"value1\", \"key2\": \"value2\",...}"` -#' +#' #' For more information about custom JSON, see [Use Custom JSON to Modify #' the Stack Configuration #' Attributes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) @@ -280,17 +280,17 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' @param UseCustomCookbooks Whether to use custom cookbooks. #' @param UseOpsworksSecurityGroups Whether to associate the AWS OpsWorks Stacks built-in security groups #' with the stack's layers. -#' +#' #' AWS OpsWorks Stacks provides a standard set of built-in security groups, #' one for each layer, which are associated with layers by default. With #' `UseOpsworksSecurityGroups` you can instead provide your own custom #' security groups. `UseOpsworksSecurityGroups` has the following settings: -#' +#' #' - True - AWS OpsWorks Stacks automatically associates the appropriate #' built-in security group with each layer (default setting). You can #' associate additional security groups with a layer after you create #' it but you cannot delete the built-in security group. -#' +#' #' - False - AWS OpsWorks Stacks does not associate built-in security #' groups with layers. You must create appropriate Amazon Elastic #' Compute Cloud (Amazon EC2) security groups and associate a security @@ -298,7 +298,7 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' manually associate a built-in security group with a layer on #' creation; custom security groups are required only for those layers #' that need custom settings. -#' +#' #' For more information, see [Create a New #' Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). #' @param CustomCookbooksSource Contains the information required to retrieve an app or cookbook from a @@ -325,22 +325,22 @@ opsworks_attach_elastic_load_balancer <- function(ElasticLoadBalancerName, Layer #' Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). #' @param AgentVersion The default AWS OpsWorks Stacks agent version. You have the following #' options: -#' +#' #' - Auto-update - Set this parameter to `LATEST`. AWS OpsWorks Stacks #' automatically installs new agent versions on the stack's instances #' as soon as they are available. -#' +#' #' - Fixed version - Set this parameter to your preferred agent version. #' To update the agent version, you must edit the stack configuration #' and specify a new version. AWS OpsWorks Stacks then automatically #' installs that version on the stack's instances. -#' +#' #' The default setting is `LATEST`. To specify an agent version, you must #' use the complete version number, not the abbreviated number shown on the #' console. For a list of available agent version numbers, call #' [`describe_agent_versions`][opsworks_describe_agent_versions]. #' AgentVersion cannot be set to Chef 12.2. -#' +#' #' You can also specify an agent version when you create or update an #' instance, which overrides the stack's default setting. #' @@ -394,14 +394,14 @@ opsworks_clone_stack <- function(SourceStackId, Name = NULL, Region = NULL, VpcI #' variables are defined on the associated app server instance. For more #' information, see [Environment #' Variables](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). -#' +#' #' There is no specific limit on the number of environment variables. #' However, the size of the associated data structure - which includes the #' variables' names, values, and protected flag values - cannot exceed 20 #' KB. This limit should accommodate most if not all use cases. Exceeding #' it will cause an exception with the message, "Environment: is too large #' (maximum is 20KB)." -#' +#' #' If you have specified one or more environment variables, you cannot #' modify the stack's Chef version. #' @@ -443,9 +443,9 @@ opsworks_create_app <- function(StackId, Shortname = NULL, Name, Description = N #' @param CustomJson A string that contains user-defined, custom JSON. You can use this #' parameter to override some corresponding default stack configuration #' JSON values. The string should be in the following format: -#' +#' #' `"{\"key1\": \"value1\", \"key2\": \"value2\",...}"` -#' +#' #' For more information about custom JSON, see [Use Custom JSON to Modify #' the Stack Configuration #' Attributes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) @@ -493,32 +493,32 @@ opsworks_create_deployment <- function(StackId, AppId = NULL, InstanceIds = NULL #' @param Hostname The instance host name. #' @param Os The instance's operating system, which must be set to one of the #' following. -#' +#' #' - A supported Linux operating system: An Amazon Linux version, such as #' `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, #' `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, #' `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or #' `Amazon Linux 2015.03`. -#' +#' #' - A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`, #' `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`. -#' +#' #' - `CentOS Linux 7` -#' +#' #' - `Red Hat Enterprise Linux 7` -#' +#' #' - A supported Windows operating system, such as #' `Microsoft Windows Server 2012 R2 Base`, #' `Microsoft Windows Server 2012 R2 with SQL Server Express`, #' `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or #' `Microsoft Windows Server 2012 R2 with SQL Server Web`. -#' +#' #' - A custom AMI: `Custom`. -#' +#' #' For more information about the supported operating systems, see [AWS #' OpsWorks Stacks Operating #' Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). -#' +#' #' The default option is the current Amazon Linux version. If you set this #' parameter to `Custom`, you must use the #' [`create_instance`][opsworks_create_instance] action's AmiId parameter @@ -533,7 +533,7 @@ opsworks_create_deployment <- function(StackId, AppId = NULL, InstanceIds = NULL #' based on one of the supported operating systems. For more information, #' see [Using Custom #' AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). -#' +#' #' If you specify a custom AMI, you must set `Os` to `Custom`. #' @param SshKeyName The instance's Amazon EC2 key-pair name. #' @param AvailabilityZone The instance Availability Zone. For more information, see [Regions and @@ -562,21 +562,21 @@ opsworks_create_deployment <- function(StackId, AppId = NULL, InstanceIds = NULL #' [`create_deployment`][opsworks_create_deployment] to run the #' `update_dependencies` stack command or by manually running `yum` (Amazon #' Linux) or `apt-get` (Ubuntu) on the instances. -#' +#' #' We strongly recommend using the default value of `true` to ensure that #' your instances have the latest security updates. #' @param EbsOptimized Whether to create an Amazon EBS-optimized instance. #' @param AgentVersion The default AWS OpsWorks Stacks agent version. You have the following #' options: -#' +#' #' - `INHERIT` - Use the stack's default agent version setting. -#' +#' #' - *version_number* - Use the specified agent version. This value #' overrides the stack's default setting. To update the agent version, #' edit the instance configuration and specify a new version. AWS #' OpsWorks Stacks then automatically installs that version on the #' instance. -#' +#' #' The default setting is `INHERIT`. To specify an agent version, you must #' use the complete version number, not the abbreviated number shown on the #' console. For a list of available agent version numbers, call @@ -633,13 +633,13 @@ opsworks_create_instance <- function(StackId, LayerIds, InstanceType, AutoScalin #' recipes. The short name is also used as the name for the directory where #' your app files are installed. It can have a maximum of 200 characters, #' which are limited to the alphanumeric characters, '-', '_', and '.'. -#' +#' #' The built-in layers' short names are defined by AWS OpsWorks Stacks. For #' more information, see the [Layer #' Reference](https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html). #' @param Attributes One or more user-defined key-value pairs to be added to the stack #' attributes. -#' +#' #' To create a cluster layer, set the `EcsClusterArn` attribute to the #' cluster's ARN. #' @param CloudWatchLogsConfiguration Specifies CloudWatch Logs configuration options for the layer. For more @@ -673,7 +673,7 @@ opsworks_create_instance <- function(StackId, LayerIds, InstanceType, AutoScalin #' [`create_deployment`][opsworks_create_deployment] to run the #' `update_dependencies` stack command or by manually running `yum` (Amazon #' Linux) or `apt-get` (Ubuntu) on the instances. -#' +#' #' To ensure that your instances have the latest security updates, we #' strongly recommend using the default value of `true`. #' @param UseEbsOptimizedInstances Whether to use Amazon EBS-optimized instances. @@ -712,7 +712,7 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' @param Region [required] The stack's AWS region, such as `ap-south-1`. For more information about #' Amazon regions, see [Regions and #' Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html). -#' +#' #' In the AWS CLI, this API maps to the `--stack-region` parameter. If the #' `--stack-region` parameter and the AWS CLI common parameter `--region` #' are set to the same value, the stack uses a *regional* endpoint. If the @@ -732,26 +732,26 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' @param VpcId The ID of the VPC that the stack is to be launched into. The VPC must be #' in the stack's region. All instances are launched into this VPC. You #' cannot change the ID later. -#' +#' #' - If your account supports EC2-Classic, the default value is `no VPC`. -#' +#' #' - If your account does not support EC2-Classic, the default value is #' the default VPC for the specified region. -#' +#' #' If the VPC ID corresponds to a default VPC and you have specified either #' the `DefaultAvailabilityZone` or the `DefaultSubnetId` parameter only, #' AWS OpsWorks Stacks infers the value of the other parameter. If you #' specify neither parameter, AWS OpsWorks Stacks sets these parameters to #' the first valid Availability Zone for the specified region and the #' corresponding default VPC subnet ID, respectively. -#' +#' #' If you specify a nondefault VPC ID, note the following: -#' +#' #' - It must belong to a VPC in your account that is in the specified #' region. -#' +#' #' - You must specify a value for `DefaultSubnetId`. -#' +#' #' For more information about how to use AWS OpsWorks Stacks with a VPC, #' see [Running a Stack in a #' VPC](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). @@ -771,30 +771,30 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' @param DefaultOs The stack's default operating system, which is installed on every #' instance unless you specify a different operating system when you create #' the instance. You can specify one of the following. -#' +#' #' - A supported Linux operating system: An Amazon Linux version, such as #' `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, #' `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, #' `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or #' `Amazon Linux 2015.03`. -#' +#' #' - A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`, #' `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`. -#' +#' #' - `CentOS Linux 7` -#' +#' #' - `Red Hat Enterprise Linux 7` -#' +#' #' - A supported Windows operating system, such as #' `Microsoft Windows Server 2012 R2 Base`, #' `Microsoft Windows Server 2012 R2 with SQL Server Express`, #' `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or #' `Microsoft Windows Server 2012 R2 with SQL Server Web`. -#' +#' #' - A custom AMI: `Custom`. You specify the custom AMI you want to use #' when you create instances. For more information, see [Using Custom #' AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). -#' +#' #' The default option is the current Amazon Linux version. For more #' information about supported operating systems, see [AWS OpsWorks Stacks #' Operating @@ -804,29 +804,29 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' default, `HostnameTheme` is set to `Layer_Dependent`, which creates host #' names by appending integers to the layer's short name. The other themes #' are: -#' +#' #' - `Baked_Goods` -#' +#' #' - `Clouds` -#' +#' #' - `Europe_Cities` -#' +#' #' - `Fruits` -#' +#' #' - `Greek_Deities_and_Titans` -#' +#' #' - `Legendary_creatures_from_Japan` -#' +#' #' - `Planets_and_Moons` -#' +#' #' - `Roman_Deities` -#' +#' #' - `Scottish_Islands` -#' +#' #' - `US_Cities` -#' +#' #' - `Wild_Cats` -#' +#' #' To obtain a generated host name, call `GetHostNameSuggestion`, which #' returns a host name based on the current theme. #' @param DefaultAvailabilityZone The stack's default Availability Zone, which must be in the specified @@ -845,9 +845,9 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' override the corresponding default stack configuration attribute values #' or to pass data to recipes. The string should be in the following #' format: -#' +#' #' `"{\"key1\": \"value1\", \"key2\": \"value2\",...}"` -#' +#' #' For more information about custom JSON, see [Use Custom JSON to Modify #' the Stack Configuration #' Attributes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). @@ -862,24 +862,24 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' @param UseCustomCookbooks Whether the stack uses custom cookbooks. #' @param UseOpsworksSecurityGroups Whether to associate the AWS OpsWorks Stacks built-in security groups #' with the stack's layers. -#' +#' #' AWS OpsWorks Stacks provides a standard set of built-in security groups, #' one for each layer, which are associated with layers by default. With #' `UseOpsworksSecurityGroups` you can instead provide your own custom #' security groups. `UseOpsworksSecurityGroups` has the following settings: -#' +#' #' - True - AWS OpsWorks Stacks automatically associates the appropriate #' built-in security group with each layer (default setting). You can #' associate additional security groups with a layer after you create #' it, but you cannot delete the built-in security group. -#' +#' #' - False - AWS OpsWorks Stacks does not associate built-in security #' groups with layers. You must create appropriate EC2 security groups #' and associate a security group with each layer that you create. #' However, you can still manually associate a built-in security group #' with a layer on creation; custom security groups are required only #' for those layers that need custom settings. -#' +#' #' For more information, see [Create a New #' Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). #' @param CustomCookbooksSource Contains the information required to retrieve an app or cookbook from a @@ -905,23 +905,23 @@ opsworks_create_layer <- function(StackId, Type, Name, Shortname, Attributes = N #' Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). #' @param AgentVersion The default AWS OpsWorks Stacks agent version. You have the following #' options: -#' +#' #' - Auto-update - Set this parameter to `LATEST`. AWS OpsWorks Stacks #' automatically installs new agent versions on the stack's instances #' as soon as they are available. -#' +#' #' - Fixed version - Set this parameter to your preferred agent version. #' To update the agent version, you must edit the stack configuration #' and specify a new version. AWS OpsWorks Stacks then automatically #' installs that version on the stack's instances. -#' +#' #' The default setting is the most recent release of the agent. To specify #' an agent version, you must use the complete version number, not the #' abbreviated number shown on the console. For a list of available agent #' version numbers, call #' [`describe_agent_versions`][opsworks_describe_agent_versions]. #' AgentVersion cannot be set to Chef 12.2. -#' +#' #' You can also specify an agent version when you create or update an #' instance, which overrides the stack's default setting. #' @@ -2411,17 +2411,17 @@ opsworks_set_load_based_auto_scaling <- function(LayerId, Enable = NULL, UpScali #' @param AllowSudo The user is allowed to use **sudo** to elevate privileges. #' @param Level The user's permission level, which must be set to one of the following #' strings. You cannot set your own permissions level. -#' +#' #' - `deny` -#' +#' #' - `show` -#' +#' #' - `deploy` -#' +#' #' - `manage` -#' +#' #' - `iam_only` -#' +#' #' For more information about the permissions associated with these levels, #' see [Managing User #' Permissions](https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). @@ -2611,20 +2611,20 @@ opsworks_stop_stack <- function(StackId) { #' @param ResourceArn [required] The stack or layer's Amazon Resource Number (ARN). #' @param Tags [required] A map that contains tag keys and tag values that are attached to a stack #' or layer. -#' +#' #' - The key cannot be empty. -#' +#' #' - The key can be a maximum of 127 characters, and can contain only #' Unicode letters, numbers, or separators, or the following special #' characters: `+ - = . _ : /` -#' +#' #' - The value can be a maximum 255 characters, and contain only Unicode #' letters, numbers, or separators, or the following special #' characters: `+ - = . _ : /` -#' +#' #' - Leading and trailing white spaces are trimmed from both the key and #' value. -#' +#' #' - A maximum of 40 tags is allowed for any resource. #' #' @keywords internal @@ -2760,14 +2760,14 @@ opsworks_untag_resource <- function(ResourceArn, TagKeys) { #' variables are defined on the associated app server instances.For more #' information, see [Environment #' Variables](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). -#' +#' #' There is no specific limit on the number of environment variables. #' However, the size of the associated data structure - which includes the #' variables' names, values, and protected flag values - cannot exceed 20 #' KB. This limit should accommodate most if not all use cases. Exceeding #' it will cause an exception with the message, "Environment: is too large #' (maximum is 20 KB)." -#' +#' #' If you have specified one or more environment variables, you cannot #' modify the stack's Chef version. #' @@ -2842,30 +2842,30 @@ opsworks_update_elastic_ip <- function(ElasticIp, Name = NULL) { #' @param Hostname The instance host name. #' @param Os The instance's operating system, which must be set to one of the #' following. You cannot update an instance that is using a custom AMI. -#' +#' #' - A supported Linux operating system: An Amazon Linux version, such as #' `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, #' `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, #' `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or #' `Amazon Linux 2015.03`. -#' +#' #' - A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`, #' `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`. -#' +#' #' - `CentOS Linux 7` -#' +#' #' - `Red Hat Enterprise Linux 7` -#' +#' #' - A supported Windows operating system, such as #' `Microsoft Windows Server 2012 R2 Base`, #' `Microsoft Windows Server 2012 R2 with SQL Server Express`, #' `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or #' `Microsoft Windows Server 2012 R2 with SQL Server Web`. -#' +#' #' For more information about supported operating systems, see [AWS #' OpsWorks Stacks Operating #' Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). -#' +#' #' The default option is the current Amazon Linux version. If you set this #' parameter to `Custom`, you must use the AmiId parameter to specify the #' custom AMI that you want to use. For more information about supported @@ -2874,7 +2874,7 @@ opsworks_update_elastic_ip <- function(ElasticIp, Name = NULL) { #' For more information about how to use custom AMIs with OpsWorks, see #' [Using Custom #' AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). -#' +#' #' You can specify a different Linux operating system for the updated #' stack, but you cannot change from Linux to Windows or Windows to Linux. #' @param AmiId The ID of the AMI that was used to create the instance. The value of @@ -2894,26 +2894,26 @@ opsworks_update_elastic_ip <- function(ElasticIp, Name = NULL) { #' [`create_deployment`][opsworks_create_deployment] to run the #' `update_dependencies` stack command or by manually running `yum` (Amazon #' Linux) or `apt-get` (Ubuntu) on the instances. -#' +#' #' We strongly recommend using the default value of `true`, to ensure that #' your instances have the latest security updates. #' @param EbsOptimized This property cannot be updated. #' @param AgentVersion The default AWS OpsWorks Stacks agent version. You have the following #' options: -#' +#' #' - `INHERIT` - Use the stack's default agent version setting. -#' +#' #' - *version_number* - Use the specified agent version. This value #' overrides the stack's default setting. To update the agent version, #' you must edit the instance configuration and specify a new version. #' AWS OpsWorks Stacks then automatically installs that version on the #' instance. -#' +#' #' The default setting is `INHERIT`. To specify an agent version, you must #' use the complete version number, not the abbreviated number shown on the #' console. For a list of available agent version numbers, call #' [`describe_agent_versions`][opsworks_describe_agent_versions]. -#' +#' #' AgentVersion cannot be set to Chef 12.2. #' #' @keywords internal @@ -2949,8 +2949,8 @@ opsworks_update_instance <- function(InstanceId, LayerIds = NULL, InstanceType = #' name, which is used internally by AWS OpsWorks Stacks and by Chef. The #' short name is also used as the name for the directory where your app #' files are installed. It can have a maximum of 200 characters and must be -#' in the following format: /\\A\[a-z0-9\\-\\_\\.\]+\\Z/. -#' +#' in the following format: /A\[a-z0-9-_.\]+Z/. +#' #' The built-in layers' short names are defined by AWS OpsWorks Stacks. For #' more information, see the [Layer #' Reference](https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) @@ -2986,11 +2986,11 @@ opsworks_update_instance <- function(InstanceId, LayerIds = NULL, InstanceType = #' [`create_deployment`][opsworks_create_deployment] to run the #' `update_dependencies` stack command or manually running `yum` (Amazon #' Linux) or `apt-get` (Ubuntu) on the instances. -#' +#' #' We strongly recommend using the default value of `true`, to ensure that #' your instances have the latest security updates. #' @param UseEbsOptimizedInstances Whether to use Amazon EBS-optimized instances. -#' @param LifecycleEventConfiguration +#' @param LifecycleEventConfiguration #' #' @keywords internal #' @@ -3088,31 +3088,31 @@ opsworks_update_rds_db_instance <- function(RdsDbInstanceArn, DbUser = NULL, DbP #' stack's EC2 instances. For more information about IAM ARNs, see [Using #' Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html). #' @param DefaultOs The stack's operating system, which must be set to one of the following: -#' +#' #' - A supported Linux operating system: An Amazon Linux version, such as #' `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, #' `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, #' `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or #' `Amazon Linux 2015.03`. -#' +#' #' - A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`, #' `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`. -#' +#' #' - `CentOS Linux 7` -#' +#' #' - `Red Hat Enterprise Linux 7` -#' +#' #' - A supported Windows operating system, such as #' `Microsoft Windows Server 2012 R2 Base`, #' `Microsoft Windows Server 2012 R2 with SQL Server Express`, #' `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or #' `Microsoft Windows Server 2012 R2 with SQL Server Web`. -#' +#' #' - A custom AMI: `Custom`. You specify the custom AMI you want to use #' when you create instances. For more information about how to use #' custom AMIs with OpsWorks, see [Using Custom #' AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). -#' +#' #' The default option is the stack's current operating system. For more #' information about supported operating systems, see [AWS OpsWorks Stacks #' Operating @@ -3122,29 +3122,29 @@ opsworks_update_rds_db_instance <- function(RdsDbInstanceArn, DbUser = NULL, DbP #' default, `HostnameTheme` is set to `Layer_Dependent`, which creates host #' names by appending integers to the layer's short name. The other themes #' are: -#' +#' #' - `Baked_Goods` -#' +#' #' - `Clouds` -#' +#' #' - `Europe_Cities` -#' +#' #' - `Fruits` -#' +#' #' - `Greek_Deities_and_Titans` -#' +#' #' - `Legendary_creatures_from_Japan` -#' +#' #' - `Planets_and_Moons` -#' +#' #' - `Roman_Deities` -#' +#' #' - `Scottish_Islands` -#' +#' #' - `US_Cities` -#' +#' #' - `Wild_Cats` -#' +#' #' To obtain a generated host name, call `GetHostNameSuggestion`, which #' returns a host name based on the current theme. #' @param DefaultAvailabilityZone The stack's default Availability Zone, which must be in the stack's @@ -3162,9 +3162,9 @@ opsworks_update_rds_db_instance <- function(RdsDbInstanceArn, DbUser = NULL, DbP #' @param CustomJson A string that contains user-defined, custom JSON. It can be used to #' override the corresponding default stack configuration JSON values or to #' pass data to recipes. The string should be in the following format: -#' +#' #' `"{\"key1\": \"value1\", \"key2\": \"value2\",...}"` -#' +#' #' For more information about custom JSON, see [Use Custom JSON to Modify #' the Stack Configuration #' Attributes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). @@ -3199,45 +3199,45 @@ opsworks_update_rds_db_instance <- function(RdsDbInstanceArn, DbUser = NULL, DbP #' Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). #' @param UseOpsworksSecurityGroups Whether to associate the AWS OpsWorks Stacks built-in security groups #' with the stack's layers. -#' +#' #' AWS OpsWorks Stacks provides a standard set of built-in security groups, #' one for each layer, which are associated with layers by default. #' `UseOpsworksSecurityGroups` allows you to provide your own custom #' security groups instead of using the built-in groups. #' `UseOpsworksSecurityGroups` has the following settings: -#' +#' #' - True - AWS OpsWorks Stacks automatically associates the appropriate #' built-in security group with each layer (default setting). You can #' associate additional security groups with a layer after you create #' it, but you cannot delete the built-in security group. -#' +#' #' - False - AWS OpsWorks Stacks does not associate built-in security #' groups with layers. You must create appropriate EC2 security groups #' and associate a security group with each layer that you create. #' However, you can still manually associate a built-in security group #' with a layer on. Custom security groups are required only for those #' layers that need custom settings. -#' +#' #' For more information, see [Create a New #' Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). #' @param AgentVersion The default AWS OpsWorks Stacks agent version. You have the following #' options: -#' +#' #' - Auto-update - Set this parameter to `LATEST`. AWS OpsWorks Stacks #' automatically installs new agent versions on the stack's instances #' as soon as they are available. -#' +#' #' - Fixed version - Set this parameter to your preferred agent version. #' To update the agent version, you must edit the stack configuration #' and specify a new version. AWS OpsWorks Stacks then automatically #' installs that version on the stack's instances. -#' +#' #' The default setting is `LATEST`. To specify an agent version, you must #' use the complete version number, not the abbreviated number shown on the #' console. For a list of available agent version numbers, call #' [`describe_agent_versions`][opsworks_describe_agent_versions]. #' AgentVersion cannot be set to Chef 12.2. -#' +#' #' You can also specify an agent version when you create or update an #' instance, which overrides the stack's default setting. #' diff --git a/cran/paws.management/R/ssm_operations.R b/cran/paws.management/R/ssm_operations.R index d92bd0a25d..432105daf7 100644 --- a/cran/paws.management/R/ssm_operations.R +++ b/cran/paws.management/R/ssm_operations.R @@ -11,20 +11,20 @@ NULL #' See [https://paws-r.github.io/docs/ssm/add_tags_to_resource.html](https://paws-r.github.io/docs/ssm/add_tags_to_resource.html) for full documentation. #' #' @param ResourceType [required] Specifies the type of resource you are tagging. -#' +#' #' The `ManagedInstance` type for this API operation is for on-premises #' managed nodes. You must specify the name of the managed node in the #' following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`. #' @param ResourceId [required] The resource ID you want to tag. -#' +#' #' Use the ID of the resource. Here are some examples: -#' +#' #' `MaintenanceWindow`: `mw-012345abcde` -#' +#' #' `PatchBaseline`: `pb-012345abcde` -#' +#' #' `Automation`: `example-c160-4567-8519-012345abcde` -#' +#' #' `OpsMetadata` object: `ResourceID` for tagging is created from the #' Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is #' created from the strings that come after the word `opsmetadata` in the @@ -32,17 +32,17 @@ NULL #' `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` #' has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or #' `/aws/ssm/MyGroup/appmanager`. -#' +#' #' For the `Document` and `Parameter` values, use the name of the resource. -#' +#' #' `ManagedInstance`: `mi-012345abcde` -#' +#' #' The `ManagedInstance` type for this API operation is only for #' on-premises managed nodes. You must specify the name of the managed node #' in the following format: `mi-ID_number `. For example, #' `mi-1a2b3c4d5e6f`. #' @param Tags [required] One or more tags. The value parameter is required. -#' +#' #' Don't enter personally identifiable information in this field. #' #' @keywords internal @@ -79,9 +79,9 @@ ssm_add_tags_to_resource <- function(ResourceType, ResourceId, Tags) { #' types. #' @param ResourceType [required] The type of resource that you want to associate with an OpsItem. #' OpsCenter supports the following types: -#' +#' #' `AWS::SSMIncidents::IncidentRecord`: an Incident Manager incident. -#' +#' #' `AWS::SSM::Document`: a Systems Manager (SSM) document. #' @param ResourceUri [required] The Amazon Resource Name (ARN) of the Amazon Web Services resource that #' you want to associate with the OpsItem. @@ -179,12 +179,12 @@ ssm_cancel_maintenance_window_execution <- function(WindowExecutionId) { #' #' @param Description A user-defined description of the resource that you want to register #' with Systems Manager. -#' +#' #' Don't enter personally identifiable information in this field. #' @param DefaultInstanceName The name of the registered, managed node as it will appear in the Amazon #' Web Services Systems Manager console or when you use the Amazon Web #' Services command line tools to list Systems Manager resources. -#' +#' #' Don't enter personally identifiable information in this field. #' @param IamRole [required] The name of the Identity and Access Management (IAM) role that you want #' to assign to the managed node. This IAM role must provide AssumeRole @@ -205,16 +205,16 @@ ssm_cancel_maintenance_window_execution <- function(WindowExecutionId) { #' identify which servers or virtual machines (VMs) in your on-premises #' environment you intend to activate. In this case, you could specify the #' following key-value pairs: -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' - `Key=Environment,Value=Production` -#' +#' #' When you install SSM Agent on your on-premises servers and VMs, you #' specify an activation ID and code. When you specify the activation ID #' and code, tags assigned to the activation are automatically applied to #' the on-premises servers or VMs. -#' +#' #' You can't add tags to or delete tags from an existing activation. You #' can tag your on-premises servers, edge devices, and VMs after they #' connect to Systems Manager for the first time and are assigned a managed @@ -256,26 +256,26 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' #' @param Name [required] The name of the SSM Command document or Automation runbook that contains #' the configuration information for the managed node. -#' +#' #' You can specify Amazon Web Services-predefined documents, documents you #' created, or a document that is shared with you from another account. -#' +#' #' For Systems Manager documents (SSM documents) that are shared with you #' from other Amazon Web Services accounts, you must specify the complete #' SSM document ARN, in the following format: -#' +#' #' `arn:partition:ssm:region:account-id:document/document-name ` -#' +#' #' For example: -#' +#' #' `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` -#' +#' #' For Amazon Web Services-predefined documents and SSM documents you #' created in your account, you only need to specify the document name. For #' example, `AWS-ApplyPatchBaseline` or `My-Document`. #' @param DocumentVersion The document version you want to associate with the target(s). Can be a #' specific version or the default version. -#' +#' #' State Manager doesn't support running associations that use a new #' version of a document if that document is shared from another account. #' State Manager always runs the `default` version of a document if shared @@ -284,7 +284,7 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' new version of a document shared form another account, you must set the #' document version to `default`. #' @param InstanceId The managed node ID. -#' +#' #' `InstanceId` has been deprecated. To specify a managed node ID for an #' association, use the `Targets` parameter. Requests that include the #' parameter `InstanceID` with Systems Manager documents (SSM documents) @@ -320,7 +320,7 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' is returned. If you run an association on 50 managed nodes and set #' `MaxError` to 10%, then the system stops sending the request when the #' sixth error is received. -#' +#' #' Executions that are already running an association when `MaxErrors` is #' reached are allowed to complete, but some of these executions may fail #' as well. If you need to ensure that there won't be more than max-errors @@ -330,7 +330,7 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' time. You can specify a number, for example 10, or a percentage of the #' target set, for example 10%. The default value is 100%, which means all #' targets run the association at the same time. -#' +#' #' If a new managed node starts and attempts to run an association while #' Systems Manager is running `MaxConcurrency` associations, the #' association is allowed to run. During the next association interval, the @@ -343,13 +343,13 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' association execution runs successfully, then the association is #' `COMPLIANT`. If the association execution doesn't run successfully, the #' association is `NON-COMPLIANT`. -#' +#' #' In `MANUAL` mode, you must specify the `AssociationId` as a parameter #' for the [`put_compliance_items`][ssm_put_compliance_items] API #' operation. In this case, compliance data isn't managed by State Manager. #' It is managed by your direct call to the #' [`put_compliance_items`][ssm_put_compliance_items] API operation. -#' +#' #' By default, all associations use `AUTO` mode. #' @param ApplyOnlyAtCronInterval By default, when you create a new association, the system runs it #' immediately after it is created and then according to the schedule you @@ -373,7 +373,7 @@ ssm_create_activation <- function(Description = NULL, DefaultInstanceName = NULL #' and rate expressions for Systems #' Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' To use offsets, you must specify the `ApplyOnlyAtCronInterval` #' parameter. This option tells the system not to run an association #' immediately after you create it. @@ -440,16 +440,16 @@ ssm_create_association_batch <- function(Entries) { #' @param Content [required] The content for the new SSM document in JSON or YAML format. We #' recommend storing the contents for your new document in an external JSON #' or YAML file and referencing the file in a command. -#' +#' #' For examples, see the following topics in the *Amazon Web Services #' Systems Manager User Guide*. -#' +#' #' - [Create an SSM document (Amazon Web Services #' API)](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) -#' +#' #' - [Create an SSM document (Amazon Web Services #' CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html) -#' +#' #' - [Create an SSM document #' (API)](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) #' @param Requires A list of SSM documents required by a document. This parameter is used @@ -463,14 +463,14 @@ ssm_create_association_batch <- function(Entries) { #' @param Attachments A list of key-value pairs that describe attachments to a version of a #' document. #' @param Name [required] A name for the SSM document. -#' +#' #' You can't use the following strings as document name prefixes. These are #' reserved by Amazon Web Services for use as document name prefixes: -#' +#' #' - `aws-` -#' +#' #' - `amazon` -#' +#' #' - `amzn` #' @param DisplayName An optional field where you can specify a friendly name for the SSM #' document. This value can differ for each version of the document. You @@ -480,7 +480,7 @@ ssm_create_association_batch <- function(Entries) { #' creating with the document. For example, `Release12.1`. This value is #' unique across all versions of a document, and can't be changed. #' @param DocumentType The type of document to create. -#' +#' #' The `DeploymentStrategy` document type is an internal-use-only document #' type reserved for AppConfig. #' @param DocumentFormat Specify the document format for the request. The document format can be @@ -498,11 +498,11 @@ ssm_create_association_batch <- function(Entries) { #' environment. For example, you might want to tag an SSM document to #' identify the types of targets or the environment where it will run. In #' this case, you could specify the following key-value pairs: -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' - `Key=Environment,Value=Production` -#' +#' #' To add tags to an existing SSM document, use the #' [`add_tags_to_resource`][ssm_add_tags_to_resource] operation. #' @@ -552,12 +552,12 @@ ssm_create_document <- function(Content, Requires = NULL, Attachments = NULL, Na #' website. #' @param ScheduleOffset The number of days to wait after the date and time specified by a cron #' expression before running the maintenance window. -#' +#' #' For example, the following cron expression schedules a maintenance #' window to run on the third Tuesday of every month at 11:30 PM. -#' +#' #' `cron(30 23 ? * TUE#3 *)` -#' +#' #' If the schedule offset is `2`, the maintenance window won't run until #' two days later. #' @param Duration [required] The duration of the maintenance window in hours. @@ -567,7 +567,7 @@ ssm_create_document <- function(Content, Requires = NULL, Attachments = NULL, Na #' haven't registered those nodes as targets. If enabled, then you must #' specify the unregistered managed nodes (by node ID) when you register a #' task with the maintenance window. -#' +#' #' If you don't enable this option, then you must specify #' previously-registered targets when you register a task with the #' maintenance window. @@ -578,13 +578,13 @@ ssm_create_document <- function(Content, Requires = NULL, Attachments = NULL, Na #' identify the type of tasks it will run, the types of targets, and the #' environment it will run in. In this case, you could specify the #' following key-value pairs: -#' +#' #' - `Key=TaskType,Value=AgentUpdate` -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' - `Key=Environment,Value=Production` -#' +#' #' To add tags to an existing maintenance window, use the #' [`add_tags_to_resource`][ssm_add_tags_to_resource] operation. #' @@ -623,10 +623,10 @@ ssm_create_maintenance_window <- function(Name, Description = NULL, StartDate = #' strings, license keys, troubleshooting tips, or other relevant data. You #' enter operational data as key-value pairs. The key has a maximum length #' of 128 characters. The value has a maximum size of 20 KB. -#' +#' #' Operational data keys *can't* begin with the following: `amazon`, `aws`, #' `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`. -#' +#' #' You can choose to make the data searchable by other users in the account #' or you can restrict search access. Searchable data means that all users #' with access to the OpsItem Overview page (as provided by the @@ -634,7 +634,7 @@ ssm_create_maintenance_window <- function(Name, Description = NULL, StartDate = #' and search on the specified data. Operational data that isn't searchable #' is only viewable by users who have access to the OpsItem (as provided by #' the [`get_ops_item`][ssm_get_ops_item] API operation). -#' +#' #' Use the `/aws/resources` key in OperationalData to specify a related #' resource in the request. Use the `/aws/automations` key in #' OperationalData to associate an Automation runbook with the OpsItem. To @@ -651,7 +651,7 @@ ssm_create_maintenance_window <- function(Name, Description = NULL, StartDate = #' similar error messages, impacted resources, or statuses for the impacted #' resource. #' @param Source [required] The origin of the OpsItem, such as Amazon EC2 or Systems Manager. -#' +#' #' The source name can't contain the following strings: `aws`, `amazon`, #' and `amzn`. #' @param Title [required] A short heading that describes the nature of the OpsItem and the @@ -661,11 +661,11 @@ ssm_create_maintenance_window <- function(Name, Description = NULL, StartDate = #' information, see [Getting started with #' OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' Tags use a key-value pair. For example: -#' +#' #' `Key=Department,Value=Finance` -#' +#' #' To add tags to a new OpsItem, a user must have IAM permissions for both #' the `ssm:CreateOpsItems` operation and the `ssm:AddTagsToResource` #' operation. To add tags to an existing OpsItem, use the @@ -718,9 +718,9 @@ ssm_create_ops_item <- function(Description, OpsItemType = NULL, OperationalData #' environment. For example, you might want to tag an OpsMetadata object to #' identify an environment or target Amazon Web Services Region. In this #' case, you could specify the following key-value pairs: -#' +#' #' - `Key=Environment,Value=Production` -#' +#' #' - `Key=Region,Value=us-east-2` #' #' @keywords internal @@ -756,7 +756,7 @@ ssm_create_ops_metadata <- function(ResourceId, Metadata = NULL, Tags = NULL) { #' @param GlobalFilters A set of global filters used to include patches in the baseline. #' @param ApprovalRules A set of rules used to include patches in the baseline. #' @param ApprovedPatches A list of explicitly approved patches for the baseline. -#' +#' #' For information about accepted formats for lists of approved patches and #' rejected patches, see [About package name formats for approved and #' rejected patch @@ -769,7 +769,7 @@ ssm_create_ops_metadata <- function(ResourceId, Metadata = NULL, Tags = NULL) { #' updates that should be applied to the managed nodes. The default value #' is `false`. Applies to Linux managed nodes only. #' @param RejectedPatches A list of explicitly rejected patches for the baseline. -#' +#' #' For information about accepted formats for lists of approved patches and #' rejected patches, see [About package name formats for approved and #' rejected patch @@ -777,13 +777,13 @@ ssm_create_ops_metadata <- function(ResourceId, Metadata = NULL, Tags = NULL) { #' in the *Amazon Web Services Systems Manager User Guide*. #' @param RejectedPatchesAction The action for Patch Manager to take on patches included in the #' `RejectedPackages` list. -#' +#' #' - **`ALLOW_AS_DEPENDENCY`** : A package in the `Rejected` patches list #' is installed only if it is a dependency of another package. It is #' considered compliant with the patch baseline, and its status is #' reported as `InstalledOther`. This is the default action if no #' option is specified. -#' +#' #' - **`BLOCK`** : Packages in the `RejectedPatches` list, and packages #' that include them as dependencies, aren't installed under any #' circumstances. If a package was installed before it was added to the @@ -800,11 +800,11 @@ ssm_create_ops_metadata <- function(ResourceId, Metadata = NULL, Tags = NULL) { #' identify the severity level of patches it specifies and the operating #' system family it applies to. In this case, you could specify the #' following key-value pairs: -#' +#' #' - `Key=PatchSeverity,Value=Critical` -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' To add tags to an existing patch baseline, use the #' [`add_tags_to_resource`][ssm_add_tags_to_resource] operation. #' @@ -909,7 +909,7 @@ ssm_delete_activation <- function(ActivationId) { #' #' @param Name The name of the SSM document. #' @param InstanceId The managed node ID. -#' +#' #' `InstanceId` has been deprecated. To specify a managed node ID for an #' association, use the `Targets` parameter. Requests that include the #' parameter `InstanceID` with Systems Manager documents (SSM documents) @@ -993,13 +993,13 @@ ssm_delete_document <- function(Name, DocumentVersion = NULL, VersionName = NULL #' If you don't choose this option, the system only deletes existing #' inventory data associated with the custom inventory type. Choose one of #' the following options: -#' +#' #' DisableSchema: If you choose this option, the system ignores all #' inventory data for the specified version, and any earlier versions. To #' enable this schema again, you must call the #' [`put_inventory`][ssm_put_inventory] operation for a version greater #' than the disabled version. -#' +#' #' DeleteSchema: This option deletes the specified custom type from the #' Inventory service. You can recreate the schema later, if you want. #' @param DryRun Use this option to view a summary of the deletion request without @@ -1416,11 +1416,11 @@ ssm_describe_association <- function(Name = NULL, InstanceId = NULL, Association #' @param ExecutionId [required] The execution ID for which you want to view details. #' @param Filters Filters for the request. You can specify the following filters and #' values. -#' +#' #' Status (EQUAL) -#' +#' #' ResourceId (EQUAL) -#' +#' #' ResourceType (EQUAL) #' @param MaxResults The maximum number of items to return for this call. The call also #' returns a token that you can specify in a subsequent call to get the @@ -1458,11 +1458,11 @@ ssm_describe_association_execution_targets <- function(AssociationId, ExecutionI #' @param AssociationId [required] The association ID for which you want to view execution history details. #' @param Filters Filters for the request. You can specify the following filters and #' values. -#' +#' #' ExecutionId (EQUAL) -#' +#' #' Status (EQUAL) -#' +#' #' CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) #' @param MaxResults The maximum number of items to return for this call. The call also #' returns a token that you can specify in a subsequent call to get the @@ -1572,94 +1572,94 @@ ssm_describe_automation_step_executions <- function(AutomationExecutionId, Filte #' See [https://paws-r.github.io/docs/ssm/describe_available_patches.html](https://paws-r.github.io/docs/ssm/describe_available_patches.html) for full documentation. #' #' @param Filters Each element in the array is a structure containing a key-value pair. -#' +#' #' **Windows Server** -#' +#' #' Supported keys for Windows Server managed node patches include the #' following: -#' +#' #' - **`PATCH_SET`** -#' +#' #' Sample values: `OS` | `APPLICATION` -#' +#' #' - **`PRODUCT`** -#' +#' #' Sample values: `WindowsServer2012` | `Office 2010` | #' `MicrosoftDefenderAntivirus` -#' +#' #' - **`PRODUCT_FAMILY`** -#' +#' #' Sample values: `Windows` | `Office` -#' +#' #' - **`MSRC_SEVERITY`** -#' +#' #' Sample values: `ServicePacks` | `Important` | `Moderate` -#' +#' #' - **`CLASSIFICATION`** -#' +#' #' Sample values: `ServicePacks` | `SecurityUpdates` | #' `DefinitionUpdates` -#' +#' #' - **`PATCH_ID`** -#' +#' #' Sample values: `KB123456` | `KB4516046` -#' +#' #' **Linux** -#' +#' #' When specifying filters for Linux patches, you must specify a key-pair #' for `PRODUCT`. For example, using the Command Line Interface (CLI), the #' following command fails: -#' +#' #' `aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615` -#' +#' #' However, the following command succeeds: -#' +#' #' `aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615` -#' +#' #' Supported keys for Linux managed node patches include the following: -#' +#' #' - **`PRODUCT`** -#' +#' #' Sample values: `AmazonLinux2018.03` | `AmazonLinux2.0` -#' +#' #' - **`NAME`** -#' +#' #' Sample values: `kernel-headers` | `samba-python` | `php` -#' +#' #' - **`SEVERITY`** -#' +#' #' Sample values: `Critical` | `Important` | `Medium` | `Low` -#' +#' #' - **`EPOCH`** -#' +#' #' Sample values: `0` | `1` -#' +#' #' - **`VERSION`** -#' +#' #' Sample values: `78.6.1` | `4.10.16` -#' +#' #' - **`RELEASE`** -#' +#' #' Sample values: `9.56.amzn1` | `1.amzn2` -#' +#' #' - **`ARCH`** -#' +#' #' Sample values: `i686` | `x86_64` -#' +#' #' - **`REPOSITORY`** -#' +#' #' Sample values: `Core` | `Updates` -#' +#' #' - **`ADVISORY_ID`** -#' +#' #' Sample values: `ALAS-2018-1058` | `ALAS2-2021-1594` -#' +#' #' - **`CVE_ID`** -#' +#' #' Sample values: `CVE-2018-3615` | `CVE-2020-1472` -#' +#' #' - **`BUGZILLA_ID`** -#' +#' #' Sample values: `1463241` #' @param MaxResults The maximum number of patches to return (per page). #' @param NextToken The token for the next set of items to return. (You received this token @@ -1870,7 +1870,7 @@ ssm_describe_instance_associations_status <- function(InstanceId, MaxResults = N #' @param InstanceInformationFilterList This is a legacy method. We recommend that you don't use this method. #' Instead, use the `Filters` data type. `Filters` enables you to return #' node information by filtering based on tags applied to managed nodes. -#' +#' #' Attempting to use `InstanceInformationFilterList` and `Filters` leads to #' an exception error. #' @param Filters One or more filters. Use a filter to return a more specific list of @@ -1947,11 +1947,11 @@ ssm_describe_instance_patch_states <- function(InstanceIds, NextToken = NULL, Ma #' @param PatchGroup [required] The name of the patch group for which the patch state information should #' be retrieved. #' @param Filters Each entry in the array is a structure containing: -#' +#' #' - Key (string between 1 and 200 characters) -#' +#' #' - Values (array containing a single string) -#' +#' #' - Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") #' @param NextToken The token for the next set of items to return. (You received this token #' from a previous call.) @@ -1988,25 +1988,25 @@ ssm_describe_instance_patch_states_for_patch_group <- function(PatchGroup, Filte #' @param InstanceId [required] The ID of the managed node whose patch state information should be #' retrieved. #' @param Filters Each element in the array is a structure containing a key-value pair. -#' +#' #' Supported keys for #' [`describe_instance_patches`][ssm_describe_instance_patches]include the #' following: -#' +#' #' - **`Classification`** -#' +#' #' Sample values: `Security` | `SecurityUpdates` -#' +#' #' - **`KBId`** -#' +#' #' Sample values: `KB4480056` | `java-1.7.0-openjdk.x86_64` -#' +#' #' - **`Severity`** -#' +#' #' Sample values: `Important` | `Medium` | `Low` -#' +#' #' - **`State`** -#' +#' #' Sample values: `Installed` | `InstalledOther` | #' `InstalledPendingReboot` #' @param NextToken The token for the next set of items to return. (You received this token @@ -2158,10 +2158,10 @@ ssm_describe_maintenance_window_execution_tasks <- function(WindowExecutionId, F #' #' @param WindowId [required] The ID of the maintenance window whose executions should be retrieved. #' @param Filters Each entry in the array is a structure containing: -#' +#' #' - Key. A string between 1 and 128 characters. Supported keys include #' `ExecutedBefore` and `ExecutedAfter`. -#' +#' #' - Values. An array of strings, each between 1 and 256 characters. #' Supported values are date/time strings in a valid ISO 8601 date/time #' format, such as `2021-11-04T05:00:00Z`. @@ -2386,63 +2386,63 @@ ssm_describe_maintenance_windows_for_target <- function(Targets, ResourceType, M #' See [https://paws-r.github.io/docs/ssm/describe_ops_items.html](https://paws-r.github.io/docs/ssm/describe_ops_items.html) for full documentation. #' #' @param OpsItemFilters One or more filters to limit the response. -#' +#' #' - Key: CreatedTime -#' +#' #' Operations: GreaterThan, LessThan -#' +#' #' - Key: LastModifiedBy -#' +#' #' Operations: Contains, Equals -#' +#' #' - Key: LastModifiedTime -#' +#' #' Operations: GreaterThan, LessThan -#' +#' #' - Key: Priority -#' +#' #' Operations: Equals -#' +#' #' - Key: Source -#' +#' #' Operations: Contains, Equals -#' +#' #' - Key: Status -#' +#' #' Operations: Equals -#' +#' #' - Key: Title* -#' +#' #' Operations: Equals,Contains -#' +#' #' - Key: OperationalData** -#' +#' #' Operations: Equals -#' +#' #' - Key: OperationalDataKey -#' +#' #' Operations: Equals -#' +#' #' - Key: OperationalDataValue -#' +#' #' Operations: Equals, Contains -#' +#' #' - Key: OpsItemId -#' +#' #' Operations: Equals -#' +#' #' - Key: ResourceId -#' +#' #' Operations: Contains -#' +#' #' - Key: AutomationId -#' +#' #' Operations: Equals -#' +#' #' *The Equals operator for Title matches the first 100 characters. If you #' specify more than 100 characters, they system returns an error that the #' filter value exceeds the length limit. -#' +#' #' **If you filter the response by using the OperationalData operator, #' specify a key-value pair by using the following JSON format: #' \{"key":"key_name","value":"a_value"\} @@ -2515,21 +2515,21 @@ ssm_describe_parameters <- function(Filters = NULL, ParameterFilters = NULL, Max #' See [https://paws-r.github.io/docs/ssm/describe_patch_baselines.html](https://paws-r.github.io/docs/ssm/describe_patch_baselines.html) for full documentation. #' #' @param Filters Each element in the array is a structure containing a key-value pair. -#' +#' #' Supported keys for #' [`describe_patch_baselines`][ssm_describe_patch_baselines] include the #' following: -#' +#' #' - **`NAME_PREFIX`** -#' +#' #' Sample values: `AWS-` | `My-` -#' +#' #' - **`OWNER`** -#' +#' #' Sample values: `AWS` | `Self` -#' +#' #' - **`OPERATING_SYSTEM`** -#' +#' #' Sample values: `AMAZON_LINUX` | `SUSE` | `WINDOWS` #' @param MaxResults The maximum number of patch baselines to return (per page). #' @param NextToken The token for the next set of items to return. (You received this token @@ -2594,16 +2594,16 @@ ssm_describe_patch_group_state <- function(PatchGroup) { #' #' @param MaxResults The maximum number of patch groups to return (per page). #' @param Filters Each element in the array is a structure containing a key-value pair. -#' +#' #' Supported keys for [`describe_patch_groups`][ssm_describe_patch_groups] #' include the following: -#' +#' #' - **`NAME_PREFIX`** -#' +#' #' Sample values: `AWS-` | `My-`. -#' +#' #' - **`OPERATING_SYSTEM`** -#' +#' #' Sample values: `AMAZON_LINUX` | `SUSE` | `WINDOWS` #' @param NextToken The token for the next set of items to return. (You received this token #' from a previous call.) @@ -2824,7 +2824,7 @@ ssm_get_calendar_state <- function(CalendarNames, AtTime = NULL) { #' the name of the step for which you want to view details. Be sure to #' specify the name of the step, not the name of a plugin like #' `aws:RunShellScript`. -#' +#' #' To find the `PluginName`, check the document content and find the name #' of the step you want details for. Alternatively, use #' [`list_command_invocations`][ssm_list_command_invocations] with the @@ -3326,7 +3326,7 @@ ssm_get_ops_summary <- function(SyncName = NULL, Filters = NULL, Aggregators = N #' See [https://paws-r.github.io/docs/ssm/get_parameter.html](https://paws-r.github.io/docs/ssm/get_parameter.html) for full documentation. #' #' @param Name [required] The name of the parameter you want to query. -#' +#' #' To query by parameter label, use `"Name": "name:label"`. To query by #' parameter version, use `"Name": "name:version"`. #' @param WithDecryption Return decrypted values for secure string parameters. This flag is @@ -3397,7 +3397,7 @@ ssm_get_parameter_history <- function(Name, WithDecryption = NULL, MaxResults = #' See [https://paws-r.github.io/docs/ssm/get_parameters.html](https://paws-r.github.io/docs/ssm/get_parameters.html) for full documentation. #' #' @param Names [required] Names of the parameters for which you want to query information. -#' +#' #' To query by parameter label, use `"Name": "name:label"`. To query by #' parameter version, use `"Name": "name:version"`. #' @param WithDecryption Return decrypted secure string value. Return decrypted values for secure @@ -3439,18 +3439,18 @@ ssm_get_parameters <- function(Names, WithDecryption = NULL) { #' of 15 levels. Here is an example of a hierarchy: #' `/Finance/Prod/IAD/WinServ2016/license33 ` #' @param Recursive Retrieve all parameters within a hierarchy. -#' +#' #' If a user has access to a path, then the user can access all levels of #' that path. For example, if a user has permission to access path `/a`, #' then the user can also access `/a/b`. Even if a user has explicitly been #' denied access in IAM for parameter `/a/b`, they can still call the #' GetParametersByPath API operation recursively for `/a` and view `/a/b`. #' @param ParameterFilters Filters to limit the request results. -#' +#' #' The following `Key` values are supported for #' [`get_parameters_by_path`][ssm_get_parameters_by_path]: `Type`, `KeyId`, #' and `Label`. -#' +#' #' The following `Key` values aren't supported for #' [`get_parameters_by_path`][ssm_get_parameters_by_path]: `tag`, #' `DataType`, `Name`, `Path`, and `Tier`. @@ -3489,7 +3489,7 @@ ssm_get_parameters_by_path <- function(Path, Recursive = NULL, ParameterFilters #' See [https://paws-r.github.io/docs/ssm/get_patch_baseline.html](https://paws-r.github.io/docs/ssm/get_patch_baseline.html) for full documentation. #' #' @param BaselineId [required] The ID of the patch baseline to retrieve. -#' +#' #' To retrieve information about an Amazon Web Services managed patch #' baseline, specify the full Amazon Resource Name (ARN) of the baseline. #' For example, for the baseline `AWS-AmazonLinuxDefaultPatchBaseline`, @@ -3559,19 +3559,19 @@ ssm_get_patch_baseline_for_patch_group <- function(PatchGroup, OperatingSystem = #' #' @param SettingId [required] The ID of the service setting to get. The setting ID can be one of the #' following. -#' +#' #' - `/ssm/automation/customer-script-log-destination` -#' +#' #' - `/ssm/automation/customer-script-log-group-name` -#' +#' #' - `/ssm/documents/console/public-sharing-permission` -#' +#' #' - `/ssm/managed-instance/activation-tier` -#' +#' #' - `/ssm/opsinsights/opscenter` -#' +#' #' - `/ssm/parameter-store/default-parameter-tier` -#' +#' #' - `/ssm/parameter-store/high-throughput-enabled` #' #' @keywords internal @@ -3672,7 +3672,7 @@ ssm_list_association_versions <- function(AssociationId, MaxResults = NULL, Next #' #' @param AssociationFilterList One or more filters. Use a filter to return a more specific list of #' results. -#' +#' #' Filtering associations using the `InstanceID` attribute only returns #' legacy associations created using the `InstanceID` attribute. #' Associations targeting the managed node that are part of the Target @@ -3751,7 +3751,7 @@ ssm_list_command_invocations <- function(CommandId = NULL, InstanceId = NULL, Ma #' #' @param CommandId (Optional) If provided, lists only the specified command. #' @param InstanceId (Optional) Lists commands issued against this managed node ID. -#' +#' #' You can't specify a managed node ID in the same command that you specify #' `Status` = `Pending`. This is because the command hasn't reached the #' managed node yet. @@ -3947,7 +3947,7 @@ ssm_list_document_versions <- function(Name, MaxResults = NULL, NextToken = NULL #' `TargetType`. For example, to return documents you own use #' `Key=Owner,Values=Self`. To specify a custom key-value pair, use the #' format `Key=tag:tagName,Values=valueName`. -#' +#' #' This API operation only supports filtering documents by using a single #' tag key and one or more tag values. For example: #' `Key=tag:tagName,Values=valueName1,valueName2` @@ -4295,12 +4295,12 @@ ssm_modify_document_permission <- function(Name, PermissionType, AccountIdsToAdd #' `PARTIAL`. In `COMPLETE` mode, the system overwrites all existing #' compliance information for the resource. You must provide a full list of #' compliance items each time you send the request. -#' +#' #' In `PARTIAL` mode, the system overwrites compliance information for a #' specific association. The association must be configured with #' `SyncCompliance` set to `MANUAL`. By default, all requests use #' `COMPLETE` mode. -#' +#' #' This attribute is only valid for association compliance. #' #' @keywords internal @@ -4365,33 +4365,33 @@ ssm_put_inventory <- function(InstanceId, Items) { #' parameter path and name. For parameters in a hierarchy, you must include #' a leading forward slash character (/) when you create or reference a #' parameter. For example: `/Dev/DBServer/MySQL/db-string13` -#' +#' #' Naming Constraints: -#' +#' #' - Parameter names are case sensitive. -#' +#' #' - A parameter name must be unique within an Amazon Web Services Region -#' +#' #' - A parameter name can't be prefixed with "`aws`" or "`ssm`" #' (case-insensitive). -#' +#' #' - Parameter names can include only the following symbols and letters: #' `a-zA-Z0-9_.-` -#' +#' #' In addition, the slash character ( / ) is used to delineate #' hierarchies in parameter names. For example: #' `/Dev/Production/East/Project-ABC/MyParameter` -#' +#' #' - A parameter name can't include spaces. -#' +#' #' - Parameter hierarchies are limited to a maximum depth of fifteen #' levels. -#' +#' #' For additional information about valid values for parameter names, see #' [Creating Systems Manager #' parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' The maximum length constraint of 2048 characters listed below includes #' 1037 characters reserved for internal use by Systems Manager. The #' maximum length for a parameter name that you create is 1011 characters. @@ -4399,38 +4399,38 @@ ssm_put_inventory <- function(InstanceId, Items) { #' specify, such as `arn:aws:ssm:us-east-2:111122223333:parameter/`. #' @param Description Information about the parameter that you want to add to the system. #' Optional but recommended. -#' +#' #' Don't enter personally identifiable information in this field. #' @param Value [required] The parameter value that you want to add to the system. Standard #' parameters have a value limit of 4 KB. Advanced parameters have a value #' limit of 8 KB. -#' +#' #' Parameters can't be referenced or nested in the values of other #' parameters. You can't include `{{}}` or `{{ssm:parameter-name}}` in a #' parameter value. #' @param Type The type of parameter that you want to add to the system. -#' +#' #' `SecureString` isn't currently supported for CloudFormation templates. -#' +#' #' Items in a `StringList` must be separated by a comma (,). You can't use #' other punctuation or special character to escape items in the list. If #' you have a parameter value that requires a comma, then use the `String` #' data type. -#' +#' #' Specifying a parameter type isn't required when updating a parameter. #' You must specify a parameter type when creating a parameter. #' @param KeyId The Key Management Service (KMS) ID that you want to use to encrypt a #' parameter. Either the default KMS key automatically assigned to your #' Amazon Web Services account or a custom key. Required for parameters #' that use the `SecureString` data type. -#' +#' #' If you don't specify a key ID, the system uses the default key #' associated with your Amazon Web Services account. -#' +#' #' - To use your default KMS key, choose the `SecureString` data type, #' and do *not* specify the `Key ID` when you create the parameter. The #' system automatically populates `Key ID` with your default KMS key. -#' +#' #' - To use a custom KMS key, choose the `SecureString` data type with #' the `Key ID` parameter. #' @param Overwrite Overwrite an existing parameter. The default value is `false`. @@ -4444,23 +4444,23 @@ ssm_put_inventory <- function(InstanceId, Items) { #' environment, or the type of configuration data referenced by the #' parameter. In this case, you could specify the following key-value #' pairs: -#' +#' #' - `Key=Resource,Value=S3bucket` -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' - `Key=ParameterType,Value=LicenseKey` -#' +#' #' To add tags to an existing Systems Manager parameter, use the #' [`add_tags_to_resource`][ssm_add_tags_to_resource] operation. #' @param Tier The parameter tier to assign to a parameter. -#' +#' #' Parameter Store offers a standard tier and an advanced tier for #' parameters. Standard parameters have a content size limit of 4 KB and #' can't be configured to use parameter policies. You can create a maximum #' of 10,000 standard parameters for each Region in an Amazon Web Services #' account. Standard parameters are offered at no additional cost. -#' +#' #' Advanced parameters have a content size limit of 8 KB and can be #' configured to use parameter policies. You can create a maximum of #' 100,000 advanced parameters for each Region in an Amazon Web Services @@ -4468,7 +4468,7 @@ ssm_put_inventory <- function(InstanceId, Items) { #' [Standard and advanced parameter #' tiers](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' You can change a standard parameter to an advanced parameter any time. #' But you can't revert an advanced parameter to a standard parameter. #' Reverting an advanced parameter to a standard parameter would result in @@ -4476,49 +4476,49 @@ ssm_put_inventory <- function(InstanceId, Items) { #' from 8 KB to 4 KB. Reverting would also remove any policies attached to #' the parameter. Lastly, advanced parameters use a different form of #' encryption than standard parameters. -#' +#' #' If you no longer need an advanced parameter, or if you no longer want to #' incur charges for an advanced parameter, you must delete it and recreate #' it as a new standard parameter. -#' +#' #' **Using the Default Tier Configuration** -#' +#' #' In [`put_parameter`][ssm_put_parameter] requests, you can specify the #' tier to create the parameter in. Whenever you specify a tier in the #' request, Parameter Store creates or updates the parameter according to #' that request. However, if you don't specify a tier in a request, #' Parameter Store assigns the tier based on the current Parameter Store #' default tier configuration. -#' +#' #' The default tier when you begin using Parameter Store is the #' standard-parameter tier. If you use the advanced-parameter tier, you can #' specify one of the following as the default: -#' +#' #' - **Advanced**: With this option, Parameter Store evaluates all #' requests as advanced parameters. -#' +#' #' - **Intelligent-Tiering**: With this option, Parameter Store evaluates #' each request to determine if the parameter is standard or advanced. -#' +#' #' If the request doesn't include any options that require an advanced #' parameter, the parameter is created in the standard-parameter tier. #' If one or more options requiring an advanced parameter are included #' in the request, Parameter Store create a parameter in the #' advanced-parameter tier. -#' +#' #' This approach helps control your parameter-related costs by always #' creating standard parameters unless an advanced parameter is #' necessary. -#' +#' #' Options that require an advanced parameter include the following: -#' +#' #' - The content size of the parameter is more than 4 KB. -#' +#' #' - The parameter uses a parameter policy. -#' +#' #' - More than 10,000 parameters already exist in your Amazon Web #' Services account in the current Amazon Web Services Region. -#' +#' #' For more information about configuring the default tier option, see #' [Specifying a default parameter #' tier](https://docs.aws.amazon.com/systems-manager/latest/userguide/) in @@ -4526,38 +4526,38 @@ ssm_put_inventory <- function(InstanceId, Items) { #' @param Policies One or more policies to apply to a parameter. This operation takes a #' JSON array. Parameter Store, a capability of Amazon Web Services Systems #' Manager supports the following policy types: -#' +#' #' Expiration: This policy deletes the parameter after it expires. When you #' create the policy, you specify the expiration date. You can update the #' expiration date and time by updating the policy. Updating the #' *parameter* doesn't affect the expiration date and time. When the #' expiration time is reached, Parameter Store deletes the parameter. -#' +#' #' ExpirationNotification: This policy initiates an event in Amazon #' CloudWatch Events that notifies you about the expiration. By using this #' policy, you can receive notification before or after the expiration time #' is reached, in units of days or hours. -#' +#' #' NoChangeNotification: This policy initiates a CloudWatch Events event if #' a parameter hasn't been modified for a specified period of time. This #' policy type is useful when, for example, a secret needs to be changed #' within a period of time, but it hasn't been changed. -#' +#' #' All existing policies are preserved until you send new policies or an #' empty policy. For more information about parameter policies, see #' [Assigning parameter #' policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html). #' @param DataType The data type for a `String` parameter. Supported data types include #' plain text and Amazon Machine Image (AMI) IDs. -#' +#' #' **The following data type values are supported.** -#' +#' #' - `text` -#' +#' #' - `aws:ec2:image` -#' +#' #' - `aws:ssm:integration` -#' +#' #' When you create a `String` parameter and specify `aws:ec2:image`, Amazon #' Web Services Systems Manager validates the parameter value is in the #' required format, such as `ami-12345abcdeEXAMPLE`, and that the specified @@ -4657,40 +4657,40 @@ ssm_register_patch_baseline_for_patch_group <- function(BaselineId, PatchGroup) #' @param ResourceType [required] The type of target being registered with the maintenance window. #' @param Targets [required] The targets to register with the maintenance window. In other words, the #' managed nodes to run commands on when the maintenance window runs. -#' +#' #' If a single maintenance window task is registered with multiple targets, #' its task invocations occur sequentially and not in parallel. If your #' task must run on multiple targets at the same time, register a task for #' each target individually and assign each task the same priority level. -#' +#' #' You can specify targets using managed node IDs, resource group names, or #' tags that have been applied to managed nodes. -#' +#' #' **Example 1**: Specify managed node IDs -#' +#' #' `Key=InstanceIds,Values=,,` -#' +#' #' **Example 2**: Use tag key-pairs applied to managed nodes -#' +#' #' `Key=tag:,Values=,` -#' +#' #' **Example 3**: Use tag-keys applied to managed nodes -#' +#' #' `Key=tag-key,Values=,` -#' +#' #' **Example 4**: Use resource group names -#' +#' #' `Key=resource-groups:Name,Values=` -#' +#' #' **Example 5**: Use filters for resource group types -#' +#' #' `Key=resource-groups:ResourceTypeFilters,Values=,` -#' +#' #' For `Key=resource-groups:ResourceTypeFilters`, specify resource types in #' the following format -#' +#' #' `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC` -#' +#' #' For more information about these examples formats, including the best #' use case for each one, see [Examples: Register targets with a #' maintenance @@ -4732,7 +4732,7 @@ ssm_register_target_with_maintenance_window <- function(WindowId, ResourceType, #' #' @param WindowId [required] The ID of the maintenance window the task should be added to. #' @param Targets The targets (either managed nodes or maintenance window targets). -#' +#' #' One or more targets must be specified for maintenance window Run #' Command-type tasks. Depending on the task, targets are optional for #' other maintenance window task types (Automation, Lambda, and Step @@ -4740,13 +4740,13 @@ ssm_register_target_with_maintenance_window <- function(WindowId, ResourceType, #' targets, see [Registering maintenance window tasks without #' targets](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' Specify managed nodes using the following format: -#' +#' #' `Key=InstanceIds,Values=,` -#' +#' #' Specify maintenance window targets using the following format: -#' +#' #' `Key=WindowTargetIds,Values=,` #' @param TaskArn [required] The ARN of the task to run. #' @param ServiceRoleArn The Amazon Resource Name (ARN) of the IAM service role for Amazon Web @@ -4755,19 +4755,19 @@ ssm_register_target_with_maintenance_window <- function(WindowId, ResourceType, #' your account's service-linked role. If no service-linked role for #' Systems Manager exists in your account, it is created when you run #' [`register_task_with_maintenance_window`][ssm_register_task_with_maintenance_window]. -#' +#' #' For more information, see the following topics in the in the *Amazon Web #' Services Systems Manager User Guide*: -#' +#' #' - [Using service-linked roles for Systems #' Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) -#' +#' #' - [Should I use a service-linked role or a custom service role to run #' maintenance window #' tasks?](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) #' @param TaskType [required] The type of task being registered. #' @param TaskParameters The parameters that should be passed to the task when it is run. -#' +#' #' `TaskParameters` has been deprecated. To specify parameters to pass to a #' task when it runs, instead use the `Parameters` option in the #' `TaskInvocationParameters` structure. For information about how Systems @@ -4780,31 +4780,31 @@ ssm_register_target_with_maintenance_window <- function(WindowId, ResourceType, #' priority order with tasks that have the same priority scheduled in #' parallel. #' @param MaxConcurrency The maximum number of targets this task can be run for, in parallel. -#' +#' #' Although this element is listed as "Required: No", a value can be #' omitted only when you are registering or updating a [targetless #' task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) #' You must provide a value in all other cases. -#' +#' #' For maintenance window tasks without a target specified, you can't #' supply a value for this option. Instead, the system inserts a #' placeholder value of `1`. This value doesn't affect the running of your #' task. #' @param MaxErrors The maximum number of errors allowed before this task stops being #' scheduled. -#' +#' #' Although this element is listed as "Required: No", a value can be #' omitted only when you are registering or updating a [targetless #' task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) #' You must provide a value in all other cases. -#' +#' #' For maintenance window tasks without a target specified, you can't #' supply a value for this option. Instead, the system inserts a #' placeholder value of `1`. This value doesn't affect the running of your #' task. #' @param LoggingInfo A structure containing information about an Amazon Simple Storage #' Service (Amazon S3) bucket to write managed node-level logs to. -#' +#' #' `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage #' Service (Amazon S3) bucket to contain logs, instead use the #' `OutputS3BucketName` and `OutputS3KeyPrefix` options in the @@ -4817,22 +4817,22 @@ ssm_register_target_with_maintenance_window <- function(WindowId, ResourceType, #' @param ClientToken User-provided idempotency token. #' @param CutoffBehavior Indicates whether tasks should continue to run after the cutoff time #' specified in the maintenance windows is reached. -#' +#' #' - `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are #' running continue. The default value. -#' +#' #' - `CANCEL_TASK`: -#' +#' #' - For Automation, Lambda, Step Functions tasks: When the cutoff #' time is reached, any task invocations that are already running #' continue, but no new task invocations are started. -#' +#' #' - For Run Command tasks: When the cutoff time is reached, the #' system sends a [`cancel_command`][ssm_cancel_command] operation #' that attempts to cancel the command associated with the task. #' However, there is no guarantee that the command will be #' terminated and the underlying process stopped. -#' +#' #' The status for tasks that are not completed is `TIMED_OUT`. #' #' @keywords internal @@ -4863,20 +4863,20 @@ ssm_register_task_with_maintenance_window <- function(WindowId, Targets = NULL, #' See [https://paws-r.github.io/docs/ssm/remove_tags_from_resource.html](https://paws-r.github.io/docs/ssm/remove_tags_from_resource.html) for full documentation. #' #' @param ResourceType [required] The type of resource from which you want to remove a tag. -#' +#' #' The `ManagedInstance` type for this API operation is only for #' on-premises managed nodes. Specify the name of the managed node in the #' following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`. #' @param ResourceId [required] The ID of the resource from which you want to remove tags. For example: -#' +#' #' ManagedInstance: mi-012345abcde -#' +#' #' MaintenanceWindow: mw-012345abcde -#' +#' #' `Automation`: `example-c160-4567-8519-012345abcde` -#' +#' #' PatchBaseline: pb-012345abcde -#' +#' #' OpsMetadata object: `ResourceID` for tagging is created from the Amazon #' Resource Name (ARN) for the object. Specifically, `ResourceID` is #' created from the strings that come after the word `opsmetadata` in the @@ -4884,9 +4884,9 @@ ssm_register_task_with_maintenance_window <- function(WindowId, Targets = NULL, #' `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` #' has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or #' `/aws/ssm/MyGroup/appmanager`. -#' +#' #' For the Document and Parameter values, use the name of the resource. -#' +#' #' The `ManagedInstance` type for this API operation is only for #' on-premises managed nodes. Specify the name of the managed node in the #' following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. @@ -4922,19 +4922,19 @@ ssm_remove_tags_from_resource <- function(ResourceType, ResourceId, TagKeys) { #' #' @param SettingId [required] The Amazon Resource Name (ARN) of the service setting to reset. The #' setting ID can be one of the following. -#' +#' #' - `/ssm/automation/customer-script-log-destination` -#' +#' #' - `/ssm/automation/customer-script-log-group-name` -#' +#' #' - `/ssm/documents/console/public-sharing-permission` -#' +#' #' - `/ssm/managed-instance/activation-tier` -#' +#' #' - `/ssm/opsinsights/opscenter` -#' +#' #' - `/ssm/parameter-store/default-parameter-tier` -#' +#' #' - `/ssm/parameter-store/high-throughput-enabled` #' #' @keywords internal @@ -4999,20 +4999,20 @@ ssm_resume_session <- function(SessionId) { #' @param SignalType [required] The type of signal to send to an Automation execution. #' @param Payload The data sent with the signal. The data schema depends on the type of #' signal used in the request. -#' +#' #' For `Approve` and `Reject` signal types, the payload is an optional #' comment that you can send with the signal type. For example: -#' +#' #' `Comment="Looks good"` -#' +#' #' For `StartStep` and `Resume` signal types, you must send the name of the #' Automation step to start or resume as the payload. For example: -#' +#' #' `StepName="step1"` -#' +#' #' For the `StopStep` signal type, you must send the step execution ID as #' the payload. For example: -#' +#' #' `StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"` #' #' @keywords internal @@ -5045,13 +5045,13 @@ ssm_send_automation_signal <- function(AutomationExecutionId, SignalType, Payloa #' @param InstanceIds The IDs of the managed nodes where the command should run. Specifying #' managed node IDs is most useful when you are targeting a limited number #' of managed nodes, though you can specify up to 50 IDs. -#' +#' #' To target a larger number of managed nodes, or if you prefer not to list #' individual node IDs, we recommend using the `Targets` option instead. #' Using `Targets`, which accepts tag key-value pairs to identify the #' managed nodes to send commands to, you can a send command to tens, #' hundreds, or thousands of nodes at once. -#' +#' #' For more information about how to use targets, see [Using targets and #' rate controls to send commands to a #' fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) @@ -5062,10 +5062,10 @@ ssm_send_automation_signal <- function(AutomationExecutionId, SignalType, Payloa #' nodes at once. Using `Targets`, which accepts tag key-value pairs to #' identify managed nodes, you can send a command to tens, hundreds, or #' thousands of nodes at once. -#' +#' #' To send a command to a smaller number of managed nodes, you can use the #' `InstanceIds` option instead. -#' +#' #' For more information about how to use targets, see [Sending commands to #' a #' fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) @@ -5077,7 +5077,7 @@ ssm_send_automation_signal <- function(AutomationExecutionId, SignalType, Payloa #' documents, see [Using shared SSM #' documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' If you specify a document name or ARN that hasn't been shared with your #' account, you receive an `InvalidDocument` error. #' @param DocumentVersion The SSM document version to use in the request. You can specify @@ -5085,18 +5085,18 @@ ssm_send_automation_signal <- function(AutomationExecutionId, SignalType, Payloa #' using the Command Line Interface (Amazon Web Services CLI), then you #' must escape the first two options by using a backslash. If you specify a #' version number, then you don't need to use the backslash. For example: -#' -#' --document-version "\\$DEFAULT" -#' -#' --document-version "\\$LATEST" -#' +#' +#' --document-version "$DEFAULT" +#' +#' --document-version "$LATEST" +#' #' --document-version "3" #' @param DocumentHash The Sha256 or Sha1 hash created by the system when the document was #' created. -#' +#' #' Sha1 hashes have been deprecated. #' @param DocumentHashType Sha256 or Sha1. -#' +#' #' Sha1 hashes have been deprecated. #' @param TimeoutSeconds If this time is reached and the command hasn't already started running, #' it won't run. @@ -5219,7 +5219,7 @@ ssm_start_associations_once <- function(AssociationIds) { #' first error result is returned. If you run an automation on 50 resources #' and set max-errors to 10%, then the system stops running the automation #' on additional targets when the sixth error is received. -#' +#' #' Executions that are already running an automation when max-errors is #' reached are allowed to complete, but some of these executions may fail #' as well. If you need to ensure that there won't be more than max-errors @@ -5239,11 +5239,11 @@ ssm_start_associations_once <- function(AssociationIds) { #' For example, you might want to tag an automation to identify an #' environment or operating system. In this case, you could specify the #' following key-value pairs: -#' +#' #' - `Key=environment,Value=test` -#' +#' #' - `Key=OS,Value=Windows` -#' +#' #' To add tags to an existing automation, use the #' [`add_tags_to_resource`][ssm_add_tags_to_resource] operation. #' @@ -5276,7 +5276,7 @@ ssm_start_automation_execution <- function(DocumentName, DocumentVersion = NULL, #' #' @param ScheduledTime The date and time specified in the change request to run the Automation #' runbooks. -#' +#' #' The Automation runbooks specified for the runbook workflow can't run #' until all required approvals for the change request have been received. #' @param DocumentName [required] The name of the change template document to run during the runbook @@ -5291,12 +5291,12 @@ ssm_start_automation_execution <- function(DocumentName, DocumentVersion = NULL, #' insensitive, enforces the UUID format, and can't be reused. #' @param AutoApprove Indicates whether the change request can be approved automatically #' without the need for manual approvals. -#' +#' #' If `AutoApprovable` is enabled in a change template, then setting #' `AutoApprove` to `true` in #' [`start_change_request_execution`][ssm_start_change_request_execution] #' creates a change request that bypasses approver review. -#' +#' #' Change Calendar restrictions are not bypassed in this scenario. If the #' state of an associated calendar is `CLOSED`, change freeze approvers #' must still grant permission for this change request to run. If they @@ -5304,7 +5304,7 @@ ssm_start_automation_execution <- function(DocumentName, DocumentVersion = NULL, #' `OPEN`. #' @param Runbooks [required] Information about the Automation runbooks that are run during the #' runbook workflow. -#' +#' #' The Automation runbooks specified for the runbook workflow can't run #' until all required approvals for the change request have been received. #' @param Tags Optional metadata that you assign to a resource. You can specify a @@ -5313,9 +5313,9 @@ ssm_start_automation_execution <- function(DocumentName, DocumentVersion = NULL, #' For example, you might want to tag a change request to identify an #' environment or target Amazon Web Services Region. In this case, you #' could specify the following key-value pairs: -#' +#' #' - `Key=Environment,Value=Production` -#' +#' #' - `Key=Region,Value=us-east-2` #' @param ScheduledEndTime The time that the requester expects the runbook workflow related to the #' change request to complete. The time is an estimate only that the @@ -5495,7 +5495,7 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' Systems Manager, you can reference the parameter using #' `{{ssm:parameter-name}}`. #' @param DocumentVersion The document version you want update for the association. -#' +#' #' State Manager doesn't support running associations that use a new #' version of a document if that document is shared from another account. #' State Manager always runs the `default` version of a document if shared @@ -5508,20 +5508,20 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' @param OutputLocation An S3 bucket where you want to store the results of this request. #' @param Name The name of the SSM Command document or Automation runbook that contains #' the configuration information for the managed node. -#' +#' #' You can specify Amazon Web Services-predefined documents, documents you #' created, or a document that is shared with you from another account. -#' +#' #' For Systems Manager document (SSM document) that are shared with you #' from other Amazon Web Services accounts, you must specify the complete #' SSM document ARN, in the following format: -#' +#' #' `arn:aws:ssm:region:account-id:document/document-name ` -#' +#' #' For example: -#' +#' #' `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` -#' +#' #' For Amazon Web Services-predefined documents and SSM documents you #' created in your account, you only need to specify the document name. For #' example, `AWS-ApplyPatchBaseline` or `My-Document`. @@ -5544,7 +5544,7 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' is returned. If you run an association on 50 managed nodes and set #' `MaxError` to 10%, then the system stops sending the request when the #' sixth error is received. -#' +#' #' Executions that are already running an association when `MaxErrors` is #' reached are allowed to complete, but some of these executions may fail #' as well. If you need to ensure that there won't be more than max-errors @@ -5554,7 +5554,7 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' time. You can specify a number, for example 10, or a percentage of the #' target set, for example 10%. The default value is 100%, which means all #' targets run the association at the same time. -#' +#' #' If a new managed node starts and attempts to run an association while #' Systems Manager is running `MaxConcurrency` associations, the #' association is allowed to run. During the next association interval, the @@ -5567,21 +5567,21 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' association execution runs successfully, then the association is #' `COMPLIANT`. If the association execution doesn't run successfully, the #' association is `NON-COMPLIANT`. -#' +#' #' In `MANUAL` mode, you must specify the `AssociationId` as a parameter #' for the [`put_compliance_items`][ssm_put_compliance_items] API #' operation. In this case, compliance data isn't managed by State Manager, #' a capability of Amazon Web Services Systems Manager. It is managed by #' your direct call to the #' [`put_compliance_items`][ssm_put_compliance_items] API operation. -#' +#' #' By default, all associations use `AUTO` mode. #' @param ApplyOnlyAtCronInterval By default, when you update an association, the system runs it #' immediately after it is updated and then according to the schedule you #' specified. Specify this option if you don't want an association to run #' immediately after you update it. This parameter isn't supported for rate #' expressions. -#' +#' #' If you chose this option when you created an association and later you #' edit that association or you make changes to the SSM document on which #' that association is based (by using the Documents page in the console), @@ -5592,7 +5592,7 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' Manager applies the association at the next specified cron interval if #' you previously selected this option. If this option wasn't selected, #' State Manager immediately runs the association. -#' +#' #' You can reset this option. To do so, specify the #' `no-apply-only-at-cron-interval` parameter when you update the #' association from the command line. This parameter forces the association @@ -5615,7 +5615,7 @@ ssm_unlabel_parameter_version <- function(Name, ParameterVersion, Labels) { #' and rate expressions for Systems #' Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) #' in the *Amazon Web Services Systems Manager User Guide*. -#' +#' #' To use offsets, you must specify the `ApplyOnlyAtCronInterval` #' parameter. This option tells the system not to run an association #' immediately after you create it. @@ -5696,7 +5696,7 @@ ssm_update_association_status <- function(Name, InstanceId, AssociationStatus) { #' Manager supports updating only the latest version of the document. You #' can specify the version number of the latest version or use the #' `$LATEST` variable. -#' +#' #' If you change a document version for a State Manager association, #' Systems Manager immediately runs the association unless you previously #' specifed the `apply-only-at-cron-interval` parameter. @@ -5815,12 +5815,12 @@ ssm_update_document_metadata <- function(Name, DocumentVersion = NULL, DocumentR #' website. #' @param ScheduleOffset The number of days to wait after the date and time specified by a cron #' expression before running the maintenance window. -#' +#' #' For example, the following cron expression schedules a maintenance #' window to run the third Tuesday of every month at 11:30 PM. -#' +#' #' `cron(30 23 ? * TUE#3 *)` -#' +#' #' If the schedule offset is `2`, the maintenance window won't run until #' two days later. #' @param Duration The duration of the maintenance window in hours. @@ -5907,7 +5907,7 @@ ssm_update_maintenance_window_target <- function(WindowId, WindowTargetId, Targe #' specified using the format #' `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified #' using the format ` Key=tag_name,Values=tag_value`. -#' +#' #' One or more targets must be specified for maintenance window Run #' Command-type tasks. Depending on the task, targets are optional for #' other maintenance window task types (Automation, Lambda, and Step @@ -5922,32 +5922,32 @@ ssm_update_maintenance_window_target <- function(WindowId, WindowTargetId, Targe #' your account's service-linked role. If no service-linked role for #' Systems Manager exists in your account, it is created when you run #' [`register_task_with_maintenance_window`][ssm_register_task_with_maintenance_window]. -#' +#' #' For more information, see the following topics in the in the *Amazon Web #' Services Systems Manager User Guide*: -#' +#' #' - [Using service-linked roles for Systems #' Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) -#' +#' #' - [Should I use a service-linked role or a custom service role to run #' maintenance window #' tasks?](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) #' @param TaskParameters The parameters to modify. -#' +#' #' `TaskParameters` has been deprecated. To specify parameters to pass to a #' task when it runs, instead use the `Parameters` option in the #' `TaskInvocationParameters` structure. For information about how Systems #' Manager handles these options for the supported maintenance window task #' types, see MaintenanceWindowTaskInvocationParameters. -#' +#' #' The map has the following format: -#' +#' #' Key: string, between 1 and 255 characters -#' +#' #' Value: an array of strings, each string is between 1 and 255 characters #' @param TaskInvocationParameters The parameters that the task should use during execution. Populate only #' the fields that match the task type. All other fields should be empty. -#' +#' #' When you update a maintenance window task that has options specified in #' `TaskInvocationParameters`, you must provide again all the #' `TaskInvocationParameters` values that you want to retain. The values @@ -5961,30 +5961,30 @@ ssm_update_maintenance_window_target <- function(WindowId, WindowTargetId, Targe #' priority. Tasks that have the same priority are scheduled in parallel. #' @param MaxConcurrency The new `MaxConcurrency` value you want to specify. `MaxConcurrency` is #' the number of targets that are allowed to run this task, in parallel. -#' +#' #' Although this element is listed as "Required: No", a value can be #' omitted only when you are registering or updating a [targetless #' task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) #' You must provide a value in all other cases. -#' +#' #' For maintenance window tasks without a target specified, you can't #' supply a value for this option. Instead, the system inserts a #' placeholder value of `1`. This value doesn't affect the running of your #' task. #' @param MaxErrors The new `MaxErrors` value to specify. `MaxErrors` is the maximum number #' of errors that are allowed before the task stops being scheduled. -#' +#' #' Although this element is listed as "Required: No", a value can be #' omitted only when you are registering or updating a [targetless #' task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) #' You must provide a value in all other cases. -#' +#' #' For maintenance window tasks without a target specified, you can't #' supply a value for this option. Instead, the system inserts a #' placeholder value of `1`. This value doesn't affect the running of your #' task. #' @param LoggingInfo The new logging location in Amazon S3 to specify. -#' +#' #' `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage #' Service (Amazon S3) bucket to contain logs, instead use the #' `OutputS3BucketName` and `OutputS3KeyPrefix` options in the @@ -6000,22 +6000,22 @@ ssm_update_maintenance_window_target <- function(WindowId, WindowTargetId, Targe #' aren't specified are set to null. #' @param CutoffBehavior Indicates whether tasks should continue to run after the cutoff time #' specified in the maintenance windows is reached. -#' +#' #' - `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are #' running continue. The default value. -#' +#' #' - `CANCEL_TASK`: -#' +#' #' - For Automation, Lambda, Step Functions tasks: When the cutoff #' time is reached, any task invocations that are already running #' continue, but no new task invocations are started. -#' +#' #' - For Run Command tasks: When the cutoff time is reached, the #' system sends a [`cancel_command`][ssm_cancel_command] operation #' that attempts to cancel the command associated with the task. #' However, there is no guarantee that the command will be #' terminated and the underlying process stopped. -#' +#' #' The status for tasks that are not completed is `TIMED_OUT`. #' #' @keywords internal @@ -6080,16 +6080,16 @@ ssm_update_managed_instance_role <- function(InstanceId, IamRole) { #' that users reading this OpsItem for the first time understand the issue. #' @param OperationalData Add new keys or edit existing key-value pairs of the OperationalData map #' in the OpsItem object. -#' +#' #' Operational data is custom data that provides useful reference details #' about the OpsItem. For example, you can specify log files, error #' strings, license keys, troubleshooting tips, or other relevant data. You #' enter operational data as key-value pairs. The key has a maximum length #' of 128 characters. The value has a maximum size of 20 KB. -#' +#' #' Operational data keys *can't* begin with the following: `amazon`, `aws`, #' `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`. -#' +#' #' You can choose to make the data searchable by other users in the account #' or you can restrict search access. Searchable data means that all users #' with access to the OpsItem Overview page (as provided by the @@ -6097,7 +6097,7 @@ ssm_update_managed_instance_role <- function(InstanceId, IamRole) { #' and search on the specified data. Operational data that isn't searchable #' is only viewable by users who have access to the OpsItem (as provided by #' the [`get_ops_item`][ssm_get_ops_item] API operation). -#' +#' #' Use the `/aws/resources` key in OperationalData to specify a related #' resource in the request. Use the `/aws/automations` key in #' OperationalData to associate an Automation runbook with the OpsItem. To @@ -6196,7 +6196,7 @@ ssm_update_ops_metadata <- function(OpsMetadataArn, MetadataToUpdate = NULL, Key #' @param GlobalFilters A set of global filters used to include patches in the baseline. #' @param ApprovalRules A set of rules used to include patches in the baseline. #' @param ApprovedPatches A list of explicitly approved patches for the baseline. -#' +#' #' For information about accepted formats for lists of approved patches and #' rejected patches, see [About package name formats for approved and #' rejected patch @@ -6207,7 +6207,7 @@ ssm_update_ops_metadata <- function(OpsMetadataArn, MetadataToUpdate = NULL, Key #' updates that should be applied to the managed nodes. The default value #' is `false`. Applies to Linux managed nodes only. #' @param RejectedPatches A list of explicitly rejected patches for the baseline. -#' +#' #' For information about accepted formats for lists of approved patches and #' rejected patches, see [About package name formats for approved and #' rejected patch @@ -6215,13 +6215,13 @@ ssm_update_ops_metadata <- function(OpsMetadataArn, MetadataToUpdate = NULL, Key #' in the *Amazon Web Services Systems Manager User Guide*. #' @param RejectedPatchesAction The action for Patch Manager to take on patches included in the #' `RejectedPackages` list. -#' +#' #' - **`ALLOW_AS_DEPENDENCY`** : A package in the `Rejected` patches list #' is installed only if it is a dependency of another package. It is #' considered compliant with the patch baseline, and its status is #' reported as `InstalledOther`. This is the default action if no #' option is specified. -#' +#' #' - **`BLOCK`** : Packages in the `RejectedPatches` list, and packages #' that include them as dependencies, aren't installed under any #' circumstances. If a package was installed before it was added to the @@ -6300,38 +6300,38 @@ ssm_update_resource_data_sync <- function(SyncName, SyncType, SyncSource) { #' example, #' `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`. #' The setting ID can be one of the following. -#' +#' #' - `/ssm/automation/customer-script-log-destination` -#' +#' #' - `/ssm/automation/customer-script-log-group-name` -#' +#' #' - `/ssm/documents/console/public-sharing-permission` -#' +#' #' - `/ssm/managed-instance/activation-tier` -#' +#' #' - `/ssm/opsinsights/opscenter` -#' +#' #' - `/ssm/parameter-store/default-parameter-tier` -#' +#' #' - `/ssm/parameter-store/high-throughput-enabled` #' @param SettingValue [required] The new value to specify for the service setting. The following list #' specifies the available values for each setting. -#' +#' #' - `/ssm/automation/customer-script-log-destination`: `CloudWatch` -#' +#' #' - `/ssm/automation/customer-script-log-group-name`: the name of an #' Amazon CloudWatch Logs log group -#' +#' #' - `/ssm/documents/console/public-sharing-permission`: `Enable` or #' `Disable` -#' +#' #' - `/ssm/managed-instance/activation-tier`: `standard` or `advanced` -#' +#' #' - `/ssm/opsinsights/opscenter`: `Enabled` or `Disabled` -#' +#' #' - `/ssm/parameter-store/default-parameter-tier`: `Standard`, #' `Advanced`, `Intelligent-Tiering` -#' +#' #' - `/ssm/parameter-store/high-throughput-enabled`: `true` or `false` #' #' @keywords internal diff --git a/cran/paws.management/cran-comments.md b/cran/paws.management/cran-comments.md index 71a9027487..a9088d0d2c 100644 --- a/cran/paws.management/cran-comments.md +++ b/cran/paws.management/cran-comments.md @@ -2,17 +2,25 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results There were no ERRORs, or WARNINGs. - -There was one Note: +Notes: +checking installed package size ... NOTE + installed size is 5.4Mb + sub-directories of 1Mb or more: + R 2.0Mb + help 3.2Mb + New maintainer: Dyfan Jones Old maintainer(s): David Kretch +Maintainer Notes: tarball package size: 820.1K + ## Downstream dependencies All downstream dependencies ('paws') pass R CMD check. diff --git a/cran/paws.management/man/licensemanager_create_license_configuration.Rd b/cran/paws.management/man/licensemanager_create_license_configuration.Rd index ce8e7fac91..1b0fd17e12 100644 --- a/cran/paws.management/man/licensemanager_create_license_configuration.Rd +++ b/cran/paws.management/man/licensemanager_create_license_configuration.Rd @@ -28,8 +28,8 @@ licensemanager_create_license_configuration( \item{LicenseCountHardLimit}{Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.} -\item{LicenseRules}{License rules. The syntax is \#name=value (for example, -\#allowedTenancy=EC2-DedicatedHost). The available rules vary by +\item{LicenseRules}{License rules. The syntax is #name=value (for example, +#allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows. \itemize{ \item \code{Cores} dimension: \code{allowedTenancy} | \code{licenseAffinityToHost} | diff --git a/cran/paws.management/man/opsworks_update_layer.Rd b/cran/paws.management/man/opsworks_update_layer.Rd index c37fefc72d..53c3b74356 100644 --- a/cran/paws.management/man/opsworks_update_layer.Rd +++ b/cran/paws.management/man/opsworks_update_layer.Rd @@ -33,7 +33,7 @@ opsworks_update_layer( name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be -in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/. +in the following format: /A[a-z0-9-_.]+Z/. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the \href{https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html}{Layer Reference}} diff --git a/cran/paws.management/man/ssm_send_command.Rd b/cran/paws.management/man/ssm_send_command.Rd index c1c05973ac..76306f811e 100644 --- a/cran/paws.management/man/ssm_send_command.Rd +++ b/cran/paws.management/man/ssm_send_command.Rd @@ -67,9 +67,9 @@ using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example: ---document-version "\\$DEFAULT" +--document-version "$DEFAULT" ---document-version "\\$LATEST" +--document-version "$LATEST" --document-version "3"} diff --git a/cran/paws.networking/cran-comments.md b/cran/paws.networking/cran-comments.md index cffcc71ad3..da40f3afdc 100644 --- a/cran/paws.networking/cran-comments.md +++ b/cran/paws.networking/cran-comments.md @@ -2,17 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no ERRORs, WARNINGs. +There were no ERRORs or WARNINGs. -There was one Note: +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Maintainer Notes: tarball package size: 467.8K ## Downstream dependencies diff --git a/cran/paws.security.identity/R/cognitosync_service.R b/cran/paws.security.identity/R/cognitosync_service.R index ff97e4d26f..e6d3f657ed 100644 --- a/cran/paws.security.identity/R/cognitosync_service.R +++ b/cran/paws.security.identity/R/cognitosync_service.R @@ -14,18 +14,16 @@ NULL #' obtain a normalized user ID and credentials. User data is persisted in a #' dataset that can store up to 1 MB of key-value pairs, and you can have #' up to 20 datasets per user identity. -#' +#' #' With Amazon Cognito Sync, the data stored for each identity is #' accessible only to credentials assigned to that identity. In order to #' use the Cognito Sync service, you need to make API calls using #' credentials retrieved with [Amazon Cognito Identity #' service](https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html). -#' +#' #' If you want to use Cognito Sync in an Android or iOS application, you #' will probably want to make API calls via the AWS Mobile SDK. To learn -#' more, see the [Developer Guide for -#' Android](https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/) -#' and the Developer Guide for iOS. +#' more, see the Developer Guide for Android and the Developer Guide for iOS. #' #' @param #' config diff --git a/cran/paws.security.identity/R/iam_operations.R b/cran/paws.security.identity/R/iam_operations.R index fc3c000003..842e473d73 100644 --- a/cran/paws.security.identity/R/iam_operations.R +++ b/cran/paws.security.identity/R/iam_operations.R @@ -48,13 +48,13 @@ iam_add_client_id_to_open_id_connect_provider <- function(OpenIDConnectProviderA #' See [https://paws-r.github.io/docs/iam/add_role_to_instance_profile.html](https://paws-r.github.io/docs/iam/add_role_to_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the instance profile to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param RoleName [required] The name of the role to add. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -88,13 +88,13 @@ iam_add_role_to_instance_profile <- function(InstanceProfileName, RoleName) { #' See [https://paws-r.github.io/docs/iam/add_user_to_group.html](https://paws-r.github.io/docs/iam/add_user_to_group.html) for full documentation. #' #' @param GroupName [required] The name of the group to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param UserName [required] The name of the user to add. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -128,13 +128,13 @@ iam_add_user_to_group <- function(GroupName, UserName) { #' See [https://paws-r.github.io/docs/iam/attach_group_policy.html](https://paws-r.github.io/docs/iam/attach_group_policy.html) for full documentation. #' #' @param GroupName [required] The name (friendly name, not ARN) of the group to attach the policy to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to attach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -167,13 +167,13 @@ iam_attach_group_policy <- function(GroupName, PolicyArn) { #' See [https://paws-r.github.io/docs/iam/attach_role_policy.html](https://paws-r.github.io/docs/iam/attach_role_policy.html) for full documentation. #' #' @param RoleName [required] The name (friendly name, not ARN) of the role to attach the policy to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to attach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -207,13 +207,13 @@ iam_attach_role_policy <- function(RoleName, PolicyArn) { #' #' @param UserName [required] The name (friendly name, not ARN) of the IAM user to attach the policy #' to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to attach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -248,7 +248,7 @@ iam_attach_user_policy <- function(UserName, PolicyArn) { #' @param OldPassword [required] The IAM user's current password. #' @param NewPassword [required] The new password. The new password must conform to the Amazon Web #' Services account's password policy, if one exists. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) that is used to #' validate this parameter is a string of characters. That string can #' include almost any printable ASCII character from the space (``U+0020``) @@ -288,7 +288,7 @@ iam_change_password <- function(OldPassword, NewPassword) { #' See [https://paws-r.github.io/docs/iam/create_access_key.html](https://paws-r.github.io/docs/iam/create_access_key.html) for full documentation. #' #' @param UserName The name of the IAM user that the new key will belong to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -317,12 +317,12 @@ iam_create_access_key <- function(UserName = NULL) { #' Creates an alias for your Amazon Web Services account #' #' @description -#' Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) in the *IAM User Guide*. +#' Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html) in the *IAM User Guide*. #' #' See [https://paws-r.github.io/docs/iam/create_account_alias.html](https://paws-r.github.io/docs/iam/create_account_alias.html) for full documentation. #' #' @param AccountAlias [required] The account alias to create. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of lowercase letters, digits, and dashes. You cannot start or @@ -358,10 +358,10 @@ iam_create_account_alias <- function(AccountAlias) { #' @param Path The path to the group. For more information about paths, see [IAM #' identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -370,7 +370,7 @@ iam_create_account_alias <- function(AccountAlias) { #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. #' @param GroupName [required] The name of the group to create. Do not include the path in this value. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". @@ -403,7 +403,7 @@ iam_create_group <- function(Path = NULL, GroupName) { #' See [https://paws-r.github.io/docs/iam/create_instance_profile.html](https://paws-r.github.io/docs/iam/create_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the instance profile to create. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -412,10 +412,10 @@ iam_create_group <- function(Path = NULL, GroupName) { #' [IAM #' Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -428,7 +428,7 @@ iam_create_group <- function(Path = NULL, GroupName) { #' more information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -462,13 +462,13 @@ iam_create_instance_profile <- function(InstanceProfileName, Path = NULL, Tags = #' #' @param UserName [required] The name of the IAM user to create a password for. The user must already #' exist. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param Password [required] The new password for the user. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) that is used to #' validate this parameter is a string of characters. That string can #' include almost any printable ASCII character from the space (``U+0020``) @@ -515,7 +515,7 @@ iam_create_login_profile <- function(UserName, Password, PasswordResetRequired = #' parameters are not. Typically the URL consists of only a hostname, like #' `https://server.example.org` or `https://example.com`. The URL should #' not contain a port number. -#' +#' #' You cannot register the same provider multiple times in a single Amazon #' Web Services account. If you try to submit a URL that has already been #' used for an OpenID Connect provider in the Amazon Web Services account, @@ -524,12 +524,12 @@ iam_create_login_profile <- function(UserName, Password, PasswordResetRequired = #' web app registers with an OpenID Connect provider, they establish a #' value that identifies the application. This is the value that's sent as #' the `client_id` parameter on OAuth requests. -#' +#' #' You can register multiple client IDs with the same provider. For #' example, you might have multiple applications that use the same OIDC #' provider. You cannot register more than 100 client IDs with a single IAM #' OIDC provider. -#' +#' #' There is no defined format for a client ID. The #' `CreateOpenIDConnectProviderRequest` operation accepts client IDs up to #' 255 characters long. @@ -538,18 +538,18 @@ iam_create_login_profile <- function(UserName, Password, PasswordResetRequired = #' only one entry. However, IAM lets you have up to five thumbprints for an #' OIDC provider. This lets you maintain multiple thumbprints if the #' identity provider is rotating certificates. -#' +#' #' The server certificate thumbprint is the hex-encoded SHA-1 hash value of #' the X.509 certificate used by the domain where the OpenID Connect #' provider makes its keys available. It is always a 40-character string. -#' +#' #' You must provide at least one thumbprint when creating an IAM OIDC #' provider. For example, assume that the OIDC provider is #' `server.example.com` and the provider stores its keys at #' https://keys.server.example.com/openid-connect. In that case, the #' thumbprint string would be the hex-encoded SHA-1 hash value of the #' certificate used by `https://keys.server.example.com.` -#' +#' #' For more information about obtaining the OIDC provider thumbprint, see #' [Obtaining the thumbprint for an OpenID Connect #' provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html) @@ -559,7 +559,7 @@ iam_create_login_profile <- function(UserName, Password, PasswordResetRequired = #' value. For more information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -592,19 +592,19 @@ iam_create_open_id_connect_provider <- function(Url, ClientIDList = NULL, Thumbp #' See [https://paws-r.github.io/docs/iam/create_policy.html](https://paws-r.github.io/docs/iam/create_policy.html) for full documentation. #' #' @param PolicyName [required] The friendly name of the policy. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". #' @param Path The path for the policy. -#' +#' #' For more information about paths, see [IAM #' identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -612,44 +612,44 @@ iam_create_open_id_connect_provider <- function(Url, ClientIDList = NULL, Thumbp #' ASCII character from the ! (``U+0021``) through the DEL character #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. -#' +#' #' You cannot use an asterisk (*) in the path name. #' @param PolicyDocument [required] The JSON policy document that you want to use as the content for the new #' policy. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to IAM. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' To learn more about JSON policy grammar, see [Grammar of the IAM JSON #' policy #' language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) #' in the *IAM User Guide*. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param Description A friendly description of the policy. -#' +#' #' Typically used to store information about the permissions defined in the #' policy. For example, "Grants access to production DynamoDB tables." -#' +#' #' The policy description is immutable. After a value is assigned, it #' cannot be changed. #' @param Tags A list of tags that you want to attach to the new IAM customer managed @@ -657,7 +657,7 @@ iam_create_open_id_connect_provider <- function(Url, ClientIDList = NULL, Thumbp #' more information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -691,42 +691,42 @@ iam_create_policy <- function(PolicyName, Path = NULL, PolicyDocument, Descripti #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy to which you want to #' add a new version. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param PolicyDocument [required] The JSON policy document that you want to use as the content for this #' new version of the policy. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to IAM. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param SetAsDefault Specifies whether to set this version as the policy's default version. -#' +#' #' When this parameter is `true`, the new policy version becomes the #' operative version. That is, it becomes the version that is in effect for #' the IAM users, groups, and roles that the policy is attached to. -#' +#' #' For more information about managed policy versions, see [Versioning for #' managed #' policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-versioning.html) @@ -762,10 +762,10 @@ iam_create_policy_version <- function(PolicyArn, PolicyDocument, SetAsDefault = #' @param Path The path to the role. For more information about paths, see [IAM #' Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -774,31 +774,31 @@ iam_create_policy_version <- function(PolicyArn, PolicyDocument, SetAsDefault = #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. #' @param RoleName [required] The name of the role to create. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". #' @param AssumeRolePolicyDocument [required] The trust relationship policy document that grants an entity permission #' to assume the role. -#' +#' #' In IAM, you must provide a JSON policy that has been converted to a #' string. However, for CloudFormation templates formatted in YAML, you can #' provide the policy in JSON or YAML format. CloudFormation always #' converts a YAML policy to JSON format before submitting it to IAM. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) -#' +#' #' Upon success, the response includes the same trust policy in JSON #' format. #' @param Description A description of the role. @@ -806,7 +806,7 @@ iam_create_policy_version <- function(PolicyArn, PolicyDocument, SetAsDefault = #' specified role. If you do not specify a value for this setting, the #' default value of one hour is applied. This setting can have a value from #' 1 hour to 12 hours. -#' +#' #' Anyone who assumes the role from the or API can use the #' `DurationSeconds` API parameter or the `duration-seconds` CLI parameter #' to request a longer session. The `MaxSessionDuration` setting determines @@ -825,7 +825,7 @@ iam_create_policy_version <- function(PolicyArn, PolicyDocument, SetAsDefault = #' about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -864,12 +864,12 @@ iam_create_role <- function(Path = NULL, RoleName, AssumeRolePolicyDocument, Des #' authentication response (assertions) that are received from the IdP. You #' must generate the metadata document using the identity management #' software that is used as your organization's IdP. -#' +#' #' For more information, see [About SAML 2.0-based #' federation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) #' in the *IAM User Guide* #' @param Name [required] The name of the provider to create. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -879,7 +879,7 @@ iam_create_role <- function(Path = NULL, RoleName, AssumeRolePolicyDocument, Des #' information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -915,7 +915,7 @@ iam_create_saml_provider <- function(SAMLMetadataDocument, Name, Tags = NULL) { #' @param AWSServiceName [required] The service principal for the Amazon Web Services service to which this #' role is attached. You use a string similar to a URL but without the #' http:// in front. For example: `elasticbeanstalk.amazonaws.com`. -#' +#' #' Service principals are unique and case-sensitive. To find the exact #' service principal for your service-linked role, see [Amazon Web Services #' services that work with @@ -929,7 +929,7 @@ iam_create_saml_provider <- function(SAMLMetadataDocument, Name, Tags = NULL) { #' the same service, then you must supply a different `CustomSuffix` for #' each request. Otherwise the request fails with a duplicate role name #' error. For example, you could add `-1` or `-debug` to the suffix. -#' +#' #' Some services do not support the `CustomSuffix` parameter. If you #' provide an optional suffix and the operation fails, try the operation #' again without the suffix. @@ -966,7 +966,7 @@ iam_create_service_linked_role <- function(AWSServiceName, Description = NULL, C #' The new service-specific credentials have the same permissions as the #' associated user except that they can be used only to access the #' specified service. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1005,10 +1005,10 @@ iam_create_service_specific_credential <- function(UserName, ServiceName) { #' @param Path The path for the user name. For more information about paths, see [IAM #' identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -1017,7 +1017,7 @@ iam_create_service_specific_credential <- function(UserName, ServiceName) { #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. #' @param UserName [required] The name of the user to create. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". @@ -1028,7 +1028,7 @@ iam_create_service_specific_credential <- function(UserName, ServiceName) { #' about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -1064,10 +1064,10 @@ iam_create_user <- function(Path = NULL, UserName, PermissionsBoundary = NULL, T #' see [IAM #' identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -1077,7 +1077,7 @@ iam_create_user <- function(Path = NULL, UserName, PermissionsBoundary = NULL, T #' lowercased letters. #' @param VirtualMFADeviceName [required] The name of the virtual MFA device. Use with path to uniquely identify a #' virtual MFA device. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1087,7 +1087,7 @@ iam_create_user <- function(Path = NULL, UserName, PermissionsBoundary = NULL, T #' more information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -1121,14 +1121,14 @@ iam_create_virtual_mfa_device <- function(Path = NULL, VirtualMFADeviceName, Tag #' See [https://paws-r.github.io/docs/iam/deactivate_mfa_device.html](https://paws-r.github.io/docs/iam/deactivate_mfa_device.html) for full documentation. #' #' @param UserName [required] The name of the user whose MFA device you want to deactivate. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SerialNumber [required] The serial number that uniquely identifies the MFA device. For virtual #' MFA devices, the serial number is the device ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1162,14 +1162,14 @@ iam_deactivate_mfa_device <- function(UserName, SerialNumber) { #' See [https://paws-r.github.io/docs/iam/delete_access_key.html](https://paws-r.github.io/docs/iam/delete_access_key.html) for full documentation. #' #' @param UserName The name of the user whose access key pair you want to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param AccessKeyId [required] The access key ID for the access key ID and secret access key you want #' to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -1197,12 +1197,12 @@ iam_delete_access_key <- function(UserName = NULL, AccessKeyId) { #' Deletes the specified Amazon Web Services account alias #' #' @description -#' Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) in the *IAM User Guide*. +#' Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html) in the *IAM User Guide*. #' #' See [https://paws-r.github.io/docs/iam/delete_account_alias.html](https://paws-r.github.io/docs/iam/delete_account_alias.html) for full documentation. #' #' @param AccountAlias [required] The name of the account alias to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of lowercase letters, digits, and dashes. You cannot start or @@ -1265,7 +1265,7 @@ iam_delete_account_password_policy <- function() { #' See [https://paws-r.github.io/docs/iam/delete_group.html](https://paws-r.github.io/docs/iam/delete_group.html) for full documentation. #' #' @param GroupName [required] The name of the IAM group to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1301,13 +1301,13 @@ iam_delete_group <- function(GroupName) { #' #' @param GroupName [required] The name (friendly name, not ARN) identifying the group that the policy #' is embedded in. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name identifying the policy document to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1341,7 +1341,7 @@ iam_delete_group_policy <- function(GroupName, PolicyName) { #' See [https://paws-r.github.io/docs/iam/delete_instance_profile.html](https://paws-r.github.io/docs/iam/delete_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the instance profile to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1377,7 +1377,7 @@ iam_delete_instance_profile <- function(InstanceProfileName) { #' See [https://paws-r.github.io/docs/iam/delete_login_profile.html](https://paws-r.github.io/docs/iam/delete_login_profile.html) for full documentation. #' #' @param UserName [required] The name of the user whose password you want to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1444,7 +1444,7 @@ iam_delete_open_id_connect_provider <- function(OpenIDConnectProviderArn) { #' See [https://paws-r.github.io/docs/iam/delete_policy.html](https://paws-r.github.io/docs/iam/delete_policy.html) for full documentation. #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to delete. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -1478,18 +1478,18 @@ iam_delete_policy <- function(PolicyArn) { #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy from which you want to #' delete a version. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param VersionId [required] The policy version to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that consists of the lowercase letter 'v' followed by one or two digits, #' and optionally followed by a period '.' and a string of letters and #' digits. -#' +#' #' For more information about managed policy versions, see [Versioning for #' managed #' policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-versioning.html) @@ -1523,7 +1523,7 @@ iam_delete_policy_version <- function(PolicyArn, VersionId) { #' See [https://paws-r.github.io/docs/iam/delete_role.html](https://paws-r.github.io/docs/iam/delete_role.html) for full documentation. #' #' @param RoleName [required] The name of the role to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1589,13 +1589,13 @@ iam_delete_role_permissions_boundary <- function(RoleName) { #' #' @param RoleName [required] The name (friendly name, not ARN) identifying the role that the policy #' is embedded in. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the inline policy to delete from the specified IAM role. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1658,13 +1658,13 @@ iam_delete_saml_provider <- function(SAMLProviderArn) { #' See [https://paws-r.github.io/docs/iam/delete_ssh_public_key.html](https://paws-r.github.io/docs/iam/delete_ssh_public_key.html) for full documentation. #' #' @param UserName [required] The name of the IAM user associated with the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SSHPublicKeyId [required] The unique identifier for the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -1697,7 +1697,7 @@ iam_delete_ssh_public_key <- function(UserName, SSHPublicKeyId) { #' See [https://paws-r.github.io/docs/iam/delete_server_certificate.html](https://paws-r.github.io/docs/iam/delete_server_certificate.html) for full documentation. #' #' @param ServerCertificateName [required] The name of the server certificate you want to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1763,7 +1763,7 @@ iam_delete_service_linked_role <- function(RoleName) { #' @param UserName The name of the IAM user associated with the service-specific #' credential. If this value is not specified, then the operation assumes #' the user whose credentials are used to call the operation. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1771,7 +1771,7 @@ iam_delete_service_linked_role <- function(RoleName) { #' @param ServiceSpecificCredentialId [required] The unique identifier of the service-specific credential. You can get #' this value by calling #' [`list_service_specific_credentials`][iam_list_service_specific_credentials]. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -1804,13 +1804,13 @@ iam_delete_service_specific_credential <- function(UserName = NULL, ServiceSpeci #' See [https://paws-r.github.io/docs/iam/delete_signing_certificate.html](https://paws-r.github.io/docs/iam/delete_signing_certificate.html) for full documentation. #' #' @param UserName The name of the user the signing certificate belongs to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param CertificateId [required] The ID of the signing certificate to delete. -#' +#' #' The format of this parameter, as described by its #' [regex](https://en.wikipedia.org/wiki/Regex) pattern, is a string of #' characters that can be upper- or lower-cased letters or digits. @@ -1843,7 +1843,7 @@ iam_delete_signing_certificate <- function(UserName = NULL, CertificateId) { #' See [https://paws-r.github.io/docs/iam/delete_user.html](https://paws-r.github.io/docs/iam/delete_user.html) for full documentation. #' #' @param UserName [required] The name of the user to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1909,13 +1909,13 @@ iam_delete_user_permissions_boundary <- function(UserName) { #' #' @param UserName [required] The name (friendly name, not ARN) identifying the user that the policy #' is embedded in. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name identifying the policy document to delete. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1950,7 +1950,7 @@ iam_delete_user_policy <- function(UserName, PolicyName) { #' #' @param SerialNumber [required] The serial number that uniquely identifies the MFA device. For virtual #' MFA devices, the serial number is the same as the ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -1985,13 +1985,13 @@ iam_delete_virtual_mfa_device <- function(SerialNumber) { #' #' @param GroupName [required] The name (friendly name, not ARN) of the IAM group to detach the policy #' from. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to detach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2025,13 +2025,13 @@ iam_detach_group_policy <- function(GroupName, PolicyArn) { #' #' @param RoleName [required] The name (friendly name, not ARN) of the IAM role to detach the policy #' from. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to detach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2065,13 +2065,13 @@ iam_detach_role_policy <- function(RoleName, PolicyArn) { #' #' @param UserName [required] The name (friendly name, not ARN) of the IAM user to detach the policy #' from. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy you want to detach. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2105,22 +2105,22 @@ iam_detach_user_policy <- function(UserName, PolicyArn) { #' See [https://paws-r.github.io/docs/iam/enable_mfa_device.html](https://paws-r.github.io/docs/iam/enable_mfa_device.html) for full documentation. #' #' @param UserName [required] The name of the IAM user for whom you want to enable the MFA device. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SerialNumber [required] The serial number that uniquely identifies the MFA device. For virtual #' MFA devices, the serial number is the device ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: =,.@@:/- #' @param AuthenticationCode1 [required] An authentication code emitted by the device. -#' +#' #' The format for this parameter is a string of six digits. -#' +#' #' Submit your request immediately after generating the authentication #' codes. If you generate the codes and then wait too long to submit the #' request, the MFA device successfully associates with the user but the @@ -2129,9 +2129,9 @@ iam_detach_user_policy <- function(UserName, PolicyArn) { #' you can [resync the #' device](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html). #' @param AuthenticationCode2 [required] A subsequent authentication code emitted by the device. -#' +#' #' The format for this parameter is a string of six digits. -#' +#' #' Submit your request immediately after generating the authentication #' codes. If you generate the codes and then wait too long to submit the #' request, the MFA device successfully associates with the user but the @@ -2205,7 +2205,7 @@ iam_generate_credential_report <- function() { #' `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012`. #' @param OrganizationsPolicyId The identifier of the Organizations service control policy (SCP). This #' parameter is optional. -#' +#' #' This ID is used to generate information about when an account principal #' that is limited by the SCP attempted to access an Amazon Web Services #' service. @@ -2277,7 +2277,7 @@ iam_generate_service_last_accessed_details <- function(Arn, Granularity = NULL) #' See [https://paws-r.github.io/docs/iam/get_access_key_last_used.html](https://paws-r.github.io/docs/iam/get_access_key_last_used.html) for full documentation. #' #' @param AccessKeyId [required] The identifier of an access key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -2314,14 +2314,14 @@ iam_get_access_key_last_used <- function(AccessKeyId) { #' @param Filter A list of entity types used to filter the results. Only the entities #' that match the types you specify are included in the output. Use the #' value `LocalManagedPolicy` to include customer managed policies. -#' +#' #' The format for this parameter is a comma-separated (if more than one) #' list of strings. Each string value in the list must be one of the valid #' values listed below. #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -2421,17 +2421,17 @@ iam_get_account_summary <- function() { #' @param PolicyInputList [required] A list of policies for which you want the list of context keys #' referenced in those policies. Each document is specified as a string #' containing the complete, valid JSON text of an IAM policy. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -2471,23 +2471,23 @@ iam_get_context_keys_for_custom_policy <- function(PolicyInputList) { #' that are found in policies attached to that entity. Note that all #' parameters are shown in unencoded form here for clarity, but must be URL #' encoded to be included as a part of a real HTML request. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param PolicyInputList An optional list of additional policies for which you want the list of #' context keys that are referenced. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -2548,7 +2548,7 @@ iam_get_credential_report <- function() { #' See [https://paws-r.github.io/docs/iam/get_group.html](https://paws-r.github.io/docs/iam/get_group.html) for full documentation. #' #' @param GroupName [required] The name of the group. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2560,7 +2560,7 @@ iam_get_credential_report <- function() { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -2596,13 +2596,13 @@ iam_get_group <- function(GroupName, Marker = NULL, MaxItems = NULL) { #' See [https://paws-r.github.io/docs/iam/get_group_policy.html](https://paws-r.github.io/docs/iam/get_group_policy.html) for full documentation. #' #' @param GroupName [required] The name of the group the policy is associated with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the policy document to get. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2637,7 +2637,7 @@ iam_get_group_policy <- function(GroupName, PolicyName) { #' See [https://paws-r.github.io/docs/iam/get_instance_profile.html](https://paws-r.github.io/docs/iam/get_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the instance profile to get information about. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2671,7 +2671,7 @@ iam_get_instance_profile <- function(InstanceProfileName) { #' See [https://paws-r.github.io/docs/iam/get_login_profile.html](https://paws-r.github.io/docs/iam/get_login_profile.html) for full documentation. #' #' @param UserName [required] The name of the user whose login profile you want to retrieve. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2710,7 +2710,7 @@ iam_get_login_profile <- function(UserName) { #' ARNs by using the #' [`list_open_id_connect_providers`][iam_list_open_id_connect_providers] #' operation. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2750,7 +2750,7 @@ iam_get_open_id_connect_provider <- function(OpenIDConnectProviderArn) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -2795,7 +2795,7 @@ iam_get_organizations_access_report <- function(JobId, MaxItems = NULL, Marker = #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the managed policy that you want #' information about. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2830,12 +2830,12 @@ iam_get_policy <- function(PolicyArn) { #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the managed policy that you want #' information about. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param VersionId [required] Identifies the policy version to retrieve. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that consists of the lowercase letter 'v' followed by one or two digits, @@ -2872,7 +2872,7 @@ iam_get_policy_version <- function(PolicyArn, VersionId) { #' See [https://paws-r.github.io/docs/iam/get_role.html](https://paws-r.github.io/docs/iam/get_role.html) for full documentation. #' #' @param RoleName [required] The name of the IAM role to get information about. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2907,13 +2907,13 @@ iam_get_role <- function(RoleName) { #' See [https://paws-r.github.io/docs/iam/get_role_policy.html](https://paws-r.github.io/docs/iam/get_role_policy.html) for full documentation. #' #' @param RoleName [required] The name of the role associated with the policy. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the policy document to get. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -2949,7 +2949,7 @@ iam_get_role_policy <- function(RoleName, PolicyName) { #' #' @param SAMLProviderArn [required] The Amazon Resource Name (ARN) of the SAML provider resource object in #' IAM to get information about. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -2982,13 +2982,13 @@ iam_get_saml_provider <- function(SAMLProviderArn) { #' See [https://paws-r.github.io/docs/iam/get_ssh_public_key.html](https://paws-r.github.io/docs/iam/get_ssh_public_key.html) for full documentation. #' #' @param UserName [required] The name of the IAM user associated with the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SSHPublicKeyId [required] The unique identifier for the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -3026,7 +3026,7 @@ iam_get_ssh_public_key <- function(UserName, SSHPublicKeyId, Encoding) { #' #' @param ServerCertificateName [required] The name of the server certificate you want to retrieve information #' about. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3068,7 +3068,7 @@ iam_get_server_certificate <- function(ServerCertificateName) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3114,7 +3114,7 @@ iam_get_service_last_accessed_details <- function(JobId, MaxItems = NULL, Marker #' @param ServiceNamespace [required] The service namespace for an Amazon Web Services service. Provide the #' service namespace to learn when the IAM entity last attempted to access #' the specified service. -#' +#' #' To learn the service namespace for a service, see [Actions, resources, #' and condition keys for Amazon Web Services #' services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) @@ -3127,7 +3127,7 @@ iam_get_service_last_accessed_details <- function(JobId, MaxItems = NULL, Marker #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3199,7 +3199,7 @@ iam_get_service_linked_role_deletion_status <- function(DeletionTaskId) { #' See [https://paws-r.github.io/docs/iam/get_user.html](https://paws-r.github.io/docs/iam/get_user.html) for full documentation. #' #' @param UserName The name of the user to get information about. -#' +#' #' This parameter is optional. If it is not included, it defaults to the #' user making the request. This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters @@ -3235,13 +3235,13 @@ iam_get_user <- function(UserName = NULL) { #' See [https://paws-r.github.io/docs/iam/get_user_policy.html](https://paws-r.github.io/docs/iam/get_user_policy.html) for full documentation. #' #' @param UserName [required] The name of the user who the policy is associated with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the policy document to get. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3276,7 +3276,7 @@ iam_get_user_policy <- function(UserName, PolicyName) { #' See [https://paws-r.github.io/docs/iam/list_access_keys.html](https://paws-r.github.io/docs/iam/list_access_keys.html) for full documentation. #' #' @param UserName The name of the user. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3288,7 +3288,7 @@ iam_get_user_policy <- function(UserName, PolicyName) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3319,7 +3319,7 @@ iam_list_access_keys <- function(UserName = NULL, Marker = NULL, MaxItems = NULL #' (Note: you can have only one) #' #' @description -#' Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) in the *IAM User Guide*. +#' Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see [Using an alias for your Amazon Web Services account ID](https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html) in the *IAM User Guide*. #' #' See [https://paws-r.github.io/docs/iam/list_account_aliases.html](https://paws-r.github.io/docs/iam/list_account_aliases.html) for full documentation. #' @@ -3330,7 +3330,7 @@ iam_list_access_keys <- function(UserName = NULL, Marker = NULL, MaxItems = NULL #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3366,14 +3366,14 @@ iam_list_account_aliases <- function(Marker = NULL, MaxItems = NULL) { #' #' @param GroupName [required] The name (friendly name, not ARN) of the group to list attached policies #' for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PathPrefix The path prefix for filtering the results. This parameter is optional. #' If it is not included, it defaults to a slash (/), listing all policies. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -3388,7 +3388,7 @@ iam_list_account_aliases <- function(Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3424,14 +3424,14 @@ iam_list_attached_group_policies <- function(GroupName, PathPrefix = NULL, Marke #' #' @param RoleName [required] The name (friendly name, not ARN) of the role to list attached policies #' for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PathPrefix The path prefix for filtering the results. This parameter is optional. #' If it is not included, it defaults to a slash (/), listing all policies. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -3446,7 +3446,7 @@ iam_list_attached_group_policies <- function(GroupName, PathPrefix = NULL, Marke #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3482,14 +3482,14 @@ iam_list_attached_role_policies <- function(RoleName, PathPrefix = NULL, Marker #' #' @param UserName [required] The name (friendly name, not ARN) of the user to list attached policies #' for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PathPrefix The path prefix for filtering the results. This parameter is optional. #' If it is not included, it defaults to a slash (/), listing all policies. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -3504,7 +3504,7 @@ iam_list_attached_role_policies <- function(RoleName, PathPrefix = NULL, Marker #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3541,12 +3541,12 @@ iam_list_attached_user_policies <- function(UserName, PathPrefix = NULL, Marker #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy for which you want the #' versions. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param EntityFilter The entity type to use for filtering the results. -#' +#' #' For example, when `EntityFilter` is `Role`, only the roles that are #' attached to the specified policy are returned. This parameter is #' optional. If it is not included, all attached entities (users, groups, @@ -3554,7 +3554,7 @@ iam_list_attached_user_policies <- function(UserName, PathPrefix = NULL, Marker #' the valid values listed below. #' @param PathPrefix The path prefix for filtering the results. This parameter is optional. #' If it is not included, it defaults to a slash (/), listing all entities. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -3563,12 +3563,12 @@ iam_list_attached_user_policies <- function(UserName, PathPrefix = NULL, Marker #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. #' @param PolicyUsageFilter The policy usage method to use for filtering the results. -#' +#' #' To list only permissions policies, #' set `PolicyUsageFilter` to `PermissionsPolicy`. To list only the #' policies used to set permissions boundaries, set the value #' to `PermissionsBoundary`. -#' +#' #' This parameter is optional. If it is not included, all policies are #' returned. #' @param Marker Use this parameter only when paginating results and only after you @@ -3578,7 +3578,7 @@ iam_list_attached_user_policies <- function(UserName, PathPrefix = NULL, Marker #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3614,7 +3614,7 @@ iam_list_entities_for_policy <- function(PolicyArn, EntityFilter = NULL, PathPre #' See [https://paws-r.github.io/docs/iam/list_group_policies.html](https://paws-r.github.io/docs/iam/list_group_policies.html) for full documentation. #' #' @param GroupName [required] The name of the group to list policies for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3626,7 +3626,7 @@ iam_list_entities_for_policy <- function(PolicyArn, EntityFilter = NULL, PathPre #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3663,7 +3663,7 @@ iam_list_group_policies <- function(GroupName, Marker = NULL, MaxItems = NULL) { #' @param PathPrefix The path prefix for filtering the results. For example, the prefix #' `/division_abc/subdivision_xyz/` gets all groups whose path starts with #' `/division_abc/subdivision_xyz/`. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/), listing all groups. This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters @@ -3679,7 +3679,7 @@ iam_list_group_policies <- function(GroupName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3714,7 +3714,7 @@ iam_list_groups <- function(PathPrefix = NULL, Marker = NULL, MaxItems = NULL) { #' See [https://paws-r.github.io/docs/iam/list_groups_for_user.html](https://paws-r.github.io/docs/iam/list_groups_for_user.html) for full documentation. #' #' @param UserName [required] The name of the user to list groups for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3726,7 +3726,7 @@ iam_list_groups <- function(PathPrefix = NULL, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3761,7 +3761,7 @@ iam_list_groups_for_user <- function(UserName, Marker = NULL, MaxItems = NULL) { #' See [https://paws-r.github.io/docs/iam/list_instance_profile_tags.html](https://paws-r.github.io/docs/iam/list_instance_profile_tags.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the IAM instance profile whose tags you want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3773,7 +3773,7 @@ iam_list_groups_for_user <- function(UserName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3810,7 +3810,7 @@ iam_list_instance_profile_tags <- function(InstanceProfileName, Marker = NULL, M #' @param PathPrefix The path prefix for filtering the results. For example, the prefix #' `/application_abc/component_xyz/` gets all instance profiles whose path #' starts with `/application_abc/component_xyz/`. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/), listing all instance profiles. This parameter allows (through #' its [regex pattern](https://en.wikipedia.org/wiki/Regex)) a string of @@ -3826,7 +3826,7 @@ iam_list_instance_profile_tags <- function(InstanceProfileName, Marker = NULL, M #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3861,7 +3861,7 @@ iam_list_instance_profiles <- function(PathPrefix = NULL, Marker = NULL, MaxItem #' See [https://paws-r.github.io/docs/iam/list_instance_profiles_for_role.html](https://paws-r.github.io/docs/iam/list_instance_profiles_for_role.html) for full documentation. #' #' @param RoleName [required] The name of the role to list instance profiles for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3873,7 +3873,7 @@ iam_list_instance_profiles <- function(PathPrefix = NULL, Marker = NULL, MaxItem #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3911,7 +3911,7 @@ iam_list_instance_profiles_for_role <- function(RoleName, Marker = NULL, MaxItem #' @param SerialNumber [required] The unique identifier for the IAM virtual MFA device whose tags you want #' to see. For virtual MFA devices, the serial number is the same as the #' ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3923,7 +3923,7 @@ iam_list_instance_profiles_for_role <- function(RoleName, Marker = NULL, MaxItem #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -3958,7 +3958,7 @@ iam_list_mfa_device_tags <- function(SerialNumber, Marker = NULL, MaxItems = NUL #' See [https://paws-r.github.io/docs/iam/list_mfa_devices.html](https://paws-r.github.io/docs/iam/list_mfa_devices.html) for full documentation. #' #' @param UserName The name of the user whose MFA devices you want to list. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -3970,7 +3970,7 @@ iam_list_mfa_device_tags <- function(SerialNumber, Marker = NULL, MaxItems = NUL #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4007,7 +4007,7 @@ iam_list_mfa_devices <- function(UserName = NULL, Marker = NULL, MaxItems = NULL #' #' @param OpenIDConnectProviderArn [required] The ARN of the OpenID Connect (OIDC) identity provider whose tags you #' want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4019,7 +4019,7 @@ iam_list_mfa_devices <- function(UserName = NULL, Marker = NULL, MaxItems = NULL #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4084,15 +4084,15 @@ iam_list_open_id_connect_providers <- function() { #' See [https://paws-r.github.io/docs/iam/list_policies.html](https://paws-r.github.io/docs/iam/list_policies.html) for full documentation. #' #' @param Scope The scope to use for filtering the results. -#' +#' #' To list only Amazon Web Services managed policies, set `Scope` to `AWS`. #' To list only the customer managed policies in your Amazon Web Services #' account, set `Scope` to `Local`. -#' +#' #' This parameter is optional. If it is not included, or if it is set to #' `All`, all policies are returned. #' @param OnlyAttached A flag to filter the results to only the attached policies. -#' +#' #' When `OnlyAttached` is `true`, the returned list contains only the #' policies that are attached to an IAM user, group, or role. When #' `OnlyAttached` is `false`, or when the parameter is not included, all @@ -4107,12 +4107,12 @@ iam_list_open_id_connect_providers <- function() { #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. #' @param PolicyUsageFilter The policy usage method to use for filtering the results. -#' +#' #' To list only permissions policies, #' set `PolicyUsageFilter` to `PermissionsPolicy`. To list only the #' policies used to set permissions boundaries, set the value #' to `PermissionsBoundary`. -#' +#' #' This parameter is optional. If it is not included, all policies are #' returned. #' @param Marker Use this parameter only when paginating results and only after you @@ -4122,7 +4122,7 @@ iam_list_open_id_connect_providers <- function() { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4165,7 +4165,7 @@ iam_list_policies <- function(Scope = NULL, OnlyAttached = NULL, PathPrefix = NU #' want to list. #' @param ServiceNamespaces [required] The service namespace for the Amazon Web Services services whose #' policies you want to list. -#' +#' #' To learn the service namespace for a service, see [Actions, resources, #' and condition keys for Amazon Web Services #' services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) @@ -4205,7 +4205,7 @@ iam_list_policies_granting_service_access <- function(Marker = NULL, Arn, Servic #' See [https://paws-r.github.io/docs/iam/list_policy_tags.html](https://paws-r.github.io/docs/iam/list_policy_tags.html) for full documentation. #' #' @param PolicyArn [required] The ARN of the IAM customer managed policy whose tags you want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4217,7 +4217,7 @@ iam_list_policies_granting_service_access <- function(Marker = NULL, Arn, Servic #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4255,7 +4255,7 @@ iam_list_policy_tags <- function(PolicyArn, Marker = NULL, MaxItems = NULL) { #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy for which you want the #' versions. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -4266,7 +4266,7 @@ iam_list_policy_tags <- function(PolicyArn, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4302,7 +4302,7 @@ iam_list_policy_versions <- function(PolicyArn, Marker = NULL, MaxItems = NULL) #' See [https://paws-r.github.io/docs/iam/list_role_policies.html](https://paws-r.github.io/docs/iam/list_role_policies.html) for full documentation. #' #' @param RoleName [required] The name of the role to list policies for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4314,7 +4314,7 @@ iam_list_policy_versions <- function(PolicyArn, Marker = NULL, MaxItems = NULL) #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4349,7 +4349,7 @@ iam_list_role_policies <- function(RoleName, Marker = NULL, MaxItems = NULL) { #' See [https://paws-r.github.io/docs/iam/list_role_tags.html](https://paws-r.github.io/docs/iam/list_role_tags.html) for full documentation. #' #' @param RoleName [required] The name of the IAM role for which you want to see the list of tags. -#' +#' #' This parameter accepts (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that consist of upper and lowercase alphanumeric characters with no @@ -4361,7 +4361,7 @@ iam_list_role_policies <- function(RoleName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4398,7 +4398,7 @@ iam_list_role_tags <- function(RoleName, Marker = NULL, MaxItems = NULL) { #' @param PathPrefix The path prefix for filtering the results. For example, the prefix #' `/application_abc/component_xyz/` gets all roles whose path starts with #' `/application_abc/component_xyz/`. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/), listing all roles. This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters @@ -4414,7 +4414,7 @@ iam_list_role_tags <- function(RoleName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4451,7 +4451,7 @@ iam_list_roles <- function(PathPrefix = NULL, Marker = NULL, MaxItems = NULL) { #' #' @param SAMLProviderArn [required] The ARN of the Security Assertion Markup Language (SAML) identity #' provider whose tags you want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4463,7 +4463,7 @@ iam_list_roles <- function(PathPrefix = NULL, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4528,7 +4528,7 @@ iam_list_saml_providers <- function() { #' @param UserName The name of the IAM user to list SSH public keys for. If none is #' specified, the `UserName` field is determined implicitly based on the #' Amazon Web Services access key used to sign the request. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4540,7 +4540,7 @@ iam_list_saml_providers <- function() { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4575,7 +4575,7 @@ iam_list_ssh_public_keys <- function(UserName = NULL, Marker = NULL, MaxItems = #' See [https://paws-r.github.io/docs/iam/list_server_certificate_tags.html](https://paws-r.github.io/docs/iam/list_server_certificate_tags.html) for full documentation. #' #' @param ServerCertificateName [required] The name of the IAM server certificate whose tags you want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4587,7 +4587,7 @@ iam_list_ssh_public_keys <- function(UserName = NULL, Marker = NULL, MaxItems = #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4625,7 +4625,7 @@ iam_list_server_certificate_tags <- function(ServerCertificateName, Marker = NUL #' @param PathPrefix The path prefix for filtering the results. For example: #' `/company/servercerts` would get all server certificates for which the #' path starts with `/company/servercerts`. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/), listing all server certificates. This parameter allows #' (through its [regex pattern](https://en.wikipedia.org/wiki/Regex)) a @@ -4641,7 +4641,7 @@ iam_list_server_certificate_tags <- function(ServerCertificateName, Marker = NUL #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4679,7 +4679,7 @@ iam_list_server_certificates <- function(PathPrefix = NULL, Marker = NULL, MaxIt #' @param UserName The name of the user whose service-specific credentials you want #' information about. If this value is not specified, then the operation #' assumes the user whose credentials are used to call the operation. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4717,7 +4717,7 @@ iam_list_service_specific_credentials <- function(UserName = NULL, ServiceName = #' See [https://paws-r.github.io/docs/iam/list_signing_certificates.html](https://paws-r.github.io/docs/iam/list_signing_certificates.html) for full documentation. #' #' @param UserName The name of the IAM user whose signing certificates you want to examine. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4729,7 +4729,7 @@ iam_list_service_specific_credentials <- function(UserName = NULL, ServiceName = #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4765,7 +4765,7 @@ iam_list_signing_certificates <- function(UserName = NULL, Marker = NULL, MaxIte #' See [https://paws-r.github.io/docs/iam/list_user_policies.html](https://paws-r.github.io/docs/iam/list_user_policies.html) for full documentation. #' #' @param UserName [required] The name of the user to list policies for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4777,7 +4777,7 @@ iam_list_signing_certificates <- function(UserName = NULL, Marker = NULL, MaxIte #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4812,7 +4812,7 @@ iam_list_user_policies <- function(UserName, Marker = NULL, MaxItems = NULL) { #' See [https://paws-r.github.io/docs/iam/list_user_tags.html](https://paws-r.github.io/docs/iam/list_user_tags.html) for full documentation. #' #' @param UserName [required] The name of the IAM user whose tags you want to see. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -4824,7 +4824,7 @@ iam_list_user_policies <- function(UserName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4861,7 +4861,7 @@ iam_list_user_tags <- function(UserName, Marker = NULL, MaxItems = NULL) { #' @param PathPrefix The path prefix for filtering the results. For example: #' `/division_abc/subdivision_xyz/`, which would get all user names whose #' path starts with `/division_abc/subdivision_xyz/`. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/), listing all user names. This parameter allows (through its #' [regex pattern](https://en.wikipedia.org/wiki/Regex)) a string of @@ -4877,7 +4877,7 @@ iam_list_user_tags <- function(UserName, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4922,7 +4922,7 @@ iam_list_users <- function(PathPrefix = NULL, Marker = NULL, MaxItems = NULL) { #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -4958,34 +4958,34 @@ iam_list_virtual_mfa_devices <- function(AssignmentStatus = NULL, Marker = NULL, #' See [https://paws-r.github.io/docs/iam/put_group_policy.html](https://paws-r.github.io/docs/iam/put_group_policy.html) for full documentation. #' #' @param GroupName [required] The name of the group to associate the policy with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@-. #' @param PolicyName [required] The name of the policy document. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyDocument [required] The policy document. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to = IAM. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -5051,34 +5051,34 @@ iam_put_role_permissions_boundary <- function(RoleName, PermissionsBoundary) { #' See [https://paws-r.github.io/docs/iam/put_role_policy.html](https://paws-r.github.io/docs/iam/put_role_policy.html) for full documentation. #' #' @param RoleName [required] The name of the role to associate the policy with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the policy document. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyDocument [required] The policy document. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to IAM. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -5144,34 +5144,34 @@ iam_put_user_permissions_boundary <- function(UserName, PermissionsBoundary) { #' See [https://paws-r.github.io/docs/iam/put_user_policy.html](https://paws-r.github.io/docs/iam/put_user_policy.html) for full documentation. #' #' @param UserName [required] The name of the user to associate the policy with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyName [required] The name of the policy document. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyDocument [required] The policy document. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to IAM. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -5209,7 +5209,7 @@ iam_put_user_policy <- function(UserName, PolicyName, PolicyDocument) { #' using the #' [`list_open_id_connect_providers`][iam_list_open_id_connect_providers] #' operation. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -5245,13 +5245,13 @@ iam_remove_client_id_from_open_id_connect_provider <- function(OpenIDConnectProv #' See [https://paws-r.github.io/docs/iam/remove_role_from_instance_profile.html](https://paws-r.github.io/docs/iam/remove_role_from_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the instance profile to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param RoleName [required] The name of the role to remove. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -5285,13 +5285,13 @@ iam_remove_role_from_instance_profile <- function(InstanceProfileName, RoleName) #' See [https://paws-r.github.io/docs/iam/remove_user_from_group.html](https://paws-r.github.io/docs/iam/remove_user_from_group.html) for full documentation. #' #' @param GroupName [required] The name of the group to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param UserName [required] The name of the user to remove. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -5327,13 +5327,13 @@ iam_remove_user_from_group <- function(GroupName, UserName) { #' @param UserName The name of the IAM user associated with the service-specific #' credential. If this value is not specified, then the operation assumes #' the user whose credentials are used to call the operation. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param ServiceSpecificCredentialId [required] The unique identifier of the service-specific credential. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -5367,22 +5367,22 @@ iam_reset_service_specific_credential <- function(UserName = NULL, ServiceSpecif #' See [https://paws-r.github.io/docs/iam/resync_mfa_device.html](https://paws-r.github.io/docs/iam/resync_mfa_device.html) for full documentation. #' #' @param UserName [required] The name of the user whose MFA device you want to resynchronize. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SerialNumber [required] Serial number that uniquely identifies the MFA device. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param AuthenticationCode1 [required] An authentication code emitted by the device. -#' +#' #' The format for this parameter is a sequence of six digits. #' @param AuthenticationCode2 [required] A subsequent authentication code emitted by the device. -#' +#' #' The format for this parameter is a sequence of six digits. #' #' @keywords internal @@ -5415,12 +5415,12 @@ iam_resync_mfa_device <- function(UserName, SerialNumber, AuthenticationCode1, A #' #' @param PolicyArn [required] The Amazon Resource Name (ARN) of the IAM policy whose default version #' you want to set. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param VersionId [required] The version of the policy to set as the default (operative) version. -#' +#' #' For more information about managed policy versions, see [Versioning for #' managed #' policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-versioning.html) @@ -5460,7 +5460,7 @@ iam_set_default_policy_version <- function(PolicyArn, VersionId) { #' (Hong Kong). Version 2 tokens are valid in all Regions. However, version #' 2 tokens are longer and might affect systems where you temporarily store #' tokens. -#' +#' #' For information, see [Activating and deactivating STS in an Amazon Web #' Services #' Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) @@ -5506,23 +5506,23 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' [AssumeRole](https://docs.aws.amazon.com/IAM/latest/APIReference/) API #' operations. In other words, do not use policies designed to restrict #' what a user can do while using the temporary credentials. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param PermissionsBoundaryPolicyInputList The IAM permissions boundary policy to simulate. The permissions @@ -5533,23 +5533,23 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) #' in the *IAM User Guide*. The policy input is specified as a string that #' contains the complete, valid JSON text of a permissions boundary policy. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param ActionNames [required] A list of names of API operations to evaluate in the simulation. Each @@ -5563,16 +5563,16 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' access result (allowed or denied) of each combination and reports it in #' the response. You can simulate resources that don't exist in your #' account. -#' +#' #' The simulation does not automatically retrieve policies for the #' specified resources. If you want to include a resource policy in the #' simulation, then you must include the policy as a string in the #' `ResourcePolicy` parameter. -#' +#' #' If you include a `ResourcePolicy`, then it must be applicable to all of #' the resources included in the simulation or you receive an invalid input #' error. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -5580,23 +5580,23 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' string. Each resource in the simulation is treated as if it had this #' policy attached. You can include only one resource-based policy in a #' simulation. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param ResourceOwner An ARN representing the Amazon Web Services account ID that specifies @@ -5610,7 +5610,7 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' specify a resource-based policy and account that owns the resource is #' different from the account that owns the simulated calling user #' `CallerArn`. -#' +#' #' The ARN for an account uses the following syntax: #' `arn:aws:iam::AWS-account-ID:root`. For example, to represent the #' account with the 112233445566 ID, use the following ARN: @@ -5619,7 +5619,7 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' the API operations. `CallerArn` is required if you include a #' `ResourcePolicy` so that the policy's `Principal` element has a value to #' use in evaluating the policy. -#' +#' #' You can specify only the ARN of an IAM user. You cannot specify the ARN #' of an assumed role, federated user, or a service principal. #' @param ContextEntries A list of context keys and corresponding values for the simulation to @@ -5633,7 +5633,7 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' one of the following scenarios, then you can omit this parameter. The #' following list shows each of the supported scenario values and the #' resources that you must define to run the simulation. -#' +#' #' Each of the EC2 scenarios requires that you specify instance, image, and #' security-group resources. If your scenario includes an EBS volume, then #' you must specify that volume as a resource. If the EC2 scenario includes @@ -5642,34 +5642,34 @@ iam_set_security_token_service_preferences <- function(GlobalEndpointTokenVersio #' information on the EC2 scenario options, see [Supported #' platforms](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html) #' in the *Amazon EC2 User Guide*. -#' +#' #' - **EC2-Classic-InstanceStore** -#' +#' #' instance, image, security-group -#' +#' #' - **EC2-Classic-EBS** -#' +#' #' instance, image, security-group, volume -#' +#' #' - **EC2-VPC-InstanceStore** -#' +#' #' instance, image, security-group, network-interface -#' +#' #' - **EC2-VPC-InstanceStore-Subnet** -#' +#' #' instance, image, security-group, network-interface, subnet -#' +#' #' - **EC2-VPC-EBS** -#' +#' #' instance, image, security-group, network-interface, volume -#' +#' #' - **EC2-VPC-EBS-Subnet** -#' +#' #' instance, image, security-group, network-interface, subnet, volume #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -5714,30 +5714,30 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' role, the simulation includes all policies that are associated with that #' entity. If you specify a user, the simulation also includes all policies #' that are attached to any groups the user belongs to. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. #' @param PolicyInputList An optional list of additional policy documents to include in the #' simulation. Each document is specified as a string containing the #' complete, valid JSON text of an IAM policy. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param PermissionsBoundaryPolicyInputList The IAM permissions boundary policy to simulate. The permissions @@ -5753,23 +5753,23 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' in the *IAM User Guide*. The policy input is specified as a string #' containing the complete, valid JSON text of a permissions boundary #' policy. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param ActionNames [required] A list of names of API operations to evaluate in the simulation. Each @@ -5782,12 +5782,12 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' access result (allowed or denied) of each combination and reports it in #' the response. You can simulate resources that don't exist in your #' account. -#' +#' #' The simulation does not automatically retrieve policies for the #' specified resources. If you want to include a resource policy in the #' simulation, then you must include the policy as a string in the #' `ResourcePolicy` parameter. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -5795,23 +5795,23 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' string. Each resource in the simulation is treated as if it had this #' policy attached. You can include only one resource-based policy in a #' simulation. -#' +#' #' The maximum length of the policy document that you can pass in this #' operation, including whitespace, is listed below. To view the maximum #' character counts of a managed policy with no whitespaces, see [IAM and #' STS character #' quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param ResourceOwner An Amazon Web Services account ID that specifies the owner of any @@ -5831,15 +5831,15 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' `arn:aws:iam::123456789012:user/David`) and a `CallerArn` (for example, #' `arn:aws:iam::123456789012:user/Bob`), the result is that you simulate #' calling the API operations as Bob, as if Bob had David's policies. -#' +#' #' You can specify only the ARN of an IAM user. You cannot specify the ARN #' of an assumed role, federated user, or a service principal. -#' +#' #' `CallerArn` is required if you include a `ResourcePolicy` and the #' `PolicySourceArn` is not the ARN for an IAM user. This is required so #' that the resource-based policy's `Principal` element has a value to use #' in evaluating the policy. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -5854,7 +5854,7 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' one of the following scenarios, then you can omit this parameter. The #' following list shows each of the supported scenario values and the #' resources that you must define to run the simulation. -#' +#' #' Each of the EC2 scenarios requires that you specify instance, image, and #' security group resources. If your scenario includes an EBS volume, then #' you must specify that volume as a resource. If the EC2 scenario includes @@ -5863,34 +5863,34 @@ iam_simulate_custom_policy <- function(PolicyInputList, PermissionsBoundaryPolic #' information on the EC2 scenario options, see [Supported #' platforms](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html) #' in the *Amazon EC2 User Guide*. -#' +#' #' - **EC2-Classic-InstanceStore** -#' +#' #' instance, image, security group -#' +#' #' - **EC2-Classic-EBS** -#' +#' #' instance, image, security group, volume -#' +#' #' - **EC2-VPC-InstanceStore** -#' +#' #' instance, image, security group, network interface -#' +#' #' - **EC2-VPC-InstanceStore-Subnet** -#' +#' #' instance, image, security group, network interface, subnet -#' +#' #' - **EC2-VPC-EBS** -#' +#' #' instance, image, security group, network interface, volume -#' +#' #' - **EC2-VPC-EBS-Subnet** -#' +#' #' instance, image, security group, network interface, subnet, volume #' @param MaxItems Use this only when paginating results to indicate the maximum number of #' items you want in the response. If additional items exist beyond the #' maximum you specify, the `IsTruncated` response element is `true`. -#' +#' #' If you do not include this parameter, the number of items defaults to #' 100. Note that IAM might return fewer results, even when there are more #' results available. In that case, the `IsTruncated` response element @@ -5929,7 +5929,7 @@ iam_simulate_principal_policy <- function(PolicySourceArn, PolicyInputList = NUL #' See [https://paws-r.github.io/docs/iam/tag_instance_profile.html](https://paws-r.github.io/docs/iam/tag_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the IAM instance profile to which you want to add tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -5968,7 +5968,7 @@ iam_tag_instance_profile <- function(InstanceProfileName, Tags) { #' @param SerialNumber [required] The unique identifier for the IAM virtual MFA device to which you want #' to add tags. For virtual MFA devices, the serial number is the same as #' the ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6006,7 +6006,7 @@ iam_tag_mfa_device <- function(SerialNumber, Tags) { #' #' @param OpenIDConnectProviderArn [required] The ARN of the OIDC identity provider in IAM to which you want to add #' tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6043,7 +6043,7 @@ iam_tag_open_id_connect_provider <- function(OpenIDConnectProviderArn, Tags) { #' #' @param PolicyArn [required] The ARN of the IAM customer managed policy to which you want to add #' tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6079,7 +6079,7 @@ iam_tag_policy <- function(PolicyArn, Tags) { #' See [https://paws-r.github.io/docs/iam/tag_role.html](https://paws-r.github.io/docs/iam/tag_role.html) for full documentation. #' #' @param RoleName [required] The name of the IAM role to which you want to add tags. -#' +#' #' This parameter accepts (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that consist of upper and lowercase alphanumeric characters with no @@ -6117,7 +6117,7 @@ iam_tag_role <- function(RoleName, Tags) { #' #' @param SAMLProviderArn [required] The ARN of the SAML identity provider in IAM to which you want to add #' tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6153,7 +6153,7 @@ iam_tag_saml_provider <- function(SAMLProviderArn, Tags) { #' See [https://paws-r.github.io/docs/iam/tag_server_certificate.html](https://paws-r.github.io/docs/iam/tag_server_certificate.html) for full documentation. #' #' @param ServerCertificateName [required] The name of the IAM server certificate to which you want to add tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6189,7 +6189,7 @@ iam_tag_server_certificate <- function(ServerCertificateName, Tags) { #' See [https://paws-r.github.io/docs/iam/tag_user.html](https://paws-r.github.io/docs/iam/tag_user.html) for full documentation. #' #' @param UserName [required] The name of the IAM user to which you want to add tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6225,7 +6225,7 @@ iam_tag_user <- function(UserName, Tags) { #' See [https://paws-r.github.io/docs/iam/untag_instance_profile.html](https://paws-r.github.io/docs/iam/untag_instance_profile.html) for full documentation. #' #' @param InstanceProfileName [required] The name of the IAM instance profile from which you want to remove tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6264,7 +6264,7 @@ iam_untag_instance_profile <- function(InstanceProfileName, TagKeys) { #' @param SerialNumber [required] The unique identifier for the IAM virtual MFA device from which you want #' to remove tags. For virtual MFA devices, the serial number is the same #' as the ARN. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6301,7 +6301,7 @@ iam_untag_mfa_device <- function(SerialNumber, TagKeys) { #' See [https://paws-r.github.io/docs/iam/untag_open_id_connect_provider.html](https://paws-r.github.io/docs/iam/untag_open_id_connect_provider.html) for full documentation. #' #' @param OpenIDConnectProviderArn [required] The ARN of the OIDC provider in IAM from which you want to remove tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6338,7 +6338,7 @@ iam_untag_open_id_connect_provider <- function(OpenIDConnectProviderArn, TagKeys #' #' @param PolicyArn [required] The ARN of the IAM customer managed policy from which you want to remove #' tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6374,7 +6374,7 @@ iam_untag_policy <- function(PolicyArn, TagKeys) { #' See [https://paws-r.github.io/docs/iam/untag_role.html](https://paws-r.github.io/docs/iam/untag_role.html) for full documentation. #' #' @param RoleName [required] The name of the IAM role from which you want to remove tags. -#' +#' #' This parameter accepts (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that consist of upper and lowercase alphanumeric characters with no @@ -6412,7 +6412,7 @@ iam_untag_role <- function(RoleName, TagKeys) { #' #' @param SAMLProviderArn [required] The ARN of the SAML identity provider in IAM from which you want to #' remove tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6449,7 +6449,7 @@ iam_untag_saml_provider <- function(SAMLProviderArn, TagKeys) { #' #' @param ServerCertificateName [required] The name of the IAM server certificate from which you want to remove #' tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6485,7 +6485,7 @@ iam_untag_server_certificate <- function(ServerCertificateName, TagKeys) { #' See [https://paws-r.github.io/docs/iam/untag_user.html](https://paws-r.github.io/docs/iam/untag_user.html) for full documentation. #' #' @param UserName [required] The name of the IAM user from which you want to remove tags. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -6522,13 +6522,13 @@ iam_untag_user <- function(UserName, TagKeys) { #' See [https://paws-r.github.io/docs/iam/update_access_key.html](https://paws-r.github.io/docs/iam/update_access_key.html) for full documentation. #' #' @param UserName The name of the user whose key you want to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param AccessKeyId [required] The access key ID of the secret access key you want to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -6564,32 +6564,32 @@ iam_update_access_key <- function(UserName = NULL, AccessKeyId, Status) { #' See [https://paws-r.github.io/docs/iam/update_account_password_policy.html](https://paws-r.github.io/docs/iam/update_account_password_policy.html) for full documentation. #' #' @param MinimumPasswordLength The minimum number of characters allowed in an IAM user password. -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `6`. #' @param RequireSymbols Specifies whether IAM user passwords must contain at least one of the #' following non-alphanumeric characters: -#' -#' ! @@ \# $ % ^ & * ( ) _ + - = \[ \] \{ \} | ' -#' +#' +#' ! @@ # $ % ^ & * ( ) _ + - = \[ \] \{ \} | ' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that passwords do not #' require at least one symbol character. #' @param RequireNumbers Specifies whether IAM user passwords must contain at least one numeric #' character (0 to 9). -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that passwords do not #' require at least one numeric character. #' @param RequireUppercaseCharacters Specifies whether IAM user passwords must contain at least one uppercase #' character from the ISO basic Latin alphabet (A to Z). -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that passwords do not #' require at least one uppercase character. #' @param RequireLowercaseCharacters Specifies whether IAM user passwords must contain at least one lowercase #' character from the ISO basic Latin alphabet (a to z). -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that passwords do not #' require at least one lowercase character. @@ -6598,19 +6598,19 @@ iam_update_access_key <- function(UserName = NULL, AccessKeyId, Status) { #' see [Permitting IAM users to change their own #' passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html) #' in the *IAM User Guide*. -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that IAM users in the #' account do not automatically have permissions to change their own #' password. #' @param MaxPasswordAge The number of days that an IAM user password is valid. -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `0`. The result is that IAM user passwords #' never expire. #' @param PasswordReusePrevention Specifies the number of previous passwords that IAM users are prevented #' from reusing. -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `0`. The result is that IAM users are not #' prevented from reusing previous passwords. @@ -6618,12 +6618,12 @@ iam_update_access_key <- function(UserName = NULL, AccessKeyId, Status) { #' Services Management Console from setting a new console password after #' their password has expired. The IAM user cannot access the console until #' an administrator resets the password. -#' +#' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that IAM users can #' change their passwords after they expire and continue to sign in as the #' user. -#' +#' #' In the Amazon Web Services Management Console, the custom password #' policy option **Allow users to change their own password** gives IAM #' users permissions to `iam:ChangePassword` for only their user and to the @@ -6661,28 +6661,28 @@ iam_update_account_password_policy <- function(MinimumPasswordLength = NULL, Req #' See [https://paws-r.github.io/docs/iam/update_assume_role_policy.html](https://paws-r.github.io/docs/iam/update_assume_role_policy.html) for full documentation. #' #' @param RoleName [required] The name of the role to update with the new policy. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param PolicyDocument [required] The policy that grants an entity permission to assume the role. -#' +#' #' You must provide policies in JSON format in IAM. However, for #' CloudFormation templates formatted in YAML, you can provide the policy #' in JSON or YAML format. CloudFormation always converts a YAML policy to #' JSON format before submitting it to IAM. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -6715,14 +6715,14 @@ iam_update_assume_role_policy <- function(RoleName, PolicyDocument) { #' #' @param GroupName [required] Name of the IAM group to update. If you're changing the name of the #' group, this is the original name. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param NewPath New path for the IAM group. Only include this if changing the group's #' path. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -6732,7 +6732,7 @@ iam_update_assume_role_policy <- function(RoleName, PolicyDocument) { #' lowercased letters. #' @param NewGroupName New name for the IAM group. Only include this if changing the group's #' name. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". @@ -6765,26 +6765,26 @@ iam_update_group <- function(GroupName, NewPath = NULL, NewGroupName = NULL) { #' See [https://paws-r.github.io/docs/iam/update_login_profile.html](https://paws-r.github.io/docs/iam/update_login_profile.html) for full documentation. #' #' @param UserName [required] The name of the user whose password you want to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param Password The new password for the specified IAM user. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) -#' +#' #' However, the format can be further restricted by the account #' administrator by setting a password policy on the Amazon Web Services #' account. For more information, see @@ -6826,7 +6826,7 @@ iam_update_login_profile <- function(UserName, Password = NULL, PasswordResetReq #' provider ARNs by using the #' [`list_open_id_connect_providers`][iam_list_open_id_connect_providers] #' operation. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -6867,7 +6867,7 @@ iam_update_open_id_connect_provider_thumbprint <- function(OpenIDConnectProvider #' specified role. If you do not specify a value for this setting, the #' default value of one hour is applied. This setting can have a value from #' 1 hour to 12 hours. -#' +#' #' Anyone who assumes the role from the CLI or API can use the #' `DurationSeconds` API parameter or the `duration-seconds` CLI parameter #' to request a longer session. The `MaxSessionDuration` setting determines @@ -6945,7 +6945,7 @@ iam_update_role_description <- function(RoleName, Description) { #' must generate the metadata document using the identity management #' software that is used as your organization's IdP. #' @param SAMLProviderArn [required] The Amazon Resource Name (ARN) of the SAML provider to update. -#' +#' #' For more information about ARNs, see [Amazon Resource Names #' (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) #' in the *Amazon Web Services General Reference*. @@ -6978,13 +6978,13 @@ iam_update_saml_provider <- function(SAMLMetadataDocument, SAMLProviderArn) { #' See [https://paws-r.github.io/docs/iam/update_ssh_public_key.html](https://paws-r.github.io/docs/iam/update_ssh_public_key.html) for full documentation. #' #' @param UserName [required] The name of the IAM user associated with the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param SSHPublicKeyId [required] The unique identifier for the SSH public key. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -7021,14 +7021,14 @@ iam_update_ssh_public_key <- function(UserName, SSHPublicKeyId, Status) { #' See [https://paws-r.github.io/docs/iam/update_server_certificate.html](https://paws-r.github.io/docs/iam/update_server_certificate.html) for full documentation. #' #' @param ServerCertificateName [required] The name of the server certificate that you want to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param NewPath The new path for the server certificate. Include this only if you are #' updating the server certificate's path. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -7039,7 +7039,7 @@ iam_update_ssh_public_key <- function(UserName, SSHPublicKeyId, Status) { #' @param NewServerCertificateName The new name for the server certificate. Include this only if you are #' updating the server certificate's name. The name of the certificate #' cannot contain any spaces. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -7075,13 +7075,13 @@ iam_update_server_certificate <- function(ServerCertificateName, NewPath = NULL, #' @param UserName The name of the IAM user associated with the service-specific #' credential. If you do not specify this value, then the operation assumes #' the user whose credentials are used to call the operation. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param ServiceSpecificCredentialId [required] The unique identifier of the service-specific credential. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -7116,13 +7116,13 @@ iam_update_service_specific_credential <- function(UserName = NULL, ServiceSpeci #' See [https://paws-r.github.io/docs/iam/update_signing_certificate.html](https://paws-r.github.io/docs/iam/update_signing_certificate.html) for full documentation. #' #' @param UserName The name of the IAM user the signing certificate belongs to. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param CertificateId [required] The ID of the signing certificate you want to update. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' that can consist of any upper or lowercased letter or digit. @@ -7159,14 +7159,14 @@ iam_update_signing_certificate <- function(UserName = NULL, CertificateId, Statu #' #' @param UserName [required] Name of the user to update. If you're changing the name of the user, #' this is the original user name. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param NewPath New path for the IAM user. Include this parameter only if you're #' changing the user's path. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of either a forward slash (/) by itself or a string that must @@ -7176,7 +7176,7 @@ iam_update_signing_certificate <- function(UserName = NULL, CertificateId, Statu #' lowercased letters. #' @param NewUserName New name for the user. Include this parameter only if you're changing #' the user's name. -#' +#' #' IAM user, group, role, and policy names must be unique within the #' account. Names are not distinguished by case. For example, you cannot #' create resources named both "MyResource" and "myresource". @@ -7209,7 +7209,7 @@ iam_update_user <- function(UserName, NewPath = NULL, NewUserName = NULL) { #' See [https://paws-r.github.io/docs/iam/upload_ssh_public_key.html](https://paws-r.github.io/docs/iam/upload_ssh_public_key.html) for full documentation. #' #' @param UserName [required] The name of the IAM user to associate the SSH public key with. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no @@ -7218,17 +7218,17 @@ iam_update_user <- function(UserName, NewPath = NULL, NewUserName = NULL) { #' PEM format. The minimum bit-length of the public key is 2048 bits. For #' example, you can generate a 2048-bit key, and the resulting PEM file is #' 1679 bytes long. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @@ -7263,7 +7263,7 @@ iam_upload_ssh_public_key <- function(UserName, SSHPublicKeyBody) { #' see [IAM #' identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) #' in the *IAM User Guide*. -#' +#' #' This parameter is optional. If it is not included, it defaults to a #' slash (/). This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters @@ -7272,59 +7272,59 @@ iam_upload_ssh_public_key <- function(UserName, SSHPublicKeyBody) { #' ASCII character from the ! (``U+0021``) through the DEL character #' (``U+007F``), including most punctuation characters, digits, and upper and #' lowercased letters. -#' +#' #' If you are uploading a server certificate specifically for use with #' Amazon CloudFront distributions, you must specify a path using the #' `path` parameter. The path must begin with `/cloudfront` and must #' include a trailing slash (for example, `/cloudfront/test/`). #' @param ServerCertificateName [required] The name for the server certificate. Do not include the path in this #' value. The name of the certificate cannot contain any spaces. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param CertificateBody [required] The contents of the public key certificate in PEM-encoded format. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param PrivateKey [required] The contents of the private key in PEM-encoded format. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param CertificateChain The contents of the certificate chain. This is typically a concatenation #' of the PEM-encoded public key certificates of the chain. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' @param Tags A list of tags that you want to attach to the new IAM server certificate @@ -7332,7 +7332,7 @@ iam_upload_ssh_public_key <- function(UserName, SSHPublicKeyBody) { #' more information about tagging, see [Tagging IAM #' resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) #' in the *IAM User Guide*. -#' +#' #' If any one of the tags is invalid or if you exceed the allowed maximum #' number of tags, then the entire request fails and the resource is not #' created. @@ -7365,23 +7365,23 @@ iam_upload_server_certificate <- function(Path = NULL, ServerCertificateName, Ce #' See [https://paws-r.github.io/docs/iam/upload_signing_certificate.html](https://paws-r.github.io/docs/iam/upload_signing_certificate.html) for full documentation. #' #' @param UserName The name of the user the signing certificate is for. -#' +#' #' This parameter allows (through its [regex #' pattern](https://en.wikipedia.org/wiki/Regex)) a string of characters #' consisting of upper and lowercase alphanumeric characters with no #' spaces. You can also include any of the following characters: _+=,.@@- #' @param CertificateBody [required] The contents of the signing certificate. -#' +#' #' The [regex pattern](https://en.wikipedia.org/wiki/Regex) used to #' validate this parameter is a string of characters consisting of the #' following: -#' +#' #' - Any printable ASCII character ranging from the space character #' (``U+0020``) through the end of the ASCII character range -#' +#' #' - The printable characters in the Basic Latin and Latin-1 Supplement #' character set (through ``U+00FF``) -#' +#' #' - The special characters tab (``U+0009``), line feed (``U+000A``), and #' carriage return (``U+000D``) #' diff --git a/cran/paws.security.identity/cran-comments.md b/cran/paws.security.identity/cran-comments.md index 1e1697a057..8be372c79c 100644 --- a/cran/paws.security.identity/cran-comments.md +++ b/cran/paws.security.identity/cran-comments.md @@ -2,18 +2,26 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results There were no ERRORs, or WARNINGs. - -There was one NOTE. +Notes: +checking installed package size ... NOTE + installed size is 7.0Mb + sub-directories of 1Mb or more: + R 3.0Mb + help 3.8Mb + New maintainer: Dyfan Jones Old maintainer(s): David Kretch +Maintainer Notes: tarball package size: 757.5K + ## Downstream dependencies All downstream dependencies ('paws') pass R CMD check. diff --git a/cran/paws.security.identity/man/cognitosync.Rd b/cran/paws.security.identity/man/cognitosync.Rd index e85cb69205..74a17af3b0 100644 --- a/cran/paws.security.identity/man/cognitosync.Rd +++ b/cran/paws.security.identity/man/cognitosync.Rd @@ -45,8 +45,7 @@ credentials retrieved with \href{https://docs.aws.amazon.com/cognitoidentity/lat If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn -more, see the \href{https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/}{Developer Guide for Android} -and the Developer Guide for iOS. +more, see the Developer Guide for Android and the Developer Guide for iOS. } \section{Service syntax}{ diff --git a/cran/paws.security.identity/man/iam_create_account_alias.Rd b/cran/paws.security.identity/man/iam_create_account_alias.Rd index 0e7cec6bd5..66d1fe4e9d 100644 --- a/cran/paws.security.identity/man/iam_create_account_alias.Rd +++ b/cran/paws.security.identity/man/iam_create_account_alias.Rd @@ -14,7 +14,7 @@ consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.} } \description{ -Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. +Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. See \url{https://paws-r.github.io/docs/iam/create_account_alias.html} for full documentation. } diff --git a/cran/paws.security.identity/man/iam_delete_account_alias.Rd b/cran/paws.security.identity/man/iam_delete_account_alias.Rd index b0664e93d4..89c87877f5 100644 --- a/cran/paws.security.identity/man/iam_delete_account_alias.Rd +++ b/cran/paws.security.identity/man/iam_delete_account_alias.Rd @@ -14,7 +14,7 @@ consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.} } \description{ -Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. +Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. See \url{https://paws-r.github.io/docs/iam/delete_account_alias.html} for full documentation. } diff --git a/cran/paws.security.identity/man/iam_list_account_aliases.Rd b/cran/paws.security.identity/man/iam_list_account_aliases.Rd index 3126c34e75..624e77a7ee 100644 --- a/cran/paws.security.identity/man/iam_list_account_aliases.Rd +++ b/cran/paws.security.identity/man/iam_list_account_aliases.Rd @@ -24,7 +24,7 @@ returns \code{true}, and \code{Marker} contains a value to include in the subsequent call that tells the service where to continue from.} } \description{ -Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. +Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see \href{https://docs.aws.amazon.com/signin/latest/userguide/user-types-list.html}{Using an alias for your Amazon Web Services account ID} in the \emph{IAM User Guide}. See \url{https://paws-r.github.io/docs/iam/list_account_aliases.html} for full documentation. } diff --git a/cran/paws.security.identity/man/iam_update_account_password_policy.Rd b/cran/paws.security.identity/man/iam_update_account_password_policy.Rd index 3acbb93cd3..7238a15551 100644 --- a/cran/paws.security.identity/man/iam_update_account_password_policy.Rd +++ b/cran/paws.security.identity/man/iam_update_account_password_policy.Rd @@ -25,7 +25,7 @@ uses the default value of \code{6}.} \item{RequireSymbols}{Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: -! @ \# $ \% ^ & * ( ) _ + - = [ ] \{ \} | ' +! @ # $ \% ^ & * ( ) _ + - = [ ] \{ \} | ' If you do not specify a value for this parameter, then the operation uses the default value of \code{false}. The result is that passwords do not diff --git a/cran/paws.storage/cran-comments.md b/cran/paws.storage/cran-comments.md index cffcc71ad3..96eec742b4 100644 --- a/cran/paws.storage/cran-comments.md +++ b/cran/paws.storage/cran-comments.md @@ -2,17 +2,19 @@ * local macOS install, R 4.2.1 * R-hub (devel and release) +* win-builder ## R CMD check results -There were no ERRORs, WARNINGs. +There were no ERRORs or WARNINGs. -There was one Note: +Notes: + New maintainer: + Dyfan Jones + Old maintainer(s): + David Kretch -New maintainer: - Dyfan Jones -Old maintainer(s): - David Kretch +Maintainer Notes: tarball package size: 330.3K ## Downstream dependencies diff --git a/cran/paws/R/paws.R b/cran/paws/R/paws.R index 5c833c50fd..11acdf2604 100644 --- a/cran/paws/R/paws.R +++ b/cran/paws/R/paws.R @@ -23105,9 +23105,7 @@ cognitoidentityprovider <- function(config = list()) { #' #' If you want to use Cognito Sync in an Android or iOS application, you #' will probably want to make API calls via the AWS Mobile SDK. To learn -#' more, see the [Developer Guide for -#' Android](https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/) -#' and the Developer Guide for iOS. +#' more, see the Developer Guide for Android and the Developer Guide for iOS. #' #' @param #' config diff --git a/cran/paws/cran-comments.md b/cran/paws/cran-comments.md index ff14ee09ac..9315e8dd37 100644 --- a/cran/paws/cran-comments.md +++ b/cran/paws/cran-comments.md @@ -6,14 +6,16 @@ ## R CMD check results -There were no ERRORs, or WARNINGs. +There were no ERRORs or WARNINGs -NOTE: +Notes: New maintainer: Dyfan Jones Old maintainer(s): David Kretch +Maintainer Notes: tarball package size: 634.3K + ## Downstream dependencies All downstream dependencies pass R CMD check. diff --git a/cran/paws/man/cognitosync.Rd b/cran/paws/man/cognitosync.Rd index 3545bde799..5a49468453 100644 --- a/cran/paws/man/cognitosync.Rd +++ b/cran/paws/man/cognitosync.Rd @@ -45,8 +45,7 @@ credentials retrieved with \href{https://docs.aws.amazon.com/cognitoidentity/lat If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn -more, see the \href{https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/}{Developer Guide for Android} -and the Developer Guide for iOS. +more, see the Developer Guide for Android and the Developer Guide for iOS. } \section{Service syntax}{ diff --git a/make.paws/NAMESPACE b/make.paws/NAMESPACE index f188b690af..9a4ad92ea8 100644 --- a/make.paws/NAMESPACE +++ b/make.paws/NAMESPACE @@ -1,6 +1,7 @@ export(list_aws_services) export(category_service_ops_count) export(make_sdk) +export(paws_build_cran_comments) export(paws_check_local_sub_cat) export(paws_check_local_cat) export(paws_check_local) diff --git a/make.paws/R/docs.R b/make.paws/R/docs.R index fafef3f348..39266b296a 100644 --- a/make.paws/R/docs.R +++ b/make.paws/R/docs.R @@ -537,18 +537,21 @@ clean_markdown <- function(markdown) { result <- gsub("\\\\([a-zA-Z])", "\\\\\\\\\\1", result) # Remove certain characters not allowed by LaTeX. - # TODO: Translate these into valid alternatives. - invalid_chars <- c( - "\U2028", - "\U0391", - "\U03AE", - "\U03B1", - "\U03B8", - "\U03BD" + result <- gsub("\U2028", "", result) + + # Translate greek phrases: + result <- gsub( + "`\U0391\U03B8\U03AE\U03BD\U03B1, \U0395\U03BB\U03BB\U03AC\U03B4\U03B1`", + r"(\\eqn{A\\Theta\\eta\\nu\\sigma, E\\lambda\\lambda\\alpha\\delta})", + result, + perl = TRUE + ) + result <- gsub( + "`\U0391\U03B8\U03AE\U03BD\U03B1`", + r"(\\eqn{A\\Theta\\eta\\nu\\alpha})", + result, + perl = TRUE ) - for (char in invalid_chars) { - result <- gsub(char, "", result) - } # @ symbol, escaped for Roxygen. # See http://r-pkgs.had.co.nz/man.html#roxygen-comments. diff --git a/make.paws/R/sdk_helper.R b/make.paws/R/sdk_helper.R index caa5a261a5..65ce480285 100644 --- a/make.paws/R/sdk_helper.R +++ b/make.paws/R/sdk_helper.R @@ -5,7 +5,7 @@ #' @importFrom utils installed.packages remove.packages #' @title Check paws sdk -#' @description Check paws sdk locally using \code{devtools::check} +#' @description Check paws sdk locally using \code{devtools::check_built} #' @param in_dir Directory containing paws sdk packages. #' @param path Path to output paws sdk check results. #' @param pkg_list list of packages check locally, check all packages by default @@ -89,26 +89,31 @@ paws_check_url <- function(in_dir = "../cran", path, pkg_list = list()){ #' @param in_dir Directory containing paws sdk packages. #' @param pkg_list list of packages check through rhub, check all packages by default #' @param email address to notify, defaults to the maintainer address in the package. +#' @param interactive whether to show the status of the build interactively. R-hub +#' will send an email to the package maintainer's email address, regardless of +#' whether the check is interactive or not. #' @name paws_check_rhub #' @export paws_check_rhub <- function(in_dir = "../cran", pkg_list = list(), - email = NULL){ - paws_check_rhub_sub_cat(in_dir, pkg_list, email) - paws_check_rhub_cat(in_dir, pkg_list, email) + email = NULL, + interactive = TRUE){ + paws_check_rhub_sub_cat(in_dir, pkg_list, email, interactive) + paws_check_rhub_cat(in_dir, pkg_list, email, interactive) pkg <- file.path(in_dir, "paws") - devtools::check_rhub(pkg, email = email) + devtools::check_rhub(pkg, email = email, interactive = interactive) } #' @name paws_check_rhub #' @export paws_check_rhub_cat <- function(in_dir = "../cran", pkg_list = list(), - email = NULL){ + email = NULL, + interactive = TRUE){ pkgs <- list_paws_pkgs(in_dir, pkg_list) pkgs <- list_cat_pkgs(pkgs) for (pkg in pkgs){ - devtools::check_rhub(pkg, email = email) + devtools::check_rhub(pkg, email = email, interactive = interactive) } } @@ -116,12 +121,13 @@ paws_check_rhub_cat <- function(in_dir = "../cran", #' @export paws_check_rhub_sub_cat <- function(in_dir = "../cran", pkg_list = list(), - email = NULL){ + email = NULL, + interactive = TRUE){ pkgs <- list_paws_pkgs(in_dir, pkg_list) pkgs <- list_sub_cat_pkgs(pkgs) if (length(pkgs) > 0) { for (pkg in pkgs){ - devtools::check_rhub(pkg, email = email) + devtools::check_rhub(pkg, email = email, interactive = interactive) } } else { warning("No sub-categories released.") @@ -190,11 +196,11 @@ paws_check_pkg_size <- function(in_dir = "../cran", quiet = TRUE ) dir_info <- fs::dir_info(tmp) - dir_info$package <- basename(pkgs) + dir_info$package <- gsub("_.*", "", basename(dir_info$path)) dir_info <- dir_info[, c("package", "size")] setDT(dir_info) - dir_info[, c("status", "percentage") := .( + dir_info[, c("status", "percentage") := list( fcase( get("size") > threshold, "ERROR", get("size") > threshold *.75, "WARNING", @@ -203,6 +209,7 @@ paws_check_pkg_size <- function(in_dir = "../cran", paste(round(as.numeric(get("size")/ threshold) * 100, 2), "%") ) ] + return(dir_info[order(-get("size"))]) } @@ -268,6 +275,166 @@ paws_release_sub_cat <- function(in_dir = "../cran", pkg_list = list()){ } } +cran_comment_template <- "## Test environments + +* local macOS install, R 4.2.1 +* R-hub (devel and release) +* win-builder + +## R CMD check results + +%s + +Maintainer Notes: tarball package size: %s + +## Downstream dependencies + +%s" + +#' @title Method to build cran comments +#' @param in_dir Directory containing paws sdk packages. +#' @param cache_path yaml file created by `paws_check_local` +#' @param refresh re-write any cran-comments.md that already exists. +#' @name paws_build_cran_comments +#' @export +paws_build_cran_comments <- function(in_dir = "../cran", + cache_path = NULL, + refresh = FALSE) { + log_info <- utils::getFromNamespace("log_info", "paws.common") + all_cats <- basename(list_paws_pkgs(in_dir)) + log_info( + "Running local checks for: ['%s']", + paste(all_cats, collapse = "', '") + ) + dir_info <- paws_check_pkg_size(in_dir, pkg_list = all_cats) + if(is.null(cache_path)){ + results_local <- paws_check_local( + pkg_list = all_cats, + keep_notes = T + ) + log_info("Completed local checks.") + } else { + results_local <- yaml::read_yaml(cache_path) + log_info("Retrieved local check results from cache.") + } + result_dt <- suppressWarnings( + rbindlist(results_local, fill = T, idcol = "package", use.names = T) + ) + + dir_info[ + result_dt, + `:=`( + "errors"=get("errors"), + "warnings"=get("warnings"), + "notes"=get("notes") + ), + on = "package" + ] + + dir_info[, + "cran_comment" := fcase( + is.na(get("errors")) & is.na(get("warnings")) & is.na(get("notes")), + "There were no ERRORs, WARNINGs, or Notes." + , + is.na(get("errors")) & is.na(get("warnings")) & !is.na(get("notes")), + sprintf( + "There were no ERRORs, or WARNINGs.\nNotes:\n%s", get("notes") + ), + is.na(get("errors")) & !is.na(get("warnings")) & !is.na(get("notes")), + sprintf( + "There were no ERRORs.\nWarnings:%s\nNotes:\n%s", + get("warnings"), get("notes") + ), + is.na(get("errors")) & !is.na(get("warnings")) & is.na(get("notes")), + sprintf( + "There were no ERRORs or Notes.\nWarnings:%s", warnings + ), + !is.na(get("errors")) & !is.na(get("warnings")) & !is.na(get("notes")), + sprintf( + "Errors:\n%s\nWarnings:\n%s\nNotes:\n%s", + get("errors"), get("warnings"), get("notes") + ), + !is.na(get("errors")) & is.na(get("warnings")) & is.na(get("notes")), + sprintf( + "There was no WARNINGS or Notes.\nErrors:\n%s", get("errors") + ), + !is.na(get("errors")) & !is.na(get("warnings")) & is.na(get("notes")), + sprintf( + "There was no WARNINGS.\nErrors:\n%s\nNotes:\n%s", + get("errors"), get("notes") + ), + !is.na(get("errors")) & !is.na(get("warnings")) & !is.na(get("notes")), + sprintf( + "There was no NOTES.\nErrors:\n%s\nNotes:\n%s", + get("errors"), get("warnings") + ) + ) + ] + + dir_info[, + "downstream_info" := fifelse( + grepl("paws[.].*$", get("package")), + "All downstream dependencies ('paws') pass R CMD check.", + "All downstream dependencies pass R CMD check." + ) + ] + cran_comments <- sprintf( + cran_comment_template, + dir_info$cran_comment, + dir_info$size, + dir_info$downstream_info + ) + names(cran_comments) <- dir_info$package + + for (pkg in all_cats) { + comment_file <- file.path(in_dir, pkg, "cran-comments.md") + if (!file.exists(comment_file) || refresh) { + writeLines(cran_comments[[pkg]], con = comment_file) + log_info("Updated cran-comments.md: %s", pkg) + } + } +} + +# TODO: add this helper function into make build/rebuild command +# This function un-escapes any special characters after build. +paws_unescape_latex_post_build <- function( + root = "..", + special_characters = c("#", "$", "_") + ) { + log_info <- utils::getFromNamespace("log_info", "paws.common") + + paws_r <- fs::dir_ls(file.path(root, "paws", "R")) + cran_pkg <- fs::dir_ls(file.path(root, "cran")) + cran_r <- lapply( + cran_pkg, \(x) fs::dir_ls(file.path(x, "R")) + ) + cran_rd <- lapply( + cran_pkg, \(x) fs::dir_ls(file.path(x, "man")) + ) + + remove_esaped_latex <- function(files) { + for (file in files) { + result <- readLines(file) + for (char in special_characters) { + result <- gsub(sprintf(r"(\\[%s])", char), char, result, perl = T) + } + writeLines(result, file) + } + } + + remove_esaped_latex(paws_r) + log_info( + "Removed escaped latex scripts from paws directory." + ) + + for (pkg in cran_pkg) { + remove_esaped_latex(cran_r[[pkg]]) + remove_esaped_latex(cran_rd[[pkg]]) + log_info("Removed escaped latex: %s", pkg) + } +} + + ##### helper functions ##### check_pkgs <- function(pkgs, keep_notes = FALSE){ temp_file <- tempfile() @@ -276,8 +443,9 @@ check_pkgs <- function(pkgs, keep_notes = FALSE){ # Check package locally checks <- list() sink(temp_file) + print(pkgs) for (pkg in pkgs) { - checks[[basename(pkg)]] <- devtools::check(pkg, cran = TRUE) + checks[[basename(pkg)]] <- devtools::check_built(pkg, cran = TRUE) } sink() @@ -295,11 +463,14 @@ check_pkgs <- function(pkgs, keep_notes = FALSE){ results[[pkg]] <- c(results[[pkg]], notes = notes) } } - packages_not_ok <- results[ - sapply(results, function(x) { + packages_not_ok <- list() + if (length(results) > 1) { + not_ok <- sapply(results, function(x) { !is.null(x$errors) | !is.null(x$warnings) | !is.null(x$notes) }) - ] + + packages_not_ok <- results[not_ok] + } return(packages_not_ok) } diff --git a/make.paws/man/paws_build_cran_comments.Rd b/make.paws/man/paws_build_cran_comments.Rd new file mode 100644 index 0000000000..801fe46e2f --- /dev/null +++ b/make.paws/man/paws_build_cran_comments.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/sdk_helper.R +\name{paws_build_cran_comments} +\alias{paws_build_cran_comments} +\title{Method to build cran comments} +\usage{ +paws_build_cran_comments( + in_dir = "../cran", + cache_path = NULL, + refresh = FALSE +) +} +\arguments{ +\item{in_dir}{Directory containing paws sdk packages.} + +\item{cache_path}{yaml file created by \code{paws_check_local}} + +\item{refresh}{re-write any cran-comments.md that already exists.} +} +\description{ +Method to build cran comments +} diff --git a/make.paws/man/paws_check_pkg_size.Rd b/make.paws/man/paws_check_pkg_size.Rd index 57b2ac6b6e..ff1428e12a 100644 --- a/make.paws/man/paws_check_pkg_size.Rd +++ b/make.paws/man/paws_check_pkg_size.Rd @@ -19,7 +19,7 @@ paws_check_pkg_size( \item{pkg_list}{list of packages check locally, check all packages by default} } \value{ -A data.frame with packages exceeding the threshold. +A data.table with package status size and percentage. } \description{ Check paws sdk package size after being tarball. diff --git a/make.paws/man/paws_check_rhub.Rd b/make.paws/man/paws_check_rhub.Rd index de0cb764c8..4c433a371c 100644 --- a/make.paws/man/paws_check_rhub.Rd +++ b/make.paws/man/paws_check_rhub.Rd @@ -9,11 +9,26 @@ \alias{paws_check_win_devel_sub_cat} \title{Check paws using rhub} \usage{ -paws_check_rhub(in_dir = "../cran", pkg_list = list(), email = NULL) +paws_check_rhub( + in_dir = "../cran", + pkg_list = list(), + email = NULL, + interactive = TRUE +) -paws_check_rhub_cat(in_dir = "../cran", pkg_list = list(), email = NULL) +paws_check_rhub_cat( + in_dir = "../cran", + pkg_list = list(), + email = NULL, + interactive = TRUE +) -paws_check_rhub_sub_cat(in_dir = "../cran", pkg_list = list(), email = NULL) +paws_check_rhub_sub_cat( + in_dir = "../cran", + pkg_list = list(), + email = NULL, + interactive = TRUE +) paws_check_win_devel(in_dir = "../cran", pkg_list = list(), email = NULL) @@ -31,6 +46,10 @@ paws_check_win_devel_sub_cat( \item{pkg_list}{list of packages check through rhub, check all packages by default} \item{email}{address to notify, defaults to the maintainer address in the package.} + +\item{interactive}{whether to show the status of the build interactively. R-hub +will send an email to the package maintainer's email address, regardless of +whether the check is interactive or not.} } \description{ Check paws using rhub diff --git a/make.paws/tests/testthat/local_check_results.yml b/make.paws/tests/testthat/local_check_results.yml new file mode 100644 index 0000000000..3b383e1087 --- /dev/null +++ b/make.paws/tests/testthat/local_check_results.yml @@ -0,0 +1,14 @@ +paws: + errors: ~ + warnings: ~ + notes: ~ +paws.cat1: + errors: ~ + warnings: |- + this is a dummy warning + notes: ~ +paws.cat2: + errors: ~ + warnings: ~ + notes: |- + this is a dummy note diff --git a/make.paws/tests/testthat/test_sdk_helper.R b/make.paws/tests/testthat/test_sdk_helper.R index ff3383130a..a4c9530591 100644 --- a/make.paws/tests/testthat/test_sdk_helper.R +++ b/make.paws/tests/testthat/test_sdk_helper.R @@ -51,13 +51,13 @@ test_that("check list paws sub category packages", { }) test_that("check local check_pkgs remove notes", { - mock_devtools_check <- mock2( + mock_devtools_check_built <- mock2( list(errors = "foo", warnings = "bar"), list(errors = "foo", warnings = "bar", notes = "cho"), list(notes = "baz"), cycle = T ) - mockery::stub(check_pkgs, 'devtools::check', mock_devtools_check) + mockery::stub(check_pkgs, 'devtools::check_built', mock_devtools_check_built) check <- check_pkgs(c("paws", "paws.cat1", "paws.cat2")) @@ -68,13 +68,13 @@ test_that("check local check_pkgs remove notes", { }) test_that("check local check_pkgs keep notes", { - mock_devtools_check <- mock2( + mock_devtools_check_built <- mock2( list(errors = "foo", warnings = "bar"), list(errors = "foo", warnings = "bar", notes = "cho"), list(notes = "baz"), cycle = T ) - mockery::stub(check_pkgs, 'devtools::check', mock_devtools_check) + mockery::stub(check_pkgs, 'devtools::check_built', mock_devtools_check_built) check <- check_pkgs(c("paws", "paws.cat1", "paws.cat2"), keep_notes = T) @@ -310,7 +310,8 @@ test_that("check paws_check_pkg_size", { mock_devtools_build <- mock2() mock_dir_info <- mock2( data.table( - "size" = fs::as_fs_bytes(c("1MB", "4MB", "6MB")) + "size" = fs::as_fs_bytes(c("1MB", "4MB", "6MB")), + "path" = paste0(c("paws", "paws.cat1", "paws.cat2"), "_123.tar.gz") ) ) mockery::stub(paws_check_pkg_size, 'list_paws_pkgs', mock_list_paws_pkgs) @@ -329,3 +330,139 @@ test_that("check paws_check_pkg_size", { ) ) }) + +test_that("check paws_build_cran_comments", { + mock_desc_get_deps <- mock2( + data.frame( + "type" = rep("Imports", 2), + "package" = c("paws.cat1", "paws.cat2") + ) + ) + mock_list_paws_pkgs <- mock2(c("paws.cat1", "paws.cat2")) + mock_paws_check_pkg_size <- mock2( + data.table::data.table( + package = c("paws", "paws.cat1", "paws.cat2"), + size = c("123K", "456K", "789K"), + status = rep("OK", 3), + percentage = paste(seq(3, 10, 3), "%") + ) + ) + mock_paws_check_local <- mock2( + list( + paws = list( + errors = NULL, + warnings = NULL, + notes = NULL + ), + paws.cat1 = list( + errors = NULL, + warnings = "this is a dummy warning", + notes = NULL + ), + paws.cat2 = list( + errors = NULL, + warnings = NULL, + notes = "this is a dummy note" + ) + ) + ) + mock_write_line <- mock2() + mockery::stub( + paws_build_cran_comments, 'list_paws_pkgs', mock_list_paws_pkgs + ) + mockery::stub( + paws_build_cran_comments, 'paws_check_pkg_size', mock_paws_check_pkg_size + ) + mockery::stub( + paws_build_cran_comments, 'paws_check_local', mock_paws_check_local + ) + mockery::stub( + paws_build_cran_comments, 'writeLines', mock_write_line + ) + + paws_build_cran_comments(in_dir = "made_up") + + expect_equal( + mock_arg(mock_paws_check_pkg_size), + list( + "made_up", + "pkg_list" = c("paws.cat1", "paws.cat2") + ) + ) + expect_equal( + mock_arg(mock_paws_check_local), + list( + pkg_list = c("paws.cat1", "paws.cat2"), + keep_notes = TRUE + ) + ) + expect_equal( + mockery::mock_args(mock_write_line), + list( + list( + "## Test environments\n\n* local macOS install, R 4.2.1\n* R-hub (devel and release)\n* win-builder\n\n## R CMD check results\n\nThere were no ERRORs or Notes.\nWarnings:this is a dummy warning\n\nMaintainer Notes: tarball package size: 456K\n\n## Downstream dependencies\n\nAll downstream dependencies ('paws') pass R CMD check.", + con = "made_up/paws.cat1/cran-comments.md" + ), + list( + "## Test environments\n\n* local macOS install, R 4.2.1\n* R-hub (devel and release)\n* win-builder\n\n## R CMD check results\n\nThere were no ERRORs, or WARNINGs.\nNotes:\nthis is a dummy note\n\nMaintainer Notes: tarball package size: 789K\n\n## Downstream dependencies\n\nAll downstream dependencies ('paws') pass R CMD check.", + con = "made_up/paws.cat2/cran-comments.md" + ) + ) + ) +}) + +test_that("check paws_build_cran_comments from cache", { + mock_desc_get_deps <- mock2( + data.frame( + "type" = rep("Imports", 2), + "package" = c("paws.cat1", "paws.cat2") + ) + ) + mock_list_paws_pkgs <- mock2(c("paws.cat1", "paws.cat2")) + mock_paws_check_pkg_size <- mock2( + data.table::data.table( + package = c("paws", "paws.cat1", "paws.cat2"), + size = c("123K", "456K", "789K"), + status = rep("OK", 3), + percentage = paste(seq(3, 10, 3), "%") + ) + ) + mock_write_line <- mock2() + mockery::stub( + paws_build_cran_comments, 'desc::desc_get_deps', mock_desc_get_deps + ) + mockery::stub( + paws_build_cran_comments, 'list_paws_pkgs', mock_list_paws_pkgs + ) + mockery::stub( + paws_build_cran_comments, 'paws_check_pkg_size', mock_paws_check_pkg_size + ) + mockery::stub( + paws_build_cran_comments, 'writeLines', mock_write_line + ) + + paws_build_cran_comments( + in_dir = "made_up", cache_path = "local_check_results.yml" + ) + + expect_equal( + mock_arg(mock_paws_check_pkg_size), + list( + "made_up", + "pkg_list" = c("paws.cat1", "paws.cat2") + ) + ) + expect_equal( + mockery::mock_args(mock_write_line), + list( + list( + "## Test environments\n\n* local macOS install, R 4.2.1\n* R-hub (devel and release)\n* win-builder\n\n## R CMD check results\n\nThere were no ERRORs or Notes.\nWarnings:this is a dummy warning\n\nMaintainer Notes: tarball package size: 456K\n\n## Downstream dependencies\n\nAll downstream dependencies ('paws') pass R CMD check.", + con = "made_up/paws.cat1/cran-comments.md" + ), + list( + "## Test environments\n\n* local macOS install, R 4.2.1\n* R-hub (devel and release)\n* win-builder\n\n## R CMD check results\n\nThere were no ERRORs, or WARNINGs.\nNotes:\nthis is a dummy note\n\nMaintainer Notes: tarball package size: 789K\n\n## Downstream dependencies\n\nAll downstream dependencies ('paws') pass R CMD check.", + con = "made_up/paws.cat2/cran-comments.md" + ) + ) + ) +}) diff --git a/paws/R/dynamodb_operations.R b/paws/R/dynamodb_operations.R index 535a873472..3c1f575467 100644 --- a/paws/R/dynamodb_operations.R +++ b/paws/R/dynamodb_operations.R @@ -246,7 +246,7 @@ dynamodb_batch_execute_statement <- function(Statements, ReturnConsumedCapacity #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an +#' Use the **#** character in an expression to dereference an #' attribute name. For example, consider the following attribute name: #' #' - `Percentile` @@ -1863,7 +1863,7 @@ dynamodb_delete_backup <- function(BackupArn) { #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` @@ -4216,7 +4216,7 @@ dynamodb_export_table_to_point_in_time <- function(TableArn, ExportTime = NULL, #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` @@ -4932,7 +4932,7 @@ dynamodb_list_tags_of_resource <- function(ResourceArn, NextToken = NULL) { #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` @@ -5511,7 +5511,7 @@ dynamodb_put_item <- function(TableName, Item, Expected = NULL, ReturnValues = N #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` @@ -6612,7 +6612,7 @@ dynamodb_restore_table_to_point_in_time <- function(SourceTableArn = NULL, Sourc #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` @@ -8294,7 +8294,7 @@ dynamodb_update_global_table_settings <- function(GlobalTableName, GlobalTableBi #' - To prevent special characters in an attribute name from being #' misinterpreted in an expression. #' -#' Use the **\#** character in an expression to dereference an attribute +#' Use the **#** character in an expression to dereference an attribute #' name. For example, consider the following attribute name: #' #' - `Percentile` diff --git a/paws/R/elasticache_operations.R b/paws/R/elasticache_operations.R index ac8b39381b..82957a7a35 100644 --- a/paws/R/elasticache_operations.R +++ b/paws/R/elasticache_operations.R @@ -957,7 +957,7 @@ elasticache_copy_snapshot <- function(SourceSnapshotName, TargetSnapshotName, Ta #' - Must be at least 16 characters and no more than 128 characters in #' length. #' -#' - The only permitted printable special characters are !, &, \#, $, ^, +#' - The only permitted printable special characters are !, &, #, $, ^, #' \<, \>, and -. Other printable special characters cannot be used in #' the AUTH token. #' @@ -1917,7 +1917,7 @@ elasticache_create_global_replication_group <- function(GlobalReplicationGroupId #' - Must be at least 16 characters and no more than 128 characters in #' length. #' -#' - The only permitted printable special characters are !, &, \#, $, ^, +#' - The only permitted printable special characters are !, &, #, $, ^, #' \<, \>, and -. Other printable special characters cannot be used in #' the AUTH token. #' diff --git a/paws/R/glue_operations.R b/paws/R/glue_operations.R index 810d984e7f..2762b1bbd9 100644 --- a/paws/R/glue_operations.R +++ b/paws/R/glue_operations.R @@ -16522,7 +16522,7 @@ glue_run_statement <- function(SessionId, Code, RequestOrigin = NULL) { #' comparing string values, such as when `Key=Name`, a fuzzy match #' algorithm is used. The `Key` field (for example, the value of the `Name` #' field) is split on certain punctuation characters, for example, -, :, -#' \#, etc. into tokens. Then each token is exact-match compared with the +#' #, etc. into tokens. Then each token is exact-match compared with the #' `Value` member of `PropertyPredicate`. For example, if `Key=Name` and #' `Value=link`, tables named `customer-link` and `xx-link-yy` are #' returned, but `xxlinkyy` is not returned. diff --git a/paws/R/iam_operations.R b/paws/R/iam_operations.R index 254245dab7..1e7b52b17d 100644 --- a/paws/R/iam_operations.R +++ b/paws/R/iam_operations.R @@ -13045,7 +13045,7 @@ iam_update_access_key <- function(UserName = NULL, AccessKeyId, Status) { #' @param RequireSymbols Specifies whether IAM user passwords must contain at least one of the #' following non-alphanumeric characters: #' -#' ! @@ \# $ % ^ & * ( ) _ + - = \[ \] \{ \} | ' +#' ! @@ # $ % ^ & * ( ) _ + - = \[ \] \{ \} | ' #' #' If you do not specify a value for this parameter, then the operation #' uses the default value of `false`. The result is that passwords do not diff --git a/paws/R/licensemanager_operations.R b/paws/R/licensemanager_operations.R index e60228ea39..8968c4b124 100644 --- a/paws/R/licensemanager_operations.R +++ b/paws/R/licensemanager_operations.R @@ -527,8 +527,8 @@ licensemanager_create_license <- function(LicenseName, ProductName, ProductSKU, #' @param LicenseCount Number of licenses managed by the license configuration. #' @param LicenseCountHardLimit Indicates whether hard or soft license enforcement is used. Exceeding a #' hard limit blocks the launch of new instances. -#' @param LicenseRules License rules. The syntax is \#name=value (for example, -#' \#allowedTenancy=EC2-DedicatedHost). The available rules vary by +#' @param LicenseRules License rules. The syntax is #name=value (for example, +#' #allowedTenancy=EC2-DedicatedHost). The available rules vary by #' dimension, as follows. #' #' - `Cores` dimension: `allowedTenancy` | `licenseAffinityToHost` | diff --git a/paws/R/locationservice_operations.R b/paws/R/locationservice_operations.R index bbe1f3b469..9f4b9e1a6b 100644 --- a/paws/R/locationservice_operations.R +++ b/paws/R/locationservice_operations.R @@ -25,8 +25,8 @@ NULL #' associated to tracker resource. Used when you need to specify a resource #' across all AWS. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` +#' - Format example: +#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` #' @param TrackerName [required] The name of the tracker resource to be associated with a geofence #' collection. #' @@ -76,7 +76,7 @@ locationservice_associate_tracker_consumer <- function(ConsumerArn, TrackerName) #' #' @param DeviceIds [required] Devices whose position history you want to delete. #' -#' - For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` +#' - For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` #' @param TrackerName [required] The name of the tracker resource to delete the device position history #' from. #' @@ -201,11 +201,11 @@ locationservice_batch_delete_geofence <- function(CollectionName, GeofenceIds) { #' entered or exited a geofenced area, and then publishes one of the #' following events to Amazon EventBridge: #' -#' - `ENTER` if Amazon Location determines that the tracked device has -#' entered a geofenced area. +#' - `ENTER` if Amazon Location determines that the tracked device has +#' entered a geofenced area. #' -#' - `EXIT` if Amazon Location determines that the tracked device has -#' exited a geofenced area. +#' - `EXIT` if Amazon Location determines that the tracked device has +#' exited a geofenced area. #' #' The last geofence that a device was observed within is tracked for 30 #' days after the most recent device position update. @@ -300,8 +300,8 @@ locationservice_batch_evaluate_geofences <- function(CollectionName, DevicePosit #' #' @param DeviceIds [required] Devices whose position you want to retrieve. #' -#' - For example, for two devices: -#' `device-ids=DeviceId1&device-ids=DeviceId2` +#' - For example, for two devices: +#' `device-ids=DeviceId1&device-ids=DeviceId2` #' @param TrackerName [required] The tracker resource retrieving the device position. #' #' @return @@ -581,23 +581,23 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' #' Additional options include: #' -#' - [Specifying a departure -#' time](https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) -#' using either `DepartureTime` or `DepartNow`. This calculates a route -#' based on predictive traffic data at the given time. +#' - [Specifying a departure +#' time](https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) +#' using either `DepartureTime` or `DepartNow`. This calculates a route +#' based on predictive traffic data at the given time. #' -#' You can't specify both `DepartureTime` and `DepartNow` in a single -#' request. Specifying both parameters returns a validation error. +#' You can't specify both `DepartureTime` and `DepartNow` in a single +#' request. Specifying both parameters returns a validation error. #' -#' - [Specifying a travel -#' mode](https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) -#' using TravelMode sets the transportation mode used to calculate the -#' routes. This also lets you specify additional route preferences in -#' `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if -#' traveling by `Truck`. +#' - [Specifying a travel +#' mode](https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) +#' using TravelMode sets the transportation mode used to calculate the +#' routes. This also lets you specify additional route preferences in +#' `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if +#' traveling by `Truck`. #' -#' If you specify `walking` for the travel mode and your data provider -#' is Esri, the start and destination must be within 40km. +#' If you specify `walking` for the travel mode and your data provider is +#' Esri, the start and destination must be within 40km. #' #' @usage #' locationservice_calculate_route(CalculatorName, CarModeOptions, @@ -622,7 +622,7 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' 84)](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) #' format: `[longitude, latitude]`. #' -#' - For example, `[-123.115, 49.285]` +#' - For example, `[-123.115, 49.285]` #' #' If you specify a departure that's not located on a road, Amazon Location #' [moves the position to the nearest @@ -639,15 +639,14 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' Setting a departure time in the past returns a `400 ValidationException` #' error. #' -#' - In [ISO -#' 8601](https://www.iso.org/iso-8601-date-and-time-format.html) -#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, -#' `2020–07-2T12:15:20.000Z+01:00` +#' - In [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) +#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, +#' `2020–07-2T12:15:20.000Z+01:00` #' @param DestinationPosition [required] The finish position for the route. Defined in [World Geodetic System #' (WGS 84)](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) #' format: `[longitude, latitude]`. #' -#' - For example, `[-122.339, 47.615]` +#' - For example, `[-122.339, 47.615]` #' #' If you specify a destination that's not located on a road, Amazon #' Location [moves the position to the nearest @@ -670,9 +669,9 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' The `TravelMode` you specify also determines how you specify route #' preferences: #' -#' - If traveling by `Car` use the `CarModeOptions` parameter. +#' - If traveling by `Car` use the `CarModeOptions` parameter. #' -#' - If traveling by `Truck` use the `TruckModeOptions` parameter. +#' - If traveling by `Truck` use the `TruckModeOptions` parameter. #' #' Default Value: `Car` #' @param TruckModeOptions Specifies route preferences when traveling by `Truck`, such as avoiding @@ -683,9 +682,9 @@ locationservice_batch_update_device_position <- function(TrackerName, Updates) { #' @param WaypointPositions Specifies an ordered list of up to 23 intermediate positions to include #' along a route between the departure position and destination position. #' -#' - For example, from the `DeparturePosition` `[-123.115, 49.285]`, the -#' route follows the order that the waypoint positions are given -#' `[[-122.757, 49.0021],[-122.349, 47.620]]` +#' - For example, from the `DeparturePosition` `[-123.115, 49.285]`, the +#' route follows the order that the waypoint positions are given +#' `[[-122.757, 49.0021],[-122.349, 47.620]]` #' #' If you specify a waypoint position that's not located on a road, Amazon #' Location [moves the position to the nearest @@ -844,20 +843,20 @@ locationservice_calculate_route <- function(CalculatorName, CarModeOptions = NUL #' #' Additional options include: #' -#' - [Specifying a departure -#' time](https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) -#' using either `DepartureTime` or `DepartNow`. This calculates routes -#' based on predictive traffic data at the given time. +#' - [Specifying a departure +#' time](https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) +#' using either `DepartureTime` or `DepartNow`. This calculates routes +#' based on predictive traffic data at the given time. #' -#' You can't specify both `DepartureTime` and `DepartNow` in a single -#' request. Specifying both parameters returns a validation error. +#' You can't specify both `DepartureTime` and `DepartNow` in a single +#' request. Specifying both parameters returns a validation error. #' -#' - [Specifying a travel -#' mode](https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) -#' using TravelMode sets the transportation mode used to calculate the -#' routes. This also lets you specify additional route preferences in -#' `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if -#' traveling by `Truck`. +#' - [Specifying a travel +#' mode](https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) +#' using TravelMode sets the transportation mode used to calculate the +#' routes. This also lets you specify additional route preferences in +#' `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if +#' traveling by `Truck`. #' #' @usage #' locationservice_calculate_route_matrix(CalculatorName, CarModeOptions, @@ -905,10 +904,9 @@ locationservice_calculate_route <- function(CalculatorName, CarModeOptions = NUL #' Setting a departure time in the past returns a `400 ValidationException` #' error. #' -#' - In [ISO -#' 8601](https://www.iso.org/iso-8601-date-and-time-format.html) -#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, -#' `2020–07-2T12:15:20.000Z+01:00` +#' - In [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) +#' format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example, +#' `2020–07-2T12:15:20.000Z+01:00` #' @param DestinationPositions [required] The list of destination positions for the route matrix. An array of #' points, each of which is itself a 2-value array defined in [WGS #' 84](https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) format: @@ -937,9 +935,9 @@ locationservice_calculate_route <- function(CalculatorName, CarModeOptions = NUL #' The `TravelMode` you specify also determines how you specify route #' preferences: #' -#' - If traveling by `Car` use the `CarModeOptions` parameter. +#' - If traveling by `Car` use the `CarModeOptions` parameter. #' -#' - If traveling by `Truck` use the `TruckModeOptions` parameter. +#' - If traveling by `Truck` use the `TruckModeOptions` parameter. #' #' Default Value: `Car` #' @param TruckModeOptions Specifies route preferences when traveling by `Truck`, such as avoiding @@ -1059,12 +1057,12 @@ locationservice_calculate_route_matrix <- function(CalculatorName, CarModeOption #' #' Requirements: #' -#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique geofence collection name. +#' - Must be a unique geofence collection name. #' -#' - No spaces allowed. For example, `ExampleGeofenceCollection`. +#' - No spaces allowed. For example, `ExampleGeofenceCollection`. #' @param Description An optional description for the geofence collection. #' @param KmsKeyId A key identifier for an [AWS KMS customer managed #' key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). @@ -1080,18 +1078,18 @@ locationservice_calculate_route_matrix <- function(CalculatorName, CarModeOption #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @return #' A list with the following syntax: @@ -1163,12 +1161,12 @@ locationservice_create_geofence_collection <- function(CollectionName, Descripti #' #' Requirements: #' -#' - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens -#' (-), periods (.), and underscores (_). +#' - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens +#' (-), periods (.), and underscores (_). #' -#' - Must be a unique map resource name. +#' - Must be a unique map resource name. #' -#' - No spaces allowed. For example, `ExampleMap`. +#' - No spaces allowed. For example, `ExampleMap`. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param Tags Applies one or more tags to the map resource. A tag is a key-value pair @@ -1179,18 +1177,18 @@ locationservice_create_geofence_collection <- function(CollectionName, Descripti #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @return #' A list with the following syntax: @@ -1269,22 +1267,22 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Valid values include: #' -#' - `Esri` – For additional information about -#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s -#' coverage in your region of interest, see [Esri details on geocoding -#' coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm). +#' - `Esri` – For additional information about +#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s +#' coverage in your region of interest, see [Esri details on geocoding +#' coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm). #' -#' - `Here` – For additional information about [HERE -#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' -#' coverage in your region of interest, see HERE details on goecoding -#' coverage. +#' - `Here` – For additional information about [HERE +#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' +#' coverage in your region of interest, see HERE details on goecoding +#' coverage. #' -#' If you specify HERE Technologies (`Here`) as the data provider, you -#' may not [store -#' results](https://docs.aws.amazon.com/location/latest/APIReference/API_DataSourceConfiguration.html) -#' for locations in Japan. For more information, see the [AWS Service -#' Terms](https://aws.amazon.com/service-terms/) for Amazon Location -#' Service. +#' If you specify HERE Technologies (`Here`) as the data provider, you +#' may not [store +#' results](https://docs.aws.amazon.com/location/latest/APIReference/API_DataSourceConfiguration.html) +#' for locations in Japan. For more information, see the [AWS Service +#' Terms](https://aws.amazon.com/service-terms/) for Amazon Location +#' Service. #' #' For additional information , see [Data #' providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) @@ -1295,12 +1293,12 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Requirements: #' -#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique place index resource name. +#' - Must be a unique place index resource name. #' -#' - No spaces allowed. For example, `ExamplePlaceIndex`. +#' - No spaces allowed. For example, `ExamplePlaceIndex`. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param Tags Applies one or more tags to the place index resource. A tag is a @@ -1311,19 +1309,19 @@ locationservice_create_map <- function(Configuration, Description = NULL, MapNam #' #' Restrictions: #' -#' - Maximum 50 tags per resource. +#' - Maximum 50 tags per resource. #' -#' - Each tag key must be unique and must have exactly one associated -#' value. +#' - Each tag key must be unique and must have exactly one associated +#' value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8. +#' - Maximum key length: 128 Unicode characters in UTF-8. #' -#' - Maximum value length: 256 Unicode characters in UTF-8. +#' - Maximum value length: 256 Unicode characters in UTF-8. #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@ +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@ #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @return #' A list with the following syntax: @@ -1397,12 +1395,12 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' #' Requirements: #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), -#' periods (.), and underscores (_). +#' - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods +#' (.), and underscores (_). #' -#' - Must be a unique Route calculator resource name. +#' - Must be a unique Route calculator resource name. #' -#' - No spaces allowed. For example, `ExampleRouteCalculator`. +#' - No spaces allowed. For example, `ExampleRouteCalculator`. #' @param DataSource [required] Specifies the data provider of traffic and road network data. #' #' This field is case-sensitive. Enter the valid values as shown. For @@ -1412,16 +1410,17 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' #' Valid values include: #' -#' - `Esri` – For additional information about -#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s -#' coverage in your region of interest, see [Esri details on street -#' networks and traffic -#' coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm). +#' - `Esri` – For additional information about +#' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s +#' coverage in your region of interest, see [Esri details on street +#' networks and traffic +#' coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm). #' -#' - `Here` – For additional information about [HERE -#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' -#' coverage in your region of interest, see HERE car routing coverage -#' and HERE truck routing coverage. +#' - `Here` – For additional information about [HERE +#' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' +#' coverage in your region of interest, see HERE car routing coverage and +#' [HERE truck routing +#' coverage](https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html). #' #' For additional information , see [Data #' providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) @@ -1433,24 +1432,24 @@ locationservice_create_place_index <- function(DataSource, DataSourceConfigurati #' key-value pair helps manage, identify, search, and filter your resources #' by labelling them. #' -#' - For example: \{ `"tag1" : "value1"`, `"tag2" : "value2"`\} +#' - For example: \\ `"tag1" : "value1"`, `"tag2" : "value2"`\\ #' #' Format: `"key" : "value"` #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @return #' A list with the following syntax: @@ -1518,28 +1517,28 @@ locationservice_create_route_calculator <- function(CalculatorName, DataSource, #' #' Valid values: #' -#' - `TimeBased` - Location updates are evaluated against linked geofence -#' collections, but not every location update is stored. If your update -#' frequency is more often than 30 seconds, only one update per 30 -#' seconds is stored for each unique device ID. -#' -#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), -#' location updates are ignored. Location updates within this area are -#' neither evaluated against linked geofence collections, nor stored. -#' This helps control costs by reducing the number of geofence -#' evaluations and historical device positions to paginate through. -#' Distance-based filtering can also reduce the effects of GPS noise -#' when displaying device trajectories on a map. -#' -#' - `AccuracyBased` - If the device has moved less than the measured -#' accuracy, location updates are ignored. For example, if two -#' consecutive updates from a device have a horizontal accuracy of 5 m -#' and 10 m, the second update is ignored if the device has moved less -#' than 15 m. Ignored location updates are neither evaluated against -#' linked geofence collections, nor stored. This can reduce the effects -#' of GPS noise when displaying device trajectories on a map, and can -#' help control your costs by reducing the number of geofence -#' evaluations. +#' - `TimeBased` - Location updates are evaluated against linked geofence +#' collections, but not every location update is stored. If your update +#' frequency is more often than 30 seconds, only one update per 30 +#' seconds is stored for each unique device ID. +#' +#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), +#' location updates are ignored. Location updates within this area are +#' neither evaluated against linked geofence collections, nor stored. +#' This helps control costs by reducing the number of geofence +#' evaluations and historical device positions to paginate through. +#' Distance-based filtering can also reduce the effects of GPS noise when +#' displaying device trajectories on a map. +#' +#' - `AccuracyBased` - If the device has moved less than the measured +#' accuracy, location updates are ignored. For example, if two +#' consecutive updates from a device have a horizontal accuracy of 5 m +#' and 10 m, the second update is ignored if the device has moved less +#' than 15 m. Ignored location updates are neither evaluated against +#' linked geofence collections, nor stored. This can reduce the effects +#' of GPS noise when displaying device trajectories on a map, and can +#' help control your costs by reducing the number of geofence +#' evaluations. #' #' This field is optional. If not specified, the default value is #' `TimeBased`. @@ -1554,28 +1553,28 @@ locationservice_create_route_calculator <- function(CalculatorName, DataSource, #' #' Restrictions: #' -#' - Maximum 50 tags per resource +#' - Maximum 50 tags per resource #' -#' - Each resource tag must be unique with a maximum of one value. +#' - Each resource tag must be unique with a maximum of one value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8 +#' - Maximum key length: 128 Unicode characters in UTF-8 #' -#' - Maximum value length: 256 Unicode characters in UTF-8 +#' - Maximum value length: 256 Unicode characters in UTF-8 #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@. +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@. #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' @param TrackerName [required] The name for the tracker resource. #' #' Requirements: #' -#' - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), -#' periods (.), and underscores (_). +#' - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), +#' periods (.), and underscores (_). #' -#' - Must be a unique tracker resource name. +#' - Must be a unique tracker resource name. #' -#' - No spaces allowed. For example, `ExampleTracker`. +#' - No spaces allowed. For example, `ExampleTracker`. #' #' @return #' A list with the following syntax: @@ -2178,8 +2177,8 @@ locationservice_describe_tracker <- function(TrackerName) { #' disassociated from the tracker resource. Used when you need to specify a #' resource across all AWS. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` +#' - Format example: +#' `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer` #' @param TrackerName [required] The name of the tracker resource to be dissociated from the consumer. #' #' @return @@ -2302,8 +2301,8 @@ locationservice_get_device_position <- function(DeviceId, TrackerName) { #' #' Requirement: #' -#' - The time specified for `EndTimeExclusive` must be after the time for -#' `StartTimeInclusive`. +#' - The time specified for `EndTimeExclusive` must be after the time for +#' `StartTimeInclusive`. #' @param MaxResults An optional limit for the number of device positions returned in a #' single call. #' @@ -2319,8 +2318,8 @@ locationservice_get_device_position <- function(DeviceId, TrackerName) { #' #' Requirement: #' -#' - The time specified for `StartTimeInclusive` must be before -#' `EndTimeExclusive`. +#' - The time specified for `StartTimeInclusive` must be before +#' `EndTimeExclusive`. #' @param TrackerName [required] The tracker resource receiving the request for the device position #' history. #' @@ -2476,30 +2475,29 @@ locationservice_get_geofence <- function(CollectionName, GeofenceId) { #' [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html) #' styles: #' -#' - VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` | `Ubuntu Medium` -#' | `Ubuntu Italic` | `Ubuntu Regular` | `Ubuntu Bold` +#' - VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` | `Ubuntu Medium` | +#' `Ubuntu Italic` | `Ubuntu Regular` | `Ubuntu Bold` #' -#' - VectorEsriLightGrayCanvas – `Ubuntu Italic` | `Ubuntu Regular` | -#' `Ubuntu Light` | `Ubuntu Bold` +#' - VectorEsriLightGrayCanvas – `Ubuntu Italic` | `Ubuntu Regular` | +#' `Ubuntu Light` | `Ubuntu Bold` #' -#' - VectorEsriTopographic – `Noto Sans Italic` | `Noto Sans Regular` | -#' `Noto Sans Bold` | `Noto Serif Regular` | -#' `Roboto Condensed Light Italic` +#' - VectorEsriTopographic – `Noto Sans Italic` | `Noto Sans Regular` | +#' `Noto Sans Bold` | `Noto Serif Regular` | +#' `Roboto Condensed Light Italic` #' -#' - VectorEsriStreets – `Arial Regular` | `Arial Italic` | `Arial Bold` +#' - VectorEsriStreets – `Arial Regular` | `Arial Italic` | `Arial Bold` #' -#' - VectorEsriNavigation – `Arial Regular` | `Arial Italic` | -#' `Arial Bold` +#' - VectorEsriNavigation – `Arial Regular` | `Arial Italic` | `Arial Bold` #' #' Valid font stacks for [HERE #' Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) #' styles: #' -#' - VectorHereContrast – `Fira GO Regular` | `Fira GO Bold` +#' - VectorHereContrast – `Fira GO Regular` | `Fira GO Bold` #' -#' - VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` | -#' `Fira GO Map` | `Fira GO Map Bold` | `Noto Sans CJK JP Bold` | -#' `Noto Sans CJK JP Light` | `Noto Sans CJK JP Regular` +#' - VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` | +#' `Fira GO Map` | `Fira GO Map Bold` | `Noto Sans CJK JP Bold` | +#' `Noto Sans CJK JP Light` | `Noto Sans CJK JP Regular` #' @param FontUnicodeRange [required] A Unicode range of characters to download glyphs for. Each response will #' contain 256 characters. For example, 0–255 includes all characters from #' range `U+0000` to `00FF`. Must be aligned to multiples of 256. @@ -2558,16 +2556,16 @@ locationservice_get_map_glyphs <- function(FontStack, FontUnicodeRange, MapName) #' @param FileName [required] The name of the sprite file. Use the following file names for the sprite #' sheet: #' -#' - `sprites.png` +#' - `sprites.png` #' -#' - `sprites@@2x.png` for high pixel density displays +#' - `sprites@@2x.png` for high pixel density displays #' #' For the JSON document contain image offsets. Use the following file #' names: #' -#' - `sprites.json` +#' - `sprites.json` #' -#' - `sprites@@2x.json` for high pixel density displays +#' - `sprites@@2x.json` for high pixel density displays #' @param MapName [required] The map resource associated with the sprite file. #' #' @return @@ -3166,8 +3164,8 @@ locationservice_list_route_calculators <- function(MaxResults = NULL, NextToken #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource whose tags you want to #' retrieve. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' #' @return #' A list with the following syntax: @@ -3445,7 +3443,7 @@ locationservice_put_geofence <- function(CollectionName, GeofenceId, Geometry) { #' `city` in the results will most likely be returned as `Athens`. #' #' If you set the `language` parameter to `el`, for Greek, then the `city` -#' in the results will more likely be returned as ``. +#' in the results will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -3589,9 +3587,9 @@ locationservice_search_place_index_for_position <- function(IndexName, Language #' @param FilterCountries An optional parameter that limits the search results by returning only #' suggestions within the provided list of countries. #' -#' - Use the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) -#' 3-digit country code. For example, Australia uses three upper-case -#' characters: `AUS`. +#' - Use the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) +#' 3-digit country code. For example, Australia uses three upper-case +#' characters: `AUS`. #' @param IndexName [required] The name of the place index resource you want to use for the search. #' @param Language The preferred language used to return results. The value must be a valid #' [BCP @@ -3608,7 +3606,7 @@ locationservice_search_place_index_for_position <- function(IndexName, Language #' `Athens, Greece`. #' #' If you set the `language` parameter to `el`, for Greek, then the result -#' found will more likely be returned as `, Ελλάδ`. +#' found will more likely be returned as \eqn{A\Theta\eta\nu\sigma, E\lambda\lambda\alpha\delta}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -3739,10 +3737,9 @@ locationservice_search_place_index_for_suggestions <- function(BiasPosition = NU #' @param FilterCountries An optional parameter that limits the search results by returning only #' places that are in a specified list of countries. #' -#' - Valid values include [ISO -#' 3166](https://www.iso.org/iso-3166-country-codes.html) 3-digit -#' country codes. For example, Australia uses three upper-case -#' characters: `AUS`. +#' - Valid values include [ISO +#' 3166](https://www.iso.org/iso-3166-country-codes.html) 3-digit country +#' codes. For example, Australia uses three upper-case characters: `AUS`. #' @param IndexName [required] The name of the place index resource you want to use for the search. #' @param Language The preferred language used to return results. The value must be a valid #' [BCP @@ -3759,7 +3756,7 @@ locationservice_search_place_index_for_suggestions <- function(BiasPosition = NU #' found will most likely be returned as `Athens`. #' #' If you set the `language` parameter to `el`, for Greek, then the result -#' found will more likely be returned as ``. +#' found will more likely be returned as \eqn{A\Theta\eta\nu\alpha}. #' #' If the data provider does not have a value for Greek, the result will be #' in a language that the provider does support. @@ -3878,8 +3875,8 @@ locationservice_search_place_index_for_text <- function(BiasPosition = NULL, Fil #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource whose tags you want to #' update. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' @param Tags [required] Applies one or more tags to specific resource. A tag is a key-value pair #' that helps you manage, identify, search, and filter your resources. #' @@ -3887,19 +3884,19 @@ locationservice_search_place_index_for_text <- function(BiasPosition = NULL, Fil #' #' Restrictions: #' -#' - Maximum 50 tags per resource. +#' - Maximum 50 tags per resource. #' -#' - Each tag key must be unique and must have exactly one associated -#' value. +#' - Each tag key must be unique and must have exactly one associated +#' value. #' -#' - Maximum key length: 128 Unicode characters in UTF-8. +#' - Maximum key length: 128 Unicode characters in UTF-8. #' -#' - Maximum value length: 256 Unicode characters in UTF-8. +#' - Maximum value length: 256 Unicode characters in UTF-8. #' -#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following -#' characters: + - = . _ : / @@ +#' - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following +#' characters: + - = . _ : / @@ #' -#' - Cannot use "aws:" as a prefix for a key. +#' - Cannot use "aws:" as a prefix for a key. #' #' @return #' An empty list. @@ -3947,8 +3944,8 @@ locationservice_tag_resource <- function(ResourceArn, Tags) { #' @param ResourceArn [required] The Amazon Resource Name (ARN) of the resource from which you want to #' remove tags. #' -#' - Format example: -#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` +#' - Format example: +#' `arn:aws:geo:region:account-id:resourcetype/ExampleResource` #' @param TagKeys [required] The list of tag keys to remove from the specified resource. #' #' @return @@ -4233,28 +4230,27 @@ locationservice_update_route_calculator <- function(CalculatorName, Description #' #' Valid values: #' -#' - `TimeBased` - Location updates are evaluated against linked geofence -#' collections, but not every location update is stored. If your update -#' frequency is more often than 30 seconds, only one update per 30 -#' seconds is stored for each unique device ID. -#' -#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), -#' location updates are ignored. Location updates within this distance -#' are neither evaluated against linked geofence collections, nor -#' stored. This helps control costs by reducing the number of geofence -#' evaluations and historical device positions to paginate through. -#' Distance-based filtering can also reduce the effects of GPS noise -#' when displaying device trajectories on a map. -#' -#' - `AccuracyBased` - If the device has moved less than the measured -#' accuracy, location updates are ignored. For example, if two -#' consecutive updates from a device have a horizontal accuracy of 5 m -#' and 10 m, the second update is ignored if the device has moved less -#' than 15 m. Ignored location updates are neither evaluated against -#' linked geofence collections, nor stored. This helps educe the -#' effects of GPS noise when displaying device trajectories on a map, -#' and can help control costs by reducing the number of geofence -#' evaluations. +#' - `TimeBased` - Location updates are evaluated against linked geofence +#' collections, but not every location update is stored. If your update +#' frequency is more often than 30 seconds, only one update per 30 +#' seconds is stored for each unique device ID. +#' +#' - `DistanceBased` - If the device has moved less than 30 m (98.4 ft), +#' location updates are ignored. Location updates within this distance +#' are neither evaluated against linked geofence collections, nor stored. +#' This helps control costs by reducing the number of geofence +#' evaluations and historical device positions to paginate through. +#' Distance-based filtering can also reduce the effects of GPS noise when +#' displaying device trajectories on a map. +#' +#' - `AccuracyBased` - If the device has moved less than the measured +#' accuracy, location updates are ignored. For example, if two +#' consecutive updates from a device have a horizontal accuracy of 5 m +#' and 10 m, the second update is ignored if the device has moved less +#' than 15 m. Ignored location updates are neither evaluated against +#' linked geofence collections, nor stored. This helps educe the effects +#' of GPS noise when displaying device trajectories on a map, and can +#' help control costs by reducing the number of geofence evaluations. #' @param PricingPlan No longer used. If included, the only allowed value is #' `RequestBasedUsage`. #' @param PricingPlanDataSource This parameter is no longer used. diff --git a/paws/R/opsworks_operations.R b/paws/R/opsworks_operations.R index 9b0afeacda..c423445c27 100644 --- a/paws/R/opsworks_operations.R +++ b/paws/R/opsworks_operations.R @@ -5520,7 +5520,7 @@ opsworks_update_instance <- function(InstanceId, LayerIds = NULL, InstanceType = #' name, which is used internally by AWS OpsWorks Stacks and by Chef. The #' short name is also used as the name for the directory where your app #' files are installed. It can have a maximum of 200 characters and must be -#' in the following format: /\\A\[a-z0-9\\-\\_\\.\]+\\Z/. +#' in the following format: /\\A\[a-z0-9\\-\_\\.\]+\\Z/. #' #' The built-in layers' short names are defined by AWS OpsWorks Stacks. For #' more information, see the [Layer diff --git a/paws/R/ssm_operations.R b/paws/R/ssm_operations.R index dbcb4fd7b6..9360d2197f 100644 --- a/paws/R/ssm_operations.R +++ b/paws/R/ssm_operations.R @@ -11034,9 +11034,9 @@ ssm_send_automation_signal <- function(AutomationExecutionId, SignalType, Payloa #' must escape the first two options by using a backslash. If you specify a #' version number, then you don't need to use the backslash. For example: #' -#' --document-version "\\$DEFAULT" +#' --document-version "$DEFAULT" #' -#' --document-version "\\$LATEST" +#' --document-version "$LATEST" #' #' --document-version "3" #' @param DocumentHash The Sha256 or Sha1 hash created by the system when the document was